Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
71 lines (64 sloc) 2.27 KB
#%RAML 1.0
title: Metadata Provider
version: v0.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Metadata Provider API
content: API for accessing metadata
types:
logDto: !include raml-storage/schemas/dto/logDto.json
logCollectionDto: !include raml-storage/schemas/dto/logCollectionDto.json
jobExecution: !include raml-storage/schemas/mod-source-record-manager/jobExecution.json
jobExecutionCollection: !include raml-storage/schemas/mod-source-record-manager/jobExecutionCollection.json
jobExecutionDto: !include raml-storage/schemas/dto/jobExecutionDto.json
jobExecutionCollectionDto: !include raml-storage/schemas/dto/jobExecutionCollectionDto.json
errors: !include raml-storage/raml-util/schemas/errors.schema
traits:
validate: !include raml-storage/raml-util/traits/validation.raml
language: !include raml-storage/raml-util/traits/language.raml
pageable: !include raml-storage/raml-util/traits/pageable.raml
searchable: !include raml-storage/raml-util/traits/searchable.raml
queryable:
queryParameters:
landingPage:
description: "Flag that indicates whether requested collection of entities have to be prepared for rendering on the landing page"
required: false
type: boolean
resourceTypes:
collection: !include raml-storage/raml-util/rtypes/collection.raml
collection-item: !include raml-storage/raml-util/rtypes/item-collection.raml
/metadata-provider:
/logs:
get:
is: [
searchable: {description: "with valid searchable fields", example: "jobProfileName=marc"},
pageable,
queryable
]
responses:
200:
body:
application/json:
schema: logCollectionDto
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"
/jobExecutions:
get:
is: [
searchable: {description: "with valid searchable fields", example: "status=RUNNING"},
pageable
]
responses:
200:
body:
application/json:
schema: jobExecutionCollectionDto
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error"