Skip to content

Commit

Permalink
move future query string from HTTP API doc to code doc
Browse files Browse the repository at this point in the history
  • Loading branch information
DocSavage committed Mar 7, 2024
1 parent adb054a commit de0ae1d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
9 changes: 8 additions & 1 deletion datatype/labelmap/handlers.go
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,14 @@ func (d *Data) handleMutations(ctx *datastore.VersionedCtx, w http.ResponseWrite
}

func (d *Data) handleMutationsRange(ctx *datastore.VersionedCtx, w http.ResponseWriter, r *http.Request, parts []string) {
// GET <api URL>/node/<UUID>/<data name>/mutations-range/<beg>/<end>?rangefmt=<format>
// GET <api URL>/node/<UUID>/<data name>/mutations-range/<beg>/<end>
// TODO: If feedback requests it, add querystring ?rangefmt=<format>
// The range format of parameters <beg> and <end> is specified by the
// value of the "rangefmt" query string:
// default: If no query string is given, the range is in the form of version UUIDs.
// "mutids": The range is in the form of mutation IDs (uint64).
// "timestamps": The range is in the form of RFC 3339 timestamps.

timedLog := dvid.NewTimeLog()

queryStrings := r.URL.Query()
Expand Down
15 changes: 4 additions & 11 deletions datatype/labelmap/labelmap.go
Original file line number Diff line number Diff line change
Expand Up @@ -1608,19 +1608,12 @@ GET <api URL>/node/<UUID>/<data name>/mutations[?queryopts]
is the requester's User ID (not necessarily the same as the
User ID whose mutations are being requested).
GET <api URL>/node/<UUID>/<data name>/mutations-range/<beg>/<end>?rangefmt=<format>
Returns JSON list of the successfully completed mutations across a given
range. The range format of parameters <beg> and <end> is specified by the
value of the "rangefmt" query string:
GET <api URL>/node/<UUID>/<data name>/mutations-range/<beg>/<end>
default: If no query string is given, the range is in the form of
version UUIDs.
--- The following are not yet implemented ---
"mutids": The range is in the form of mutation IDs (uint64).
"timestamps": The range is in the form of RFC 3339 timestamps.
Returns JSON list of the successfully completed mutations across the given
range of UUIDs. Each mutation record format is equivalent to the JSON
provided to the Kafka mutation log as in the /mutations endpoint.
GET <api URL>/node/<UUID>/<data name>/history/<label>/<from UUID>/<to UUID>
Expand Down

0 comments on commit de0ae1d

Please sign in to comment.