This repository was archived by the owner on Nov 24, 2025. It is now read-only.
API Guidelines blueprint#4536
Merged
mattjackson220 merged 7 commits intoapache:masterfrom Apr 8, 2020
Merged
Conversation
ocket8888
added
documentation
This was referenced Mar 30, 2020
mitchell852
approved these changes
Mar 31, 2020
Member
mitchell852
left a comment
mitchell852
left a comment
There was a problem hiding this comment.
This looks really good. You covered everything very well. One thing I think you could elaborate on is that all api endpoints that modify data need to insert a legible/sensible "change log" entry to the log table with the user that made the change and when the change occurred.
Otherwise, looks really good. Thanks for putting this together.
Also, once merged. The contributing.MD file should be updated to link to this and the wiki page of the old TO guidelines should probably be deleted/archived.
rob05c
reviewed
Apr 6, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR (Pull Request) do?
Adds a blueprint for some API guidelines.
Which Traffic Control components are affected by this PR?
What is the best way to verify this PR?
Read the blueprint. Maybe pass it through a Markdown parser/validator/renderer if you want.
The following criteria are ALL met by this PR