Skip to content

Commit

Permalink
minor updates #2
Browse files Browse the repository at this point in the history
  • Loading branch information
jreadey committed Oct 7, 2024
1 parent 075676e commit a581f6e
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/design/map/h5_map.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Request Elements:

Returns: id for object

### Get a map
### Get map metadata

This request returns information on a map object

Expand All @@ -65,7 +65,7 @@ Returns: HTTP Status Code

This request adds a key to a map

Request PUT /maps/<map_id>/maps/<key>
Request PUT /maps/<map_id>/key/<key>

Request Elements:
value: value for the given key
Expand All @@ -74,7 +74,7 @@ Request Elements:

This request returns value for given key

Request GET /maps/<map_id>/maps/<key>
Request GET /maps/<map_id>/key/<key>

Request Elements:
None
Expand All @@ -86,7 +86,7 @@ TBD: Support returning 410 (Gone) for recently removed keys

### Get values for a set of keys

Request POST /maps/<map_id>/maps
Request POST /maps/<map_id>/keys

Request Elements:
Body as a list of keys
Expand All @@ -98,7 +98,7 @@ Returns:

Returns all key/value pairs for give map object

Request: /maps/<map_id>/maps
Request: /maps/<map_id>/keys

Request Elements:
Limit If provided, a positive integer value specifying the maximum number of key/value pairs to return.
Expand All @@ -113,7 +113,7 @@ TBD: support binary responses

This request removes a given key an its associatted value

Request: DELETE /maps/<map_id>/map/<key_value>
Request: DELETE /maps/<map_id>/key/<key_value>

Request Elements:
None
Expand All @@ -124,7 +124,7 @@ RETURN: HTTP Status code. 404 if key does not exist

This request removes a set of key and their associatted values

Request: DELETE /maps/<map_id>/map
Request: DELETE /maps/<map_id>/keys

Request Elements:
None
Expand All @@ -136,7 +136,6 @@ RETURN: HTTP Status code. 404 if key does not exist
GET, PUT, DELETE requests for attribute operations. Follow same schema as attributes for other objects (Groups, Datasets, Commited Data Types)



## 2. Design/Architecture

TBD

0 comments on commit a581f6e

Please sign in to comment.