Permalink
Fetching contributors…
Cannot retrieve contributors at this time
50 lines (43 sloc) 1.41 KB
#%RAML 1.0
title: Platforms API
version: v1.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Platforms API
content: This documents the API calls that can be made to query and manage platforms for electronic resources
types:
platform: !include platform.json
platforms: !include platforms.json
errors: !include raml-util/schemas/errors.schema
traits:
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
language: !include raml-util/traits/language.raml
validate: !include raml-util/traits/validation.raml
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
get-delete-only: !include raml-util/rtypes/get-delete.raml
/platforms:
type:
collection:
exampleCollection: !include examples/platforms.json
exampleItem: !include examples/platform.json
schemaCollection: platforms
schemaItem: platform
get:
is: [
searchable: {description: "with valid searchable fields", example: "name=aaa"},
pageable
]
description: Return a list of platforms for electronic resources
post:
description: Create a new platform
is: [validate]
/{platformId}:
description: Pass in the platform id
type:
collection-item:
exampleItem: !include examples/platform.json
schema: platform