Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Instance Formats API
version: v2.0
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
documentation:
- title: Instance Formats API
content: This documents the API calls that can be made to query and manage instance formats
types:
instanceFormat: !include instanceformat.json
instanceFormats: !include instanceformats.json
errors: !include raml-util/schemas/errors.schema
traits:
language: !include raml-util/traits/language.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.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
/instance-formats:
type:
collection:
exampleCollection: !include examples/instanceformats.json
exampleItem: !include examples/instanceformat.json
schemaCollection: instanceFormats
schemaItem: instanceFormat
get:
is: [
searchable: {description: "with valid searchable fields", example: "name=aaa"},
pageable
]
description: Return a list of instance formats
post:
description: Create a new instance format
is: [validate]
/{instanceFormatId}:
description: Pass in the instance format id
type:
collection-item:
exampleItem: !include examples/instanceformat.json
schema: instanceFormat