API 2.0 documentation#4371
Conversation
|
Once 2.0 #4378 is merged this will be ready to review |
|
Ready for review but still needs 2.0 to be cut first |
ocket8888
added
documentation
|
Nothing blocking this merge since 2.0 is now cut. So once reviewed 👍 |
ocket8888
left a comment
ocket8888
left a comment
There was a problem hiding this comment.
Right off the bat I wanna bring up these references to the 1.x API I found scattered around (in GNU file:line:col style, using docs/source as the root):
• admin/traffic_router.rst:145:109
• admin/traffic_vault.rst:232:71
• admin/quick_howto/ciab.rst:183:540 - this one also has a weird inaccuracy, comparing two different endpoints, which I'd appreciate it if you could fix, but no worries if you don't want to
• admin/quick_howto/ciab.rst:200:322
There's also a note about .json suffixes at api/index.rst:104:0 that should be updated to make it clear that while that was merely discouraged in the 1.x API, it is no longer at all supported in 2.0.
|
Done @ocket8888 thanks for making my life easy with the line number references |
ocket8888
left a comment
ocket8888
left a comment
There was a problem hiding this comment.
You didn't change the reference label on /deliveryservices/xmlid/{{XML ID}}/urlkeys to use v1 in the label like all the others.
/user/{{ID}}//deliveryservices/available should have a reference label
/cdns/{{CDN}}/configfiles/ats/{{filename}} doesn't exist in API 2.0, and so shouldn't be documented.
/profiles/{{Profile}}/configfiles/ats/{{filename}} doesn't exist in API 2.0, and so shouldn't be documented.
|
In addition to the merge conflicts shown here there are some new API 1.5 endpoints with docs that need copy/pasting into v1/v2 sub-dirs |
ocket8888
left a comment
ocket8888
left a comment
There was a problem hiding this comment.
Everything looks good (aside from grammatical errors that aren't your fault and I'll fix them all later) and it builds without warnings or errors.
|
just gotta fix some merge conflicts, apparently. |
|
merged in |
ocket8888
left a comment
ocket8888
left a comment
There was a problem hiding this comment.
It looks like there's a bad ref in tosession.py, the create_region method is referencing to-api-divisions-name-regions (which doesn't exist - and shouldn't) even though the route it's actually using is just /regions.
|
huh looks to be from master - ill fix! |
|
done |
ocket8888
left a comment
ocket8888
left a comment
There was a problem hiding this comment.
Looks good, no errors/warnings in the docs build, everything seems accurate
looks like I left two API 1.x methods in the Python client, though. Need to get those out.
2 participants
What does this PR (Pull Request) do?
Updates API documentation for version 2.0. Deletes deprecated routes. Also deletes versionadded/versionchanged as version 2.0 will be top of tree.
Which Traffic Control components are affected by this PR?
What is the best way to verify this PR?
Build docs, as this is a pure documentation change there are no tests.
If this is a bug fix, what versions of Traffic Control are affected?
The following criteria are ALL met by this PR
Additional Information
THIS SHOULD NOT BE MERGED OR MARKED READY UNTIL 2.0 is cut