This repository was archived by the owner on May 15, 2024. It is now read-only.
Define the initial OpenAPI specification #4
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
Define the OpenAPI specification with endpoints to store data, retrieve data and check the status of a data by ID. The API specification uses the prefix `/v0` while it is being developed. All bets are off in this version in terms of breaking changes. The API introduces `/data` namespace to encapsulate data management and allow room for other domain-specific entities should they be identified later. Relative to the existing API drafts in Notion documents etc., the specification here opts for minimalism over extra features. This is to allow iteration over core functionality that is: store, retrieve, check.
masih
force-pushed
the
masih/inital_api_spec
branch
from
d5fad7d to
13970fb
Compare
|
What are your thoughts on renaming |
|
blob seems like a good name from where we ended up in our last session |
Further to modeling discussions, it seems the term `blob` is a better representation of arbitrary binary data exchanged by the Motion API. Rename the API specification to reflect this.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Define the OpenAPI specification with endpoints to store data, retrieve data and check the status of a data by ID.
The API specification uses the prefix
/v0while it is being developed. All bets are off in this version in terms of breaking changes.The API introduces
/datanamespace to encapsulate data management and allow room for other domain-specific entities should they be identified later.Relative to the existing API drafts in Notion documents etc., the specification here opts for minimalism over extra features. This is to allow iteration over core functionality that is: store, retrieve, check.