Stanford University Jobs API

openapi: 3.2.0
info:
  title: Stanford Jobs API
  version: 1.0.0
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged jobs across 2 of this provider''s published API definitions: stanford-dor-services-api-openapi.yml, stanford-sdr-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dor-services-{env}.stanford.edu
  description: Production service
  variables:
    env:
      default: prod
- url: https://sdr-api-{env}.stanford.edu
  description: Production service
  variables:
    env:
      default: prod
security:
- bearerAuth: []
tags:
- name: jobs
  description: Operations involving background jobs
paths:
  /v1/background_job_results/{id}:
    get:
      tags:
      - jobs
      summary: View results of a background job
      description: Used to allow the application run long-running processes out of the request/response cycle
      operationId: background_job_results#show
      responses:
        '200':
          description: The background job has completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobResultResponse'
        '202':
          description: The background job is pending or processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundJobResultResponse'
        '404':
          description: The background job with the given id was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: id
        in: path
        description: ID of background job result
        required: true
        schema:
          type: integer
    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
components:
  schemas:
    BackgroundJobResultResponse:
      type: object
      properties:
        output:
          $ref: '#/components/schemas/ErrorResponse'
        status:
          type: string
          description: the status of the background job
          enum:
          - pending
          - processing
          - complete
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    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
    BackgroundJobResultResponse_2:
      type: object
      properties:
        output:
          type: object
          description: output from the job
          properties:
            druid:
              $ref: https://raw.githubusercontent.com/sul-dlss/cocina-models/refs/tags/v0.113.0/schema.json#/$defs/Druid
            errors:
              type: array
              items:
                $ref: '#/components/schemas/Error_2'
        status:
          type: string
          description: the status of the background job
          enum:
          - pending
          - processing
          - complete
        try_count:
          type: integer
          description: the number of tries
    Error_2:
      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.
        source:
          type: object
          properties:
            pointer:
              type: string
              example: /data/attributes/title
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- stanford-dor-services-api-openapi.yml
- stanford-sdr-api-openapi.yml