Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document API Stability changes #7656

Open
rimashah25 opened this issue Jul 18, 2023 · 0 comments
Open

Document API Stability changes #7656

rimashah25 opened this issue Jul 18, 2023 · 0 comments
Labels
documentation related to documentation high impact impacts the basic function, deployment, or operation of a CDN improvement The functionality exists but it could be improved in some way. low difficulty the estimated level of effort to resolve this issue is low

Comments

@rimashah25
Copy link
Contributor

With the 8.0.0 milestone, API 3.x will be removed, API 4.x will be deprecated and API 5.x will now be stable. This should be documented as well as the necessary messages for any api endpoints that are not used by API 5.x.

This Improvement request (usability, performance, tech debt, etc.) affects these Traffic Control components:

  • Documentation

Current behavior:

Documentation does not include these messages.

New behavior:

Before the new release occurs these changes should be documented.

@rimashah25 rimashah25 added documentation related to documentation improvement The functionality exists but it could be improved in some way. low difficulty the estimated level of effort to resolve this issue is low labels Jul 18, 2023
@rimashah25 rimashah25 modified the milestones: 8.0.0, TO API v3 removal Jul 18, 2023
@ocket8888 ocket8888 added the high impact impacts the basic function, deployment, or operation of a CDN label Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation related to documentation high impact impacts the basic function, deployment, or operation of a CDN improvement The functionality exists but it could be improved in some way. low difficulty the estimated level of effort to resolve this issue is low
Projects
None yet
Development

No branches or pull requests

2 participants