[server] Remove obsolete /count GET, apiDoc improvements #883
Conversation
This file contains 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
ix5
added
server
ix5
force-pushed
the
api-endpoints-apidoc-docs
branch
from
053c213
to
124967e
Compare
ix5
changed the title
This was referenced May 25, 2022
apiDoc fails to parse a non-semantic version
All endpoints should now be properly documented using `apidoc`. As such, remove duplication and point directly to the needed sections.
Every endpoint should now have a full API documentation. While at it, clean up some minor functionality - `.get_json()` -> `.json` property - Add better error message for when `latest-enabled` is well... not enabled
The REMOVEME has been in the code for quite a while and a better substitute exists.
ix5
force-pushed
the
api-endpoints-apidoc-docs
branch
from
124967e
to
fd1434f
Compare
ix5
changed the title
The GET endpoint was only intended for fetching counts for a single thread and has been deprecated.
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.
Checklist
CHANGES.rstbecause this is a user-facing change or an important bugfixWhat changes does this Pull Request introduce?
The REMOVEME has been in the code for quite a while and a better substitute exists.
All endpoints should now be properly documented using
apidoc. As such, remove duplication and point directly to the needed sections.Every endpoint should now have a full API documentation.
While at it, clean up some minor functionality
.get_json()->.jsonpropertylatest-enablediswell... not enabled
Why is this necessary?
Cleanup and preparing for some other API changes.
(Previous versions of this PR)
In a previous version of this PR, I added these changes, which I now think merit further thought. Hence removed:
[BREAKING] views/comments: /new: Accept only POSTMixing query params and POST body is hard to understand, error prone and harder to verify programmatically.
Since this breaks comment creation if clients continue to only provide
urivia query params, mark as BREAKING[BREAKING] js: api: /new: Only send POST bodyIn accordance with the previous commit, send all data as POST instead of mixing and matching with query params.