johnbeynon/stash-api

View on GitHub
docs/schema/schemata/tag.yaml

Summary

Maintainability
Test Coverage
---
"$schema": http://json-schema.org/draft-04/hyper-schema
title: Tag
definitions:
  id:
    description: unique identifier of tag
    example: 01234567-89ab-cdef-0123-456789abcdef
    format: uuid
    type:
    - string
  identity:
    "$ref": "/schemata/tag#/definitions/id"
  name:
    description: Name of the tag
    example: A Tag
    type:
    - string
  slug:
    description: Generated slug of the tag
    example: a-tag
    type:
    - string
description: FIXME
links:
- description: Create a new tag.
  href: "/tags"
  method: POST
  rel: create
  schema:
    properties: {}
    type:
    - object
    required: 
      - name
  title: Create
- description: Delete an existing tag.
  href: "/tags/{(%2Fschemata%2Ftag%23%2Fdefinitions%2Fidentity)}"
  method: DELETE
  rel: destroy
  title: Delete
- description: Info for existing tag.
  href: "/tags/{(%2Fschemata%2Ftag%23%2Fdefinitions%2Fidentity)}"
  method: GET
  rel: self
  title: Info
- description: List existing tags.
  href: "/tags"
  method: GET
  rel: instances
  title: List
- description: Update an existing tag.
  href: "/tags/{(%2Fschemata%2Ftag%23%2Fdefinitions%2Fidentity)}"
  method: PATCH
  rel: update
  schema:
    properties: {}
    type:
    - object
  title: Update
- description: Tags in collection.
  href: "/collections/{(%2Fschemata%2Fcollection%23%2Fdefinitions%2Fidentity)}/tags"
  method: GET
  rel: instances
  title: Lists
properties:
  id:
    "$ref": "/schemata/tag#/definitions/id"
  name:
    "$ref": "/schemata/tag#/definitions/name"
  slug:
    "$ref": "/schemata/tag#/definitions/slug"
type:
- object
id: schemata/tag