Skip to content
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
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

API v2 #243

wants to merge 16 commits into from

Conversation

augustuswm
Copy link
Contributor

@augustuswm augustuswm commented Dec 21, 2024

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 only
  • POST /rfd - Reserve a new RFD number
  • GET /rfd/{number} - Get the metadata for the latest revision of a RFD
  • GET /rfd/{number}/attr/{attr} - Get the value of an attribute for the latest revision of a RFD
  • POST /rfd/{number}/attr/{attr} - Set the value of an attribute of a RFD
  • GET /rfd/{number}/discussion - Get a list of comments for the latest revision of a RFD
  • POST /rfd/{number}/content - Update the body content of a RFD
  • GET /rfd/{number}/pdf - Get the latest revision of a RFD along with its pdf representations
  • GET /rfd/{number}/raw - Get the latest revision of a RFD along with its raw document contents
  • POST /rfd/{number}/raw - Update the full document of a RFD
  • GET /rfd/{number}/revision/{revision} - Get the metadata for a specific revision of a RFD
  • GET /rfd/{number}/revision/{revision}/attr/{attr} - Get the value of an attribute for a specific revision of a RFD
  • GET /rfd/{number}/revision/{revision}/discussion - Get a list of comments for a specific revision of a RFD
  • GET /rfd/{number}/revision/{revision}/pdf - Get a specific revision of a RFD along with its pdf representations
  • GET /rfd/{number}/revision/{revision}/raw - Get a specific revision of a RFD along with its raw document contents
  • POST /rfd/{number}/state/discuss - Transition a RFD to the discussion state
  • POST /rfd/{number}/state/publish - Transition a RFD to the published state
  • POST /rfd/{number}/visibility - Update the visibility (public / private) of a RFD
  • GET /rfd-search - Perform a search of RFDs

@augustuswm augustuswm changed the title Api v2 API v2 Dec 21, 2024
@augustuswm augustuswm marked this pull request as draft December 22, 2024 16:36
@augustuswm augustuswm marked this pull request as ready for review December 30, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant