openapi: 3.0.0
servers:
  - url: 'http://localhost:8506/api'
    description: Local server
info:
  description: This is an API to manage software dependency records across multiple team within Ardoq
  version: '1.0.0'
  title: DTSSE Ardoq Adapter
  license:
    name: MIT License
    url: 'https://github.com/hmcts/dtsse-ardoq-adapter/blob/master/LICENSE'
security:
  - BearerAuth: []
paths:
  /dependencies:
    post:
      tags:
        - admins
      summary: adds an inventory item
      operationId: addInventory
      description: Adds an item to the system
      responses:
        '201':
          description: item created
        '400':
          description: 'invalid input, object invalid'
        '409':
          description: an existing item already exists
      parameters:
        - in: query
          name: async
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DependencyList'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
  schemas:
    DependencyList:
      type: object
      required:
        - vcsHost
        - hmctsApplication
        - codeRepository
        - encodedDependencyList
        - parser
      properties:
        language:
          type: string
          example: 'node'
        languageVersion:
          type: string
          example: '18-alpine'
        vcsHost:
          type: string
          enum:
            [
              'Github HMCTS',
              'Gerrit',
              'Github MoJ',
              'Github CJS Common Platform',
              'Azure Portal',
              'S: Drive',
              'SharePoint',
              'Gitlab',
              'Subversion',
              'OneDrive Justice.gov.uk (individuals)',
            ]
          example: 'github.com/hmcts'
        hmctsApplication:
          type: string
          example:
        codeRepository:
          type: string
          example: 'dtsse-ardoq-adapter'
        encodedDependencyList:
          type: string
          format: byte
          example: U3dhZ2dlciByb2Nrcw==
        encodedDependencyListOther:
          type: string
          format: byte
          example: U3dhZ2dlciByb2Nrcw==
        parser:
          type: string
          enum: ['gradle', 'maven', 'npm', 'yarn', 'pip', 'dotnet']
          example: 'gradle'