Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
51 lines (48 sloc)
1.54 KB
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
#%RAML 1.0 | |
title: Inventory Storage Instance Batch Sync API | |
version: v1.1 | |
protocols: [ HTTP, HTTPS ] | |
baseUri: http://localhost | |
documentation: | |
- title: "Inventory Storage Instance Batch Sync API" | |
content: <b>Batch API for synchronously uploading instances into the inventory</b> | |
types: | |
errors: !include raml-util/schemas/errors.schema | |
instances_post: !include instances_post.json | |
/instance-storage/batch/synchronous: | |
displayName: Instances Batch Upload Sync API | |
post: | |
description: "Create or update a collection of instances in a single synchronous request" | |
queryParameters: | |
upsert: | |
description: When a record with the same id already exists upsert=true will update it, upsert=false will fail the complete batch. | |
type: boolean | |
required: false | |
default: false | |
body: | |
application/json: | |
type: instances_post | |
example: !include examples/instances_post.json | |
responses: | |
201: | |
description: "All instances have been successfully created or updated" | |
409: | |
description: "Optimistic locking version conflict" | |
body: | |
text/plain: | |
example: "version error" | |
413: | |
description: "Payload Too Large" | |
body: | |
text/plain: | |
example: "Payload Too Large" | |
422: | |
description: "Unprocessable Entity" | |
body: | |
application/json: | |
type: errors | |
500: | |
description: "Internal server error" | |
body: | |
text/plain: | |
example: "Internal server error" | |