openapi: 3.2.0
info:
  version: v1
  title: Graduate Division Grad Programs API
  description: This is designed to return information about the existing graduate programs and the details from graduate division, all public information.
servers:
- url: https://api.ucsb.edu/academics/gradprograms/v1
security:
- ucsb-api-key: []
tags:
- name: Programs
paths:
  /programs:
    get:
      tags:
      - Programs
      operationId: /programs
      parameters:
      - name: ucsb-api-version
        in: header
        description: Specific api version to use.
        required: false
        schema:
          type: string
          default: '1.0'
      responses:
        '200':
          description: Returns a list of basic graduate program information
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GraduateProgram'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GraduateProgram'
        '400':
          description: Bad or malformed request. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebApiInvalidModel'
            text/json:
              schema:
                $ref: '#/components/schemas/WebApiInvalidModel'
        '401':
          description: Unauthorized. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
        '404':
          description: Resource cannot be found. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
      summary: /programs
      x-summary-source: derived
  /programs/{id}:
    get:
      tags:
      - Programs
      operationId: /programs/{id}
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: ucsb-api-version
        in: header
        description: Specific api version to use.
        required: false
        schema:
          type: string
          default: '1.0'
      responses:
        '200':
          description: Returns a graduate program details information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraduateProgramDetail'
            text/json:
              schema:
                $ref: '#/components/schemas/GraduateProgramDetail'
        '400':
          description: Bad or malformed request. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebApiInvalidModel'
            text/json:
              schema:
                $ref: '#/components/schemas/WebApiInvalidModel'
        '401':
          description: Unauthorized. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
        '404':
          description: Resource cannot be found. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageModel'
      summary: /programs/{id}
      x-summary-source: derived
components:
  schemas:
    SimpleMessageModel:
      type: object
      properties:
        message:
          type: string
    WebApiInvalidModel:
      type: object
      properties:
        message:
          type: string
        modelState:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    GraduateProgram:
      type: object
      properties:
        id:
          format: int32
          description: Graduate Program's unique identifier
          type: integer
        displayName:
          description: The Graduate Program display name
          type: string
        degrees:
          description: Graduate Program's list of degrees, comma delimited
          type: string
    GraduateProgramDetail:
      description: ''
      type: object
      properties:
        id:
          format: int32
          description: Graduate Program unique identifier
          type: integer
        majorCode:
          description: 5 character major code
          type: string
        departmentCode:
          description: 5 character department code
          type: string
        displayName:
          description: Graduate Program's display name
          type: string
        description:
          description: Graduate Program's description , html formatted
          type: string
        website:
          description: Graduate Program's web site
          type: string
        address:
          description: Graduate Program's address
          type: string
        phone:
          description: Graduate Program's phone
          type: string
        email:
          description: Graduate Program's email address
          type: string
        degrees:
          description: list of degrees, separated by comma
          type: string
        requirements:
          description: list of requirements, html formatted
          type: string
        deadlines:
          description: Graduate Program's deadlines, comma separated
          type: string
        emphases:
          description: List of emphases, semicolon separated
          type: string
        specializations:
          description: List of specialization, semicolon separated
          type: string
  securitySchemes:
    ucsb-api-key:
      name: ucsb-api-key
      in: header
      type: apiKey