codex-packages.raml

#%RAML 1.0
title: Codex Packages
baseUri: https://github.com/folio-org/mod-codex-ekb
version: v1

documentation:
 - title: Codex Packages API
   content: This documents the FOLIO codex packages API

types:
  package: !include ../../schemas/codex/package.json
  packageCollection: !include ../../schemas/codex/packageCollection.json
  errors: !include ../../schemas/errors.schema
  sourceCollection: !include ../../schemas/codex/sourceCollection.json

traits:
  validate: !include ../../traits/validation.raml
  pageable: !include ../../traits/pageable.raml
  searchable: !include ../../traits/searchable.raml

resourceTypes:
  get-only: !include ../../rtypes/get-only.raml
  collection-item-get: !include ../../rtypes/item-collection-get.raml

/codex-packages:
  displayName: Codex packages
  description: Codex packages collection
  type:
    get-only:
      schema: packageCollection
      exampleCollection: !include ../../examples/codex/packageCollection.sample
  get:
    is: [
      searchable: {description: "with valid searchable fields: for example name = academic", example: "name=academic"},
      pageable,
      validate
    ]
    responses:
      401:
        description: "Not authorized to perform requested action"
        body:
          text/plain:
            example: |
              "unable to list packages -- unauthorized"
  /{id}:
    displayName: Codex package
    description: Get a specific codex package
    type:
      collection-item-get:
        schema: package
        exampleItem: !include ../../examples/codex/package.sample

/codex-packages-sources:
  displayName: Codex packages sources
  description: Codex packages sources
  type:
    get-only:
        schema: sourceCollection
        exampleCollection: !include ../../examples/codex/sourceCollection.sample
  get:
    displayName: Codex sources
    description: GET a list of source modules that implement codex-packages interface