edge-orders.raml

#%RAML 0.8
title: 'Edge API - Orders'
baseUri: 'https://github.com/folio-org/edge-orders'
version: v1
documentation:
  -
    title: 'Edge API - Orders'
    content: 'Edge API to interface with FOLIO for 3rd party purchasing systems for placing orders'
schemas:
  -
    orders: !include orders.xsd
/orders/validate:
  displayName: Validate
  get:
    description: 'Validate that the API Key provided can be used to place an order'
    responses:
      '204':
        description: Success
      '400':
        description: 'Bad Request'
        body:
          application/xml:
            schema: orders
      '401':
        description: 'Access Denied'
        body:
          application/xml:
            schema: orders
      '408':
        description: 'Request Timeout'
        body:
          application/xml:
            schema: orders
      '500':
        description: 'Internal Server Error'
        body:
          application/xml:
            schema: orders
    queryParameters:
      type:
        description: 'purchasing system type'
        type: string
      apikey:
        description: 'API Key'
        type: string
/orders:
  displayName: 'Place Order'
  post:
    description: 'Place an order'
    responses:
      '201':
        description: Success
        body:
          application/xml:
            schema: orders
      '400':
        description: 'Bad Request'
        body:
          application/xml:
            schema: orders
      '401':
        description: 'Access Denied'
        body:
          application/xml:
            schema: orders
      '408':
        description: 'Request Timeout'
        body:
          application/xml:
            schema: orders
      '500':
        description: 'Internal Server Error'
        body:
          application/xml:
            schema: orders
    queryParameters:
      type:
        description: 'purchasing system type'
        type: string
      apikey:
        description: 'API Key'
        type: string
/admin/health:
  displayName: 'Health Check'
  get:
    description: 'Health Check'
    responses:
      '200':
        description: Success
        body:
          text/plain: null