[AGORA-1849] Formal OAS for Agora API (delegates, auth, pagination) #212
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@kent @andreitr @stepandel, how do you feel about having discussion and feedback on the proposed schema on this PR? |
should we just follow this spec @Flip-Liquid ? https://www.notion.so/argoagora/Agora-s-OP-API-Draft-Document-32b2bed3193841d4b272b5ab39167cbb |
stepandel
reviewed
Apr 11, 2024
stepandel
reviewed
Apr 12, 2024
kent
pushed a commit
that referenced
this pull request
Aug 30, 2024
…212) * 💻📐 openapi swagger wip specification for /delegates * 🤏 📃 🆚 bump version 3.1.0; add license; qualify beta * 🏷️ rename to oas_v1.yaml * 🔂 add CI/GHA file; integrate basic swagger linting * 💻📐 add page metadata to OAS * 📐 💻 add reusable datatypes for proposal, vote, delegation; routes for props * 💫💻📐 add opt, approval, std, snapshot prop data; propType->votingStrategy; remove extended proposal * 💻 /spec route for OAS * 💻📐 add routes + contract schema
jefag
pushed a commit
that referenced
this pull request
Oct 4, 2024
…212) * 💻📐 openapi swagger wip specification for /delegates * 🤏 📃 🆚 bump version 3.1.0; add license; qualify beta * 🏷️ rename to oas_v1.yaml * 🔂 add CI/GHA file; integrate basic swagger linting * 💻📐 add page metadata to OAS * 📐 💻 add reusable datatypes for proposal, vote, delegation; routes for props * 💫💻📐 add opt, approval, std, snapshot prop data; propType->votingStrategy; remove extended proposal * 💻 /spec route for OAS * 💻📐 add routes + contract schema
jefag
pushed a commit
that referenced
this pull request
Oct 4, 2024
…212) * 💻📐 openapi swagger wip specification for /delegates * 🤏 📃 🆚 bump version 3.1.0; add license; qualify beta * 🏷️ rename to oas_v1.yaml * 🔂 add CI/GHA file; integrate basic swagger linting * 💻📐 add page metadata to OAS * 📐 💻 add reusable datatypes for proposal, vote, delegation; routes for props * 💫💻📐 add opt, approval, std, snapshot prop data; propType->votingStrategy; remove extended proposal * 💻 /spec route for OAS * 💻📐 add routes + contract schema
jefag
pushed a commit
that referenced
this pull request
Oct 8, 2024
…212) * 💻📐 openapi swagger wip specification for /delegates * 🤏 📃 🆚 bump version 3.1.0; add license; qualify beta * 🏷️ rename to oas_v1.yaml * 🔂 add CI/GHA file; integrate basic swagger linting * 💻📐 add page metadata to OAS * 📐 💻 add reusable datatypes for proposal, vote, delegation; routes for props * 💫💻📐 add opt, approval, std, snapshot prop data; propType->votingStrategy; remove extended proposal * 💻 /spec route for OAS * 💻📐 add routes + contract schema
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.
PR-Codex overview
This PR focuses on adding a Swagger Editor Validator Remote workflow to validate an OpenAPI definition file.
Detailed summary
spec/oas_v1.yamlDelegation,BaseDelegate,Proposal, etc.You can use the following in-browser OAS editor and validator to get a prettier view of the API if you'd like:
https://editor-next.swagger.io/
Just copy-paste oas_v1.yaml into it.