API Implementation Documentation #318
Merged
Conversation
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
apricot13
force-pushed
the
hn/api-implementation-documentation
branch
2 times, most recently
from
d622454 to
3515d51
Compare
apricot13
force-pushed
the
hn/api-implementation-documentation
branch
from
3515d51 to
aabc21a
Compare
jessicamcinchak
approved these changes
Mar 20, 2025
madz-lw
approved these changes
Mar 25, 2025
apricot13
force-pushed
the
hn/api-implementation-documentation
branch
from
b82a6b2 to
1ff295b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Read it here!
This PR is to accompany the issue I raised here a while back (#296) I've stuck to just using markdown for now, following a "swagger-like" structure but I'm happy to switch to a different library or validator tool if there are any suggestions.
I've based the documentation on:
I've only covered the basics for now, we're starting work on comments first, then documents, then applications and then location based application searching.
I've put in a TODO at the bottom of the implementation page to spark as much discussion as possible before we implement those in the DPR and add to the documentation.