Stanford University Release Tags API

openapi: 3.2.0
info:
  description: Backend API for the Stanford Digital Repository
  version: 1.0.0
  title: DOR Services Release Tags API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://dor-services-{env}.stanford.edu
  description: Production service
  variables:
    env:
      default: prod
- url: https://dor-services-{env}.stanford.edu
  description: Staging service
  variables:
    env:
      default: stage
- url: https://dor-services-{env}.stanford.edu
  description: QA service
  variables:
    env:
      default: qa
security:
- bearerAuth: []
tags:
- name: release_tags
  description: Operations about release tags
paths:
  /v1/objects/{object_id}/release_tags:
    get:
      tags:
      - release_tags
      summary: The release tag log for this object
      operationId: release_tags#index
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReleaseTag'
        '422':
          description: Unprocessable entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: object_id
        in: path
        description: ID of object
        required: true
        schema:
          $ref: https://raw.githubusercontent.com/sul-dlss/cocina-models/refs/tags/v0.113.0/schema.json#/$defs/Druid
      - name: public
        in: query
        description: Return all of the tags that apply to this object, from the collection and directly applied
        required: false
        schema:
          type: boolean
          default: false
    post:
      tags:
      - release_tags
      summary: Create a new release_tag for this object
      description: ''
      operationId: release_tag#create
      responses:
        '201':
          description: Created
      parameters:
      - name: object_id
        in: path
        description: ID of object
        required: true
        schema:
          $ref: https://raw.githubusercontent.com/sul-dlss/cocina-models/refs/tags/v0.113.0/schema.json#/$defs/Druid
      - name: lane-id
        in: query
        schema:
          $ref: '#/components/schemas/LaneId'
      requestBody:
        description: release tag to add to the system
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseTag'
components:
  schemas:
    Error:
      type: object
      properties:
        title:
          type: string
          description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem.
          example: Invalid Attribute
        detail:
          type: string
          description: a human-readable explanation specific to this occurrence of the problem.
          example: Title must contain at least three characters.
        meta:
          type: object
          description: used to include non-standard meta-information
          example:
            backtrace:
            - where things went wrong
        source:
          type: object
          properties:
            pointer:
              type: string
              example: /data/attributes/title
    LaneId:
      description: Lane for prioritizing the work
      type: string
      enum:
      - default
      - low
      - high
      default: default
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ReleaseTag:
      description: A tag that indicates the item or collection should be released.
      type: object
      additionalProperties: true
      required:
      - release
      - what
      properties:
        who:
          description: Who did this release
          type: string
          example: petucket
        what:
          description: What is being released. This item or the whole collection.
          type: string
          enum:
          - self
          - collection
          example: self
        date:
          description: When did this action happen
          type: string
          format: date-time
        to:
          description: What platform is it released to
          type: string
          example: Searchworks
        release:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT