johnbeynon/stash-api

---
"$schema": http://json-schema.org/draft-04/hyper-schema
title: Collections
definitions:
  id:
    description: unique identifier of collection
    example: 01234567-89ab-cdef-0123-456789abcdef
    format: uuid
    type:
    - string
  name:
    description: Name of the collection
    example: My Collection
    type:
    - string
  identity:
    "$ref": "/schemata/collection#/definitions/id"
  created_at:
    description: when collection was created
    example: '2012-01-01T12:00:00Z'
    format: date-time
    type:
    - string
  updated_at:
    description: when collection was updated
    example: '2012-01-01T12:00:00Z'
    format: date-time
    type:
      - "string"
      - "null"
description: "Collections are buckets for storing your resources in"
links:
- description: Create a new collection.
  href: "/collections"
  method: POST
  rel: create
  schema:
    properties:
      name:
        "$ref": "/schemata/collection#/definitions/name"
    type:
    - object
    required:
      - name
  title: Create
- description: Delete an existing collection.
  href: "/collections/{(%2Fschemata%2Fcollection%23%2Fdefinitions%2Fidentity)}"
  method: DELETE
  rel: destroy
  title: Delete
- description: Info for existing collection.
  href: "/collections/{(%2Fschemata%2Fcollection%23%2Fdefinitions%2Fidentity)}"
  method: GET
  rel: self
  title: Info
- description: List existing collections.
  href: "/collections"
  method: GET
  rel: instances
  title: List
- description: Update an existing collection.
  href: "/collections/{(%2Fschemata%2Fcollection%23%2Fdefinitions%2Fidentity)}"
  method: PATCH
  rel: update
  schema:
    properties:
      name:
        "$ref": "/schemata/collection#/definitions/name"
    type:
    - object
  title: Update
properties:
  created_at:
    "$ref": "/schemata/collection#/definitions/created_at"
  id:
    "$ref": "/schemata/collection#/definitions/id"
  name:
    "$ref": "/schemata/collection#/definitions/name"
  updated_at:
    "$ref": "/schemata/collection#/definitions/updated_at"
type:
- object
id: schemata/collection