cleaning description of basket

cleaning description of basket

#%RAML 0.8
baseUri: http://{apiHost}
title: shoehorn
version: VERSION
mediaType:  application/json
baseUriParameters:
  apiHost:
    enum: ["dev-shoehorn.herokuapp.com","staging-shoehorn.herokuapp.com","localhost:9000"]
resourceTypes:
  - collection:
      get:
        description: retrieves a list of **<<resourceName>>s** (all of them if no 'q' is present as query param)
        queryParameters:
          q: &q
            required: false
            description: optional query as a json expression
            example: |
              {"foo":true, "bar":2014}

      post:
        description: creates a new resource
        body:
          application/json:
            example: <<postexample>>
        responses:
            201:
              description: Created
              headers:
                Location:
                  description: the url of the newly created **<<resourceName>>**
                  example: http://{apiHost}/<<resourceName>>s/53ecbedd1700004c00d115b1
                Shoehorn-resource-id:
                  description: the id of the newly created **<<resourceName>>**
                  example: 53ecbedd1700004c00d115b1

  - collection-item:
      get:
        description: fetches the resource with the given id
        responses: &standardResponses
          200:
            description: OK
            body:
              application/json:
                example: <<getexample>>
          404:
            description: NOTFOUND
      put:
        description: updates an existing resource by the given id
        body:
          application/json:
            example: <<postexample>>
        responses:
          200:
            description: OK
          400:
            description: TODO
      delete:
        description: deletes the resource with the given id

/catalogs:
  type:
    collection:
      resourceName: catalog
      postexample: !include catalog.json

  /{id}:
    type:
      collection-item:
        getexample: !include catalog.json
        postexample: !include catalog.json
/products:
  type:
    collection:
      resourceName: product
      postexample: !include product.json
  get:
    queryParameters:
      q: *q
#      catalogs:
#        description: |
#          json array of catalog ids.
#
#          will return those products that are part of any of the given catalogs
#        example: ["1","2","3"]

  /{id}:
    type:
      collection-item:
        getexample: !include product.json
        postexample: !include product.json

/baskets:
  type:
    collection:
      resourceName: basket
      postexample: !include basket.json
  /{id}:
    type:
      collection-item:
        getexample: !include basket.json
        postexample: !include basket.json
    delete:
      queryParameters:
        itemNumber:
          description: |
            deletes an item from the given basket (identified by path variable :id)
            with the given itemNumber
          example: 1011-22401
        size:
          description: |
            deletes an item from the given basket (identified by path variable :id)
            with the given itemNumber and size
            only allowed if itemNumber is present in the query
          example: 13

/warehouses:
  type:
    collection:
      resourceName: warehouse
      postexample: !include warehouse.json
  /{id}:
    type:
      collection-item:
        getexample: !include warehouse.json
        postexample: !include warehouse.json

/agents:
  type:
    collection:
      resourceName: agent
      postexample: !include agent.json
  /{id}:
    type:
      collection-item:
        getexample: !include agent.json
        postexample: !include agent.json

/shops:
  type:
    collection:
      resourceName: shop
      postexample: !include shop.json
  /{id}:
    type:
      collection-item:
        getexample: !include shop.json
        postexample: !include shop.json

/sizegroups:
  type:
    collection:
      resourceName: sizegroup
      postexample: !include sizegroup.json
  /{id}:
    type:
      collection-item:
        getexample: !include sizegroup.json
        postexample: !include sizegroup.json

/deadlinetypes:
  type:
    collection:
      resourceName: deadlinetype
      postexample: !include deadlinetype.json
  /{id}:
    type:
      collection-item:
        getexample: !include deadlinetype.json
        postexample: !include deadlinetype.json

/companytypes:
  type:
    collection:
      resourceName: companytype
      postexample: !include companytype.json
  /{id}:
    type:
      collection-item:
        getexample: !include companytype.json
        postexample: !include companytype.json

/addresstypes:
  type:
    collection:
      resourceName: addresstype
      postexample: !include addresstype.json
  /{id}:
    type:
      collection-item:
        getexample: !include addresstype.json
        postexample: !include addresstype.json

/districts:
  type:
    collection:
      resourceName: district
      postexample: !include district.json
  /{id}:
    type:
      collection-item:
        getexample: !include district.json
        postexample: !include district.json

/lineofbusinesses:
  type:
    collection:
      resourceName: lineofbusiness
      postexample: !include lineofbusiness.json
  /{id}:
    type:
      collection-item:
        getexample: !include lineofbusiness.json
        postexample: !include lineofbusiness.json

#%RAML 0.8
baseUri: http://{apiHost}
title: shoehorn
version: VERSION
mediaType:  application/json
baseUriParameters:
  apiHost:
    enum: ["dev-shoehorn.herokuapp.com","staging-shoehorn.herokuapp.com","localhost:9000"]
resourceTypes:
  - collection:
      get:
        description: retrieves a list of **<<resourceName>>s** (all of them if no 'q' is present as query param)
        queryParameters:
          q: &q
            required: false
            description: optional query as a json expression
            example: |
              {"foo":true, "bar":2014}

      post:
        description: creates a new resource
        body:
          application/json:
            example: <<postexample>>
        responses:
            201:
              description: Created
              headers:
                Location:
                  description: the url of the newly created **<<resourceName>>**
                  example: http://{apiHost}/<<resourceName>>s/53ecbedd1700004c00d115b1
                Shoehorn-resource-id:
                  description: the id of the newly created **<<resourceName>>**
                  example: 53ecbedd1700004c00d115b1

  - collection-item:
      get:
        description: fetches the resource with the given id
        responses: &standardResponses
          200:
            description: OK
            body:
              application/json:
                example: <<getexample>>
          404:
            description: NOTFOUND
      put:
        description: updates an existing resource by the given id
        body:
          application/json:
            example: <<postexample>>
        responses:
          200:
            description: OK
          400:
            description: TODO
      delete:
        description: deletes the resource with the given id

/catalogs:
  type:
    collection:
      resourceName: catalog
      postexample: !include catalog.json

  /{id}:
    type:
      collection-item:
        getexample: !include catalog.json
        postexample: !include catalog.json
/products:
  type:
    collection:
      resourceName: product
      postexample: !include product.json
  get:
    queryParameters:
      q: *q
#      catalogs:
#        description: |
#          json array of catalog ids.
#
#          will return those products that are part of any of the given catalogs
#        example: ["1","2","3"]

  /{id}:
    type:
      collection-item:
        getexample: !include product.json
        postexample: !include product.json

/baskets:
  type:
    collection:
      resourceName: basket
      postexample: !include basket.json
  /{id}:
    type:
      collection-item:
        getexample: !include basket.json
        postexample: !include basket.json
    delete:
      queryParameters:
        itemNumber:
          description: |
            deletes an item from the given basket (identified by path variable :id)
            with the given itemNumber
          example: 1011-22401
        size:
          description: |
            deletes an item from the given basket (identified by path variable :id)
            with the given itemNumber and size
            only allowed wen itemNumber is present as queryparam
          example: 13

/warehouses:
  type:
    collection:
      resourceName: warehouse
      postexample: !include warehouse.json
  /{id}:
    type:
      collection-item:
        getexample: !include warehouse.json
        postexample: !include warehouse.json

/agents:
  type:
    collection:
      resourceName: agent
      postexample: !include agent.json
  /{id}:
    type:
      collection-item:
        getexample: !include agent.json
        postexample: !include agent.json

/shops:
  type:
    collection:
      resourceName: shop
      postexample: !include shop.json
  /{id}:
    type:
      collection-item:
        getexample: !include shop.json
        postexample: !include shop.json

/sizegroups:
  type:
    collection:
      resourceName: sizegroup
      postexample: !include sizegroup.json
  /{id}:
    type:
      collection-item:
        getexample: !include sizegroup.json
        postexample: !include sizegroup.json

/deadlinetypes:
  type:
    collection:
      resourceName: deadlinetype
      postexample: !include deadlinetype.json
  /{id}:
    type:
      collection-item:
        getexample: !include deadlinetype.json
        postexample: !include deadlinetype.json

/companytypes:
  type:
    collection:
      resourceName: companytype
      postexample: !include companytype.json
  /{id}:
    type:
      collection-item:
        getexample: !include companytype.json
        postexample: !include companytype.json

/addresstypes:
  type:
    collection:
      resourceName: addresstype
      postexample: !include addresstype.json
  /{id}:
    type:
      collection-item:
        getexample: !include addresstype.json
        postexample: !include addresstype.json

/districts:
  type:
    collection:
      resourceName: district
      postexample: !include district.json
  /{id}:
    type:
      collection-item:
        getexample: !include district.json
        postexample: !include district.json

/lineofbusinesses:
  type:
    collection:
      resourceName: lineofbusiness
      postexample: !include lineofbusiness.json
  /{id}:
    type:
      collection-item:
        getexample: !include lineofbusiness.json
        postexample: !include lineofbusiness.json


updated doc;

updated doc;

#%RAML 0.8
title: CPDN REST API
version: v1
baseUri: https://api.cpdn.sd2.cz/{version}
mediaType: application/json
protocols: [ HTTPS ]
securedBy: [ oauth_2_0 ]

securitySchemes:
  - oauth_2_0: !include schemes/oauth2.raml

resourceTypes:
  - collection-read: !include types/collection-read.raml
  - collection-read-create: !include types/collection-read-create.raml
  - item-read: !include types/item-read.raml
  - item-read-update: !include types/item-read-update.raml
  - item-read-delete: !include types/item-read-delete.raml
  - item-read-update-delete: !include types/item-read-update-delete.raml
  - item-create-delete: !include types/item-create-delete.raml

traits:
  - paged: !include traits/paged.raml
  - searchable: !include traits/searchable.raml
  - sortable: !include traits/sortable.raml
  - expandable: !include traits/expandable.raml

/schemes:
  description: Scheme root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/schemes.json
      exampleCreateItem: !include samples/create-body/scheme.json
      searchableDoc: (description=string;name=string;version=int,lock=string-bool)
      sortableDoc: (description,name,version,lock)
      expandableDoc: (scheme)
  /{scheme_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/scheme.json
          exampleUpdateItem: !include samples/update-body/scheme.json
          expandableDoc: ()
    /nodes:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-nodes.json
          searchableDoc: (mapPoint=int)
          sortableDoc: (mapPoint)
          expandableDoc: (node,node.calc,node.mapPoint,node.spec)
    /sections:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-sections.json
          searchableDoc: (nodes.src=int;nodes.dst=int;nodes.trc=int)
          sortableDoc: (nodes.src,nodes.dst,nodes.trc)
          expandableDoc: (section,section.calc,section.nodes,section.spec)
    /mapPoints:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-mapPoints.json
          searchableDoc: (gps.lat=double;gps.lon=double;gps.alt=double;node=int;x=double;y=double)
          sortableDoc: (gps.lat,gps.lon,gps.alt,node,x,y)
          expandableDoc: (mapPoint)
    /objects:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-objects.json
          searchableDoc: (name=string)
          sortableDoc: (name)
          expandableDoc: (object)
    /permissions:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-permissions.json
          searchableDoc: (user=int;mode=string;tsFrom=string-time;tsTo=string-time)
          sortableDoc: (user,mode,tsFrom,tsTo)
          expandableDoc: (permission,permission.user)
    /tasks:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-tasks.json
          searchableDoc: (user=int;executor=int;status=string;priority=int)
          sortableDoc: (user,executor,status,priority)
          expandableDoc: (task,task.user,task.executor)

/nodes:
  description: Node root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/nodes.json
      exampleCreateItem: !include samples/create-body/node.json
      searchableDoc: (SCHEME=int;mapPoint=int)
      sortableDoc: (mapPoint,scheme)
      expandableDoc: (node,node.calc,node.mapPoint,node.scheme,node.spec)
  /{node_id}:
    type:
        item-read-delete:
          exampleReadItem: !include samples/read-body/node.json
          expandableDoc: (calc,mapPoint,scheme,spec)
    /calc:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-calc.json
          exampleUpdateItem: !include samples/update-body/node-calc.json
          expandableDoc: ()
    /mapPoint:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-mapPoint.json
          exampleUpdateItem: !include samples/update-body/node-mapPoint.json
          expandableDoc: (mapPoint)
    /scheme:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-scheme.json
          exampleUpdateItem: !include samples/update-body/node-scheme.json
          expandableDoc: (scheme)
    /spec:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-spec.json
          exampleUpdateItem: !include samples/update-body/node-spec.json
          expandableDoc: ()

/sections:
  description: Section root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/sections.json
      exampleCreateItem: !include samples/create-body/section.json
      searchableDoc: (SCHEME=int;nodes.src=int;nodes.dst=int;nodes.trc=int)
      sortableDoc: (nodes.src,nodes.dst,nodes.trc,scheme)
      expandableDoc: (section,section.calc,section.nodes,section.scheme,section.spec)
  /{section_id}:
    type:
        item-read-delete:
          exampleReadItem: !include samples/read-body/section.json
          expandableDoc: (calc,nodes,scheme,spec)
    /calc:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-calc.json
          exampleUpdateItem: !include samples/update-body/section-calc.json
          expandableDoc: ()
    /nodes:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-nodes.json
          exampleUpdateItem: !include samples/update-body/section-nodes.json
          expandableDoc: (dst,src,trc)
    /paths:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/section-paths.json
          searchableDoc: (mapPoint.src=int;mapPoint.dst=int)
          sortableDoc: (mapPoint.src,mapPoint.dst)
          expandableDoc: (path,path.mapPoint.dst,path.mapPoint.src)
    /scheme:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-scheme.json
          exampleUpdateItem: !include samples/update-body/section-scheme.json
          expandableDoc: (scheme)
    /spec:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-spec.json
          exampleUpdateItem: !include samples/update-body/section-spec.json
          expandableDoc: ()

/mapPoints:
  description: MapPoint root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/mapPoints.json
      exampleCreateItem: !include samples/create-body/mapPoint.json
      searchableDoc: (SCHEME=int;gps.lat=double;gps.lon=double;gps.alt=double;node=int;x=double;y=double)
      sortableDoc: (gps.lat,gps.lon,gps.alt,node,scheme,x,y)
      expandableDoc: (mapPoint,mapPoint.node,mapPoint.scheme)
  /{mapPoint_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/mapPoint.json
          exampleUpdateItem: !include samples/update-body/mapPoint.json
          expandableDoc: (node,scheme)

/paths:
  description: Path root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/paths.json
      exampleCreateItem: !include samples/create-body/path.json
      searchableDoc: (SECTION=int;mapPoint.src=int;mapPoint.dst=int)
      sortableDoc: (mapPoint.src,mapPoint.dst,section)
      expandableDoc: (path,path.mapPoint.dst,path.mapPoint.src,path.section)
  /{path_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/path.json
          exampleUpdateItem: !include samples/update-body/path.json
          expandableDoc: (mapPoint.dst,mapPoint.src,section)

/objects:
  description: Object root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/objects.json
      exampleCreateItem: !include samples/create-body/object.json
      searchableDoc: (SCHEME=int;name=string)
      sortableDoc: (scheme,name)
      expandableDoc: (object,object.scheme)
  /{object_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/object.json
          exampleUpdateItem: !include samples/update-body/object.json
          expandableDoc: (scheme)
    /nodes:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/object-nodes.json
          searchableDoc: ()
          sortableDoc: ()
          expandableDoc: (node,node.calc,node.mapPoint,node.scheme,node.spec)
    /node/{node_id}:
      description: Create/delete relation between object_id and node_id
      type:
        item-create-delete:
          exampleCreateItem: !include samples/create-body/object-node.json

/notifications:
  description: Notification root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/notifications.json
      searchableDoc: (USER=int;title=string;tsCreate=string-time;tsRead=string-time)
      sortableDoc: (user,title,tsCreate,tsRead)
      expandableDoc: (notification,notification.user)
  /{notification_id}:
    type:
        item-read-update:
          exampleReadItem: !include samples/read-body/notification.json
          exampleUpdateItem: !include samples/update-body/notification.json
          expandableDoc: (user)

/permissions:
  description: Permission root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/permission.json
      exampleCreateItem: !include samples/create-body/permission.json
      searchableDoc: (SCHEME=int;user=int;mode=string;tsFrom=string-time;tsTo=string-time)
      sortableDoc: (scheme,user,mode,tsFrom,tsTo)
      expandableDoc: (permission,permission.user,permission.scheme)
  /{permission_id}:
    type:
      item-read-update-delete:
        exampleReadItem: !include samples/read-body/permission.json
        exampleUpdateItem: !include samples/update-body/permission.json
        expandableDoc: (user,scheme)

/tasks:
  description: Task root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/tasks.json
      exampleCreateItem: !include samples/create-body/task.json
      searchableDoc: (SCHEME=int;user=int;executor=int;status=string;priority=int)
      sortableDoc: (user,executor,scheme,status,priority)
      expandableDoc: (task,task.user,task.executor,task.scheme)
  /{task_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/task.json
        expandableDoc: (user,executor,scheme)

/executors:
  description: Executor root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/executors.json
      searchableDoc: (title=string;status=string)
      sortableDoc: (title,status)
      expandableDoc: (executor)
  /{executor_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/executor.json
        expandableDoc: ()

/users:
  description: User root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/users.json
      searchableDoc: (firstName=string;lastName=string,nick=string;email=string)
      sortableDoc: (firstName,lastName,nick,email)
      expandableDoc: (user)
  /{user_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/user.json
        expandableDoc: ()

#%RAML 0.8
title: CPDN REST API
version: v1
baseUri: https://api.cpdn.sd2.cz/{version}
mediaType: application/json
protocols: [ HTTPS ]
securedBy: [ oauth_2_0 ]

securitySchemes:
  - oauth_2_0: !include schemes/oauth2.raml

resourceTypes:
  - collection-read: !include types/collection-read.raml
  - collection-read-create: !include types/collection-read-create.raml
  - item-read: !include types/item-read.raml
  - item-read-update: !include types/item-read-update.raml
  - item-read-delete: !include types/item-read-delete.raml
  - item-read-update-delete: !include types/item-read-update-delete.raml
  - item-create-delete: !include types/item-create-delete.raml

traits:
  - paged: !include traits/paged.raml
  - searchable: !include traits/searchable.raml
  - sortable: !include traits/sortable.raml
  - expandable: !include traits/expandable.raml

/schemes:
  description: Scheme root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/schemes.json
      exampleCreateItem: !include samples/create-body/scheme.json
      searchableDoc: (description=string;name=string;version=int,lock=string-bool)
      sortableDoc: (description,name,version,lock)
      expandableDoc: (scheme)
  /{scheme_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/scheme.json
          exampleUpdateItem: !include samples/update-body/scheme.json
          expandableDoc: ()
    /nodes:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-nodes.json
          searchableDoc: (mapPoint=int)
          sortableDoc: (mapPoint)
          expandableDoc: (node,node.calc,node.mapPoint,node.spec)
    /sections:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-sections.json
          searchableDoc: (nodes.src=int;nodes.dst=int;nodes.trc=int)
          sortableDoc: (nodes.src,nodes.dst,nodes.trc)
          expandableDoc: (section,section.calc,section.nodes,section.spec)
    /mapPoints:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-mapPoints.json
          searchableDoc: (gps.lat=double;gps.lon=double;gps.alt=double;node=int;x=double;y=double)
          sortableDoc: (gps.lat,gps.lon,gps.alt,node,x,y)
          expandableDoc: (mapPoint)
    /objects:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-objects.json
          searchableDoc: (name=string)
          sortableDoc: (name)
          expandableDoc: (object)
    /permissions:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-permissions.json
          searchableDoc: (user=int;mode=string;tsFrom=string-time;tsTo=string-time)
          sortableDoc: (user,mode,tsFrom,tsTo)
          expandableDoc: (permission,permission.user)
    /tasks:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/scheme-tasks.json
          searchableDoc: (user=int;executor=int;status=string;priority=int)
          sortableDoc: (user,executor,status,priority)
          expandableDoc: (task,task.user,task.executor)

/nodes:
  description: Node root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/nodes.json
      exampleCreateItem: !include samples/create-body/node.json
      searchableDoc: (SCHEME=int;mapPoint=int)
      sortableDoc: (mapPoint,scheme)
      expandableDoc: (node,node.calc,node.mapPoint,node.scheme,node.spec)
  /{node_id}:
    type:
        item-read-delete:
          exampleReadItem: !include samples/read-body/node.json
          expandableDoc: (calc,mapPoint,scheme,spec)
    /calc:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-calc.json
          exampleUpdateItem: !include samples/update-body/node-calc.json
          expandableDoc: ()
    /mapPoint:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-mapPoint.json
          exampleUpdateItem: !include samples/update-body/node-mapPoint.json
          expandableDoc: (mapPoint)
    /scheme:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-scheme.json
          exampleUpdateItem: !include samples/update-body/node-scheme.json
          expandableDoc: (scheme)
    /spec:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/node-spec.json
          exampleUpdateItem: !include samples/update-body/node-spec.json
          expandableDoc: ()

/sections:
  description: Section root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/sections.json
      exampleCreateItem: !include samples/create-body/section.json
      searchableDoc: (SCHEME=int;nodes.src=int;nodes.dst=int;nodes.trc=int)
      sortableDoc: (nodes.src,nodes.dst,nodes.trc,scheme)
      expandableDoc: (section,section.calc,section.nodes,section.scheme,section.spec)
  /{section_id}:
    type:
        item-read-delete:
          exampleReadItem: !include samples/read-body/section.json
          expandableDoc: (calc,nodes,scheme,spec)
    /calc:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-calc.json
          exampleUpdateItem: !include samples/update-body/section-calc.json
          expandableDoc: ()
    /nodes:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-nodes.json
          exampleUpdateItem: !include samples/update-body/section-nodes.json
          expandableDoc: (dst,src,trc)
    /paths:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/section-paths.json
          searchableDoc: (mapPoint.src=int;mapPoint.dst=int)
          sortableDoc: (mapPoint.src,mapPoint.dst)
          expandableDoc: (path,path.mapPoint.dst,path.mapPoint.src)
    /scheme:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-scheme.json
          exampleUpdateItem: !include samples/update-body/section-scheme.json
          expandableDoc: (scheme)
    /spec:
      type:
        item-read-update:
          exampleReadItem: !include samples/read-body/section-spec.json
          exampleUpdateItem: !include samples/update-body/section-spec.json
          expandableDoc: ()

/mapPoints:
  description: MapPoint root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/mapPoints.json
      exampleCreateItem: !include samples/create-body/mapPoint.json
      searchableDoc: (SCHEME=int;gps.lat=double;gps.lon=double;gps.alt=double;node=int;x=double;y=double)
      sortableDoc: (gps.lat,gps.lon,gps.alt,node,scheme,x,y)
      expandableDoc: (mapPoint,mapPoint.node,mapPoint.scheme)
  /{mapPoint_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/mapPoint.json
          exampleUpdateItem: !include samples/update-body/mapPoint.json
          expandableDoc: (node,scheme)

/paths:
  description: Path root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/paths.json
      exampleCreateItem: !include samples/create-body/path.json
      searchableDoc: (SECTION=int;mapPoint.src=int;mapPoint.dst=int)
      sortableDoc: (mapPoint.src,mapPoint.dst,section)
      expandableDoc: (path,path.mapPoint.dst,path.mapPoint.src,path.section)
  /{path_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/path.json
          exampleUpdateItem: !include samples/update-body/path.json
          expandableDoc: (mapPoint.dst,mapPoint.src,section)

/objects:
  description: Object root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/objects.json
      exampleCreateItem: !include samples/create-body/object.json
      searchableDoc: (SCHEME=int;name=string)
      sortableDoc: (scheme,name)
      expandableDoc: (object,object.scheme)
  /{object_id}:
    type:
        item-read-update-delete:
          exampleReadItem: !include samples/read-body/object.json
          exampleUpdateItem: !include samples/update-body/object.json
          expandableDoc: (scheme)
    /nodes:
      type:
        collection-read:
          exampleCollection: !include samples/read-body/object-nodes.json
          searchableDoc: ()
          sortableDoc: ()
          expandableDoc: (node,node.calc,node.mapPoint,node.scheme,node.spec)
    /node/{node_id}:
      description: Create/delete relation between object_id and node_id
      type:
        item-create-delete:
          exampleCreateItem: !include samples/create-body/object-node.json

/notifications:
  description: Notification root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/notifications.json
      searchableDoc: (USER=int;title=string;tsCreate=string-time;tsRead=string-time)
      sortableDoc: (user,title,tsCreate,tsRead)
      expandableDoc: (notification,notification.user)
  /{notification_id}:
    type:
        item-read-update:
          exampleReadItem: !include samples/read-body/notification.json
          exampleUpdateItem: !include samples/update-body/notification.json
          expandableDoc: (user)

/permissions:
  description: Schema permissions root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/permission.json
      exampleCreateItem: !include samples/create-body/permission.json
      searchableDoc: (SCHEME=int;user=int;mode=string;tsFrom=string-time;tsTo=string-time)
      sortableDoc: (scheme,user,mode,tsFrom,tsTo)
      expandableDoc: (permission,permission.user,permission.scheme)
  /{permission_id}:
    type:
      item-read-update-delete:
        exampleReadItem: !include samples/read-body/permission.json
        exampleUpdateItem: !include samples/update-body/permission.json
        expandableDoc: (user,scheme)

/tasks:
  description: Schema task root resource
  type:
    collection-read-create:
      exampleCollection: !include samples/read-body/tasks.json
      exampleCreateItem: !include samples/create-body/task.json
      searchableDoc: (SCHEME=int;user=int;executor=int;status=string;priority=int)
      sortableDoc: (user,executor,scheme,status,priority)
      expandableDoc: (task,task.user,task.executor,task.scheme)
  /{task_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/task.json
        expandableDoc: (user,executor,scheme)

/executors:
  description: Executor root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/executors.json
      searchableDoc: (title=string;status=string)
      sortableDoc: (title,status)
      expandableDoc: (executor)
  /{executor_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/executor.json
        expandableDoc: ()

/users:
  description: User root resource
  type:
    collection-read:
      exampleCollection: !include samples/read-body/users.json
      searchableDoc: (firstName=string;lastName=string,nick=string;email=string)
      sortableDoc: (firstName,lastName,nick,email)
      expandableDoc: (user)
  /{user_id}:
    type:
      item-read:
        exampleReadItem: !include samples/read-body/user.json
        expandableDoc: ()


retry travis

retry travis

#%RAML 0.8
---
title: raml-proxy
baseUri: http://{host}/@@@proxy
version: v1
traits:
  - ignorable:
      headers:
        X-Ignore-Commands:
          description: If 'true' then ignore the command
  - json:
      responses:
        200:
          body:
            application/json:
  - text:
      responses:
        200:
          body:
            text/plain:

/stop:
  description: Stop the server
  get:
    is: [ignorable,text]

/options:
  description: Compare the sent options with the current ones, return 'same' or 'different'
  post:
    is: [ignorable,text]
    body:
      text/plain:

/reload:
  description: Reload the RAML file and flush the reports
  get:
    is: [ignorable,text]

/reports:
  description: Return all reports since startup or last reload
  get:
    is: [ignorable,json]

/usage:
  /clear:
    description: Flush all usage data
    get:
      is: [ignorable,text]
  get:
    description: Return all usage data since startup or last usage flush
    is: [ignorable,json]


MODCAT-52

#%RAML 0.8
title: Character Encoding Schema
version: v1
baseUri: http://github.com/org/folio/mod-cataloging

documentation:
  - title: mod-cataloging API
    content: This documents the API calls that can be made to manage character encoding schema within the cataloging module.

schemas:
  - characterEncodingSchema: !include schemas/characterEncodingSchema.json
  - characterEncodingSchemaCollection: !include schemas/characterEncodingSchemaCollection.json
  - errors: !include ../raml-util/schemas/errors.schema
  - error.schema: !include ../raml-util/schemas/error.schema
  - parameters.schema: !include ../raml-util/schemas/parameters.schema

traits:
  - secured: !include ../raml-util/traits/auth.raml
  - orderable: !include ../raml-util/traits/orderable.raml
  - 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-only: !include ../raml-util/rtypes/get-only.raml
  - post-empty-body: !include ../raml-util/rtypes/post-empty-body.raml

/cataloging/character-encoding-schemas:
  type:
    collection:
      exampleCollection: !include examples/characterEncodingSchemaCollection.json
      exampleItem: !include examples/characterEncodingSchema.json
      schemaCollection: characterEncodingSchemaCollection
      schemaItem: characterEncodingSchema

#%RAML 0.8
title: CharacterEncodingSchema
version: v1
baseUri: http://github.com/org/folio/mod-cataloging

documentation:
  - title: mod-cataloging API
    content: This documents the API calls that can be made to manage character encoding schema within the cataloging module.

schemas:
  - characterEncodingSchema: !include schemas/characterEncodingSchema.json
  - characterEncodingSchemaCollection: !include schemas/characterEncodingSchemaCollection.json
  - errors: !include ../raml-util/schemas/errors.schema
  - error.schema: !include ../raml-util/schemas/error.schema
  - parameters.schema: !include ../raml-util/schemas/parameters.schema

traits:
  - secured: !include ../raml-util/traits/auth.raml
  - orderable: !include ../raml-util/traits/orderable.raml
  - 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-only: !include ../raml-util/rtypes/get-only.raml
  - post-empty-body: !include ../raml-util/rtypes/post-empty-body.raml

/cataloging/character-encoding-schemas:
  type:
    collection:
      exampleCollection: !include examples/characterEncodingSchemaCollection.json
      exampleItem: !include examples/characterEncodingSchema.json
      schemaCollection: characterEncodingSchemaCollection
      schemaItem: characterEncodingSchema