This repository has been archived by the owner on Mar 23, 2023. It is now read-only.
Consolidate REST API planning documents and add plan for expected functionality #348
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
This change updates the community planning features list to consolidate REST API designs into one feature document. This document will speak on the designs from the past and the future designs for the Grid REST API. This also alphabetizes the remaining features. Signed-off-by: Shannyn Telander <telander@bitwise.io>
This change moves feature documents for the REST API into a directory, titled `rest_api`. These documents were unlinked from the community features page, as the index page of this directory will link to the historic design documents. Signed-off-by: Shannyn Telander <telander@bitwise.io>
This change adds a description of how the REST API will handle batches, for both gridd and griddle. This includes information on the payloads that will be accepted by the new REST API and how specific endpoints will respond. Signed-off-by: Shannyn Telander <telander@bitwise.io>
shannynalayna
requested review from
agunde406,
davececchi,
dcmiddle,
dnewh,
dplumb94,
jsmitchell,
peterschwarz,
rberg2,
rbuysse,
RyanLassigBanks and
vaporos
as code owners
shannynalayna
force-pushed
the
shannynalayna-update-rest-api-planning
branch
2 times, most recently
from
2c8bd36
to
5c0e486
Compare
This change adds short descriptions to previously proposed functionality and links to the respective design documents. Signed-off-by: Shannyn Telander <telander@bitwise.io>
shannynalayna
force-pushed
the
shannynalayna-update-rest-api-planning
branch
from
5c0e486
to
6452d92
Compare
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.
This change moves the REST API design documents from community/planning/features into a rest-specific directory. Historical documents are linked from the top-level doc with descriptions on the proposed functionality.