Fast API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
Version: 0.1.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Get All Keys (getAllKeysSharingGet)
This method returns all keys of the OrderedShelf.
:return: List of all Keys in the OrderedShelf
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Response
Up
get /sharing/{state_name}
Get State (getStateSharingStateNameGet)
This method retrieves a state given its name.
:param state_name: Key of the state which should be retrieved
:return: Returns marshalled JSON state (the same format it was saved in)
Path parameters
state_name (required)
Path Parameter —
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Response
422
Validation Error
HTTPValidationError
Up
post /sharing/{state_name}
Post State (postStateSharingStateNamePost)
This method saves a state given a name.
:param state_name: Key of the state which should be saved
:param state: Marshalled version of the state
Path parameters
state_name (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful Response
422
Validation Error
HTTPValidationError
[ Jump to Methods ]
Table of Contents
HTTPValidationError
- HTTPValidationError
ValidationError
- ValidationError