-
Notifications
You must be signed in to change notification settings - Fork 11
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
API v2 #243
Open
augustuswm
wants to merge
16
commits into
main
Choose a base branch
from
api-v2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
API v2 #243
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
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.
The initial set of endpoints for the RFD API were built to provide backwards compatibility with the CIO-based RFD API. This PR contains breaking changes to evolve the API surface forward.
API (v-api endpoints omitted):
GET /rfd
- List the latest revisions of RFDs. Returns RFD metadata onlyPOST /rfd
- Reserve a new RFD numberGET /rfd/{number}
- Get the metadata for the latest revision of a RFDGET /rfd/{number}/attr/{attr}
- Get the value of an attribute for the latest revision of a RFDPOST /rfd/{number}/attr/{attr}
- Set the value of an attribute of a RFDGET /rfd/{number}/discussion
- Get a list of comments for the latest revision of a RFDPOST /rfd/{number}/content
- Update the body content of a RFDGET /rfd/{number}/pdf
- Get the latest revision of a RFD along with its pdf representationsGET /rfd/{number}/raw
- Get the latest revision of a RFD along with its raw document contentsPOST /rfd/{number}/raw
- Update the full document of a RFDGET /rfd/{number}/revision/{revision}
- Get the metadata for a specific revision of a RFDGET /rfd/{number}/revision/{revision}/attr/{attr}
- Get the value of an attribute for a specific revision of a RFDGET /rfd/{number}/revision/{revision}/discussion
- Get a list of comments for a specific revision of a RFDGET /rfd/{number}/revision/{revision}/pdf
- Get a specific revision of a RFD along with its pdf representationsGET /rfd/{number}/revision/{revision}/raw
- Get a specific revision of a RFD along with its raw document contentsPOST /rfd/{number}/state/discuss
- Transition a RFD to the discussion statePOST /rfd/{number}/state/publish
- Transition a RFD to the published statePOST /rfd/{number}/visibility
- Update the visibility (public / private) of a RFDGET /rfd-search
- Perform a search of RFDs