Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
79 lines (73 sloc) 2.24 KB
#%RAML 1.0
title: Source Record Storage Batch API
version: v0.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Source Record Storage Batch API
content: Batch API for managing records
types:
recordCollection: !include raml-storage/schemas/dto/recordCollection.json
parsedRecordCollection: !include raml-storage/schemas/mod-source-record-storage/parsedRecordCollection.json
errors: !include raml-storage/raml-util/schemas/errors.schema
traits:
validate: !include raml-storage/raml-util/traits/validation.raml
/source-storage/batch:
/records:
post:
description: "Creates records from a record collection. It returns both saved records and error messages (if some record was not saved)."
is: [validate]
body:
application/json:
type: recordCollection
responses:
201:
body:
application/json:
type: recordCollection
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
422:
description: "Unprocessable Entity"
body:
application/json:
type: errors
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
application/json:
type: recordCollection
/parsed-records:
put:
description: "Updates parsed records from a collection. It returns both updated records and error messages (if some record was not updated)."
is: [validate]
body:
application/json:
type: parsedRecordCollection
responses:
200:
body:
application/json:
type: parsedRecordCollection
400:
description: "Bad request"
body:
text/plain:
example: "Bad request"
422:
description: "Unprocessable Entity"
body:
application/json:
type: errors
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
application/json:
type: parsedRecordCollection
You can’t perform that action at this time.