Skip to content
This repository was archived by the owner on Mar 23, 2023. It is now read-only.

Commit 5c0e486

Browse files
author
Shannyn Telander
committed
Add links and information for historical designs
This change adds short descriptions to previously proposed functionality and links to the respective design documents. Signed-off-by: Shannyn Telander <[email protected]>
1 parent 9755b43 commit 5c0e486

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

community/planning/rest_api/index.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,23 +138,46 @@ endpoint may return a `402 Bad Gateway` if it is unable to connect to gridd.
138138
All previous design documents for the REST API are linked in the following
139139
section.
140140

141-
## Changes
142-
143-
- Added `POST` and `PUT` routes for various Grid resources. These endpoints
141+
## Proposed functionality
142+
143+
- Accept JSON Batches. The Grid REST API will be updated to support
144+
batches encoded in bytes or JSON, providing a more natural
145+
experience for users. An initial design document for the future
146+
REST API, [High-level and Low-level Transaction REST API]({% link /community/
147+
planning/rest_api/high_low_level_transaction_rest_api.md %}),
148+
explains that Grid will support both byte-encoded and JSON-encoded
149+
batches. JSON-encoded batches will be signed and encoded by the
150+
Grid daemon, as needed before submission.
151+
152+
- Proxy. Griddle is a client component that runs separately from the Grid daemon,
153+
communicating with Grid via REST API. Griddle is able to proxy requests to Grid
154+
and will create and sign batches submitted as JSON. The initial design
155+
document, [Griddle Proxy]({% link community/planning/rest_api/
156+
griddle_proxy.md %}), explains this functionality more thoroughly.
157+
158+
- Backwards compatibility. Especially as the API changes greatly, setting
159+
forth a plan for handling backwards compatibility will smooth the process
160+
for both developers and users. See [Rest API Backwards
161+
Compatibility]({% link community/planning/rest_api/backwards_compatibility.md %})
162+
for more details.
163+
164+
## Proposed API
165+
166+
* [Future REST API Reference](/community/planning/rest_api/api/)
167+
168+
- Added `POST` and `PUT` routes for various Grid resources. These endpoints
144169
will be used to submit batches to create and update resources. This takes the
145170
place of submitting everything through a `POST` to `/batches` and will
146171
provide users with a more familiar REST API experience.
147-
- Updated resource schemas. The resource schemas for various Grid features
172+
- Updated resource schemas. The resource schemas for various Grid features
148173
have been updated to reflect their protobuf message counterparts and what a
149174
user can expect to see when fetching that resource. Some resources do not
150175
differ between their create and update messages and have not changed.
151-
- Removed Track and Trace endpoints. This feature will no longer be supported.
176+
- Removed Track and Trace endpoints. This feature will no longer be supported.
152177

153-
## For further consideration
178+
## Proposed for further consideration
154179

155-
- Consider changing `/batch_statuses` to `/batch-statuses`. This would bring
180+
- Change `/batch_statuses` to `/batch-statuses`. This would bring
156181
this endpoint in line with other endpoints in this API but consideration must
157182
be given to the impact this will have on the corresponding endpoints in
158183
Sawtooth and Splinter as well as backwards-compatibility concerns.
159-
- [Rest API Backwards Compatibility]({% link
160-
community/planning/rest_api/backwards_compatibility.md %})

0 commit comments

Comments
 (0)