openapi: 3.2.0
info:
  version: ''
  title: Namely Job Title API
  description: Move your app forward with the Namely API Move your app forward with the Namely API
tags:
- name: Job Title
paths:
  /job_titles:
    get:
      operationId: GET_job_titles
      summary: Get all Job Titles
      tags:
      - Job Title
      description: 'Returns all job titles. Each job title must have one and only one linked job tier (and each job tier can have zero to many linked job titles).


        When using the #endpoint:K6iFb2x6z2yTM9jev endpoint, the API user must either use the <code>title</code> or <code>id</code> of a <code>job_title</code>.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_titles:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job_Title'
                  meta:
                    type: object
                    $ref: '#/components/schemas/Meta'
                  links:
                    type: object
                    properties:
                      job_titles.job_tier:
                        type: object
                        items:
                          $ref: '#/components/schemas/Link'
                  linked:
                    type: object
                    properties:
                      job_tiers:
                        type: array
                        items:
                          $ref: '#/components/schemas/Job_Tier'
      security:
      - Authorization: []
    post:
      operationId: POST_job_titles
      summary: Create a Job Title
      tags:
      - Job Title
      description: 'Creates a job title.


        Use the #endpoint:xfyRRDnWE32d5PNBZ endpoint to get a list of job tiers, whose <code>id</code> is used to populate the value for the <code>parent</code> (job tier) key in the request body.'
      responses:
        '201':
          description: Create Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_titles:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job_Title'
                  meta:
                    type: object
                    $ref: '#/components/schemas/Meta'
                  links:
                    type: object
                    properties:
                      job_titles.job_tier:
                        type: object
                        $ref: '#/components/schemas/Link'
                  linked:
                    type: object
                    properties:
                      job_tiers:
                        type: array
                        items:
                          $ref: '#/components/schemas/Job_Tier'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Create_Job_Title'
  /job_titles/{id}:
    parameters:
    - name: id
      in: path
      description: id of the job title you want to view
      required: true
      schema:
        type: string
    get:
      operationId: GET_job_titles-id
      summary: Get a Job Title
      tags:
      - Job Title
      description: 'Returns information about a single Job Title..


        When using the #endpoint:K6iFb2x6z2yTM9jev endpoint, the API user must either use the <code>title</code> or <code>id</code> of a <code>job_title</code>.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_titles:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job_Title'
                  meta:
                    type: object
                    $ref: '#/components/schemas/Meta'
                  links:
                    type: object
                    properties:
                      job_titles.job_tier:
                        type: object
                        $ref: '#/components/schemas/Link'
                  linked:
                    type: object
                    properties:
                      job_tiers:
                        type: array
                        items:
                          $ref: '#/components/schemas/Job_Tier'
      security:
      - Authorization: []
    put:
      operationId: PUT_job_titles-id
      summary: Update a Job Title
      tags:
      - Job Title
      description: "Updates the label and/or parent (job tier) of a job title.\n\nUse the #endpoint:xfyRRDnWE32d5PNBZ endpoint to get a list of job tiers, whose <code>id</code> is used to populate the value for the <code>parent</code> (job tier) key in the request body. \n\nIf not updating the <code>parent</code>, use the <code>id</code> of the current <code>parent</code> value; if not updating the <code>title</code>, use the current job title <code>title</code>."
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_titles:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job_Title'
                  meta:
                    type: object
                    $ref: '#/components/schemas/Meta'
                  links:
                    type: object
                    properties:
                      job_titles.job_tier:
                        type: object
                        $ref: '#/components/schemas/Link'
                  linked:
                    type: object
                    properties:
                      job_tiers:
                        type: array
                        items:
                          $ref: '#/components/schemas/Job_Tier'
      security:
      - Authorization: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Update_Job_Title'
components:
  schemas:
    Create_Job_Title:
      title: Create Job Title
      type: object
      properties:
        job_titles:
          type: array
          items:
            $ref: '#/components/schemas/Create_Job_Title_Payload'
      required:
      - job_titles
    Update_Job_Title:
      title: Update Job Title
      type: object
      properties:
        job_titles:
          type: array
          items:
            $ref: '#/components/schemas/update-job-title-payload'
      required:
      - job_titles
    Job_Tier:
      title: Job Tier
      type: object
      properties:
        id:
          type: string
          description: unique identifier of the job tier
        numerical_id:
          type: string
        title:
          type: string
          default: ''
          description: name/label of the job tier
        links:
          type: object
          properties:
            job_titles:
              type: array
              description: id of the job titles associated with the job tier
              items:
                type: string
    Job_Title:
      title: Job Title
      type: object
      properties:
        id:
          type: string
          description: unique identifier of the job title
        parent_id:
          type: string
          description: id of the job tier associated with the job title (when creating a job title, the key is "parent")
        title:
          type: string
          description: name/label of the job title
        links:
          type: object
          properties:
            job_tier:
              type: string
              description: 'id of the job tier associated with the job title '
    update-job-title-payload:
      title: Update Job Title Payload
      type: object
      properties:
        title:
          type: string
          description: '[new] name/label of the job title you’re updating'
        parent:
          type: string
          description: id of the [new] job tier with which you want to associate the job title
      required:
      - title
      - parent
    Meta:
      title: Meta
      type: object
      properties:
        count:
          type: integer
          description: number of total objects
        status:
          type: integer
          description: HTTP response
    Create_Job_Title_Payload:
      title: Create Job Title Payload
      type: object
      properties:
        title:
          type: string
          description: name/label of the job title you’re creating
        parent:
          type: string
          description: id of the job tier with which you want to associate the job title
      required:
      - title
      - parent
    Link:
      title: Link
      type: object
      properties:
        type:
          type: string
  securitySchemes:
    Authorization:
      name: Authorization
      type: apiKey
      in: header