openapi: 3.2.0
info:
  title: CoreStack External Azure DevOps Pipeline DashBoard API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Azure DevOps Pipeline DashBoard
servers:
- url: /
tags:
- name: Azure DevOps Pipeline DashBoard
  description: Azure DevOps Pipeline DashBoard
paths:
  /v1/azure-devops/dashboard/buildlogs/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureDevOpsListBuildLogsResponse'
      summary: List the available logs associated with build in AzureDevops
      description: List the available logs associated with build in AzureDevops
      operationId: ListBuildLogs
      security:
      - auth_token: []
      tags:
      - Azure DevOps Pipeline DashBoard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureDevOpsListBuildLogsRequests'
        required: true
  /v1/azure-devops/dashboard/builds/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureDevOpsListBuildResponse'
      summary: List the available builds under pipelines in AzureDevops
      description: List the available builds under pipelines in AzureDevops
      operationId: ListBuilds
      security:
      - auth_token: []
      tags:
      - Azure DevOps Pipeline DashBoard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureDevOpsListBuildRequests'
        required: true
  /v1/azure-devops/dashboard/buildworkitems/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureDevOpsBuildWorkItemsResponse'
      summary: List the available workitems associated with build in AzureDevops
      description: List the available workitems associated with build in AzureDevops
      operationId: ListBuildWorkItems
      security:
      - auth_token: []
      tags:
      - Azure DevOps Pipeline DashBoard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureDevOpsBuildWorkItemsRequest'
        required: true
  /v1/azure-devops/dashboard/pipelines/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureDevOpsListPipelinesResponse'
      summary: List the available projects under account in AzureDevops
      description: List the available projects under account in AzureDevops
      operationId: ListPipelines
      security:
      - auth_token: []
      tags:
      - Azure DevOps Pipeline DashBoard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureDevOpsListPipelinesRequest'
        required: true
  /v1/azure-devops/dashboard/projects/list:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureDevOpsPipelineListProjectsResponse'
      summary: List the available project under AzureDevops
      description: List the available projects under account in AzureDevops
      operationId: ListProjects
      security:
      - auth_token: []
      tags:
      - Azure DevOps Pipeline DashBoard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureDevOpsPipelineListProjectsRequest'
        required: true
components:
  schemas:
    AzureDevOpsBuild:
      properties:
        build_id:
          type: integer
        name:
          type: string
          description: Name of the Build
        status:
          type: string
          description: Build Status
          example: all
          enum:
          - all
          - cancelling
          - completed
          - inProgress
          - notStarted
          - postponed
          x-cs-enum-type: AzureDevOpsPipelineBuildStatus
        result:
          type: string
          description: Build Result
          example: canceled
          enum:
          - canceled
          - failed
          - succeeded
          - none
          - partiallySucceeded
          x-cs-enum-type: AzureDevOpsPipelineBuildResult
        started:
          type: string
          format: date-time
        finished:
          type: string
          format: date-time
        branch:
          type: string
          description: Branch of the repo under Build
        version:
          type: string
          description: Version of the repo under Build
      type: object
    AzureDevOpsListPipelinesRequest:
      required:
      - project_id
      - service_account_id
      properties:
        service_account_id:
          type: string
          description: Service Account ID
        project_id:
          type: string
          description: Azure Devops Project ID
      type: object
    AzureDevOpsListBuildResponse:
      properties:
        builds:
          type: array
          description: List of project name
          items:
            $ref: '#/components/schemas/AzureDevOpsBuild'
      type: object
    AzureDevOpsBuildWorkItemsResponse:
      properties:
        workitems:
          type: array
          description: List of workitems associated with build
          items:
            $ref: '#/components/schemas/AzureDevOpsBuildWorkItem'
      type: object
    AzureDevOpsPipeline:
      properties:
        pipeline_id:
          type: integer
          description: Azure DevOps Pipeline ID
        pipeline_name:
          type: string
          description: Azure DevOps Pipeline Name
      type: object
    AzureDevOpsListBuildRequests:
      required:
      - pipeline_id
      - project_id
      - service_account_id
      properties:
        service_account_id:
          type: string
          description: Service Account ID
        project_id:
          type: string
          description: Azure Devops Project ID
        pipeline_id:
          type: integer
          description: Azure Devops Pipeline ID
        status:
          type: string
          description: Filter the list of builds response based on the status
          example: all
          enum:
          - all
          - cancelling
          - completed
          - inProgress
          - notStarted
          - postponed
          x-cs-enum-type: AzureDevOpsPipelineBuildStatus
        query_order:
          type: string
          description: Criteria to sort the builds in the response
          example: finishTimeAscending
          enum:
          - finishTimeAscending
          - finishTimeDescending
          - queueTimeAscending
          - queueTimeDescending
          - startTimeAscending
          - startTimeDescending
          x-cs-enum-type: AzureDevOpsBuildQueryOrder
        search:
          type: string
          description: filter the build response with the provided search keyword
      type: object
    AzureDevOpsBuildWorkItemsRequest:
      required:
      - build_id
      - project_id
      - service_account_id
      properties:
        service_account_id:
          type: string
          description: Service Account ID
        project_id:
          type: string
          description: Azure Devops Project ID
        build_id:
          type: integer
          description: Azure Devops Build ID
      type: object
    AzureDevOpsListBuildLogsRequests:
      required:
      - build_id
      - project_id
      - service_account_id
      properties:
        service_account_id:
          type: string
          description: Service Account ID
        project_id:
          type: string
          description: Azure Devops Project ID
        build_id:
          type: integer
          description: Azure Devops Build ID
      type: object
    AzureDevOpsProject:
      properties:
        project_name:
          type: string
          description: Azure DevOps Project Name
        project_id:
          type: string
          description: Azure DevOps Project ID
      type: object
    AzureDevOpsPipelineListProjectsRequest:
      required:
      - service_account_id
      properties:
        service_account_id:
          type: string
          description: Service Account ID
      type: object
    ModelError:
      required:
      - message
      properties:
        message:
          type: string
          description: Error response message.
      type: object
    AzureDevOpsListBuildLogsResponse:
      properties:
        logs:
          type: array
          description: List of AzureDevOpsBuildLog
          items:
            $ref: '#/components/schemas/AzureDevOpsBuildLog'
      type: object
    AzureDevOpsListPipelinesResponse:
      properties:
        pipelines:
          type: array
          description: List of project name
          items:
            $ref: '#/components/schemas/AzureDevOpsPipeline'
      type: object
    AzureDevOpsPipelineListProjectsResponse:
      properties:
        projects:
          type: array
          description: List of project name
          items:
            $ref: '#/components/schemas/AzureDevOpsProject'
      type: object
    AzureDevOpsBuildWorkItem:
      properties:
        url:
          type: string
        workitem_id:
          type: integer
          description: Azure DevOps WorkItem ID
        type:
          type: string
          description: Azure DevOps WorkItem Type
        icon:
          type: string
          description: Azure DevOps WorkItem Type Icon URL
      type: object
    AzureDevOpsBuildLog:
      properties:
        log_id:
          type: integer
          description: Build Log Id
        created_on:
          type: string
          format: date-time
          description: Build Log created datetime
        last_changed_on:
          type: string
          format: date-time
          description: Build Log latest update datetime
        log_lines:
          type: array
          description: List of raw log lines
          items:
            type: string
      type: object
  securitySchemes:
    auth_token:
      type: apiKey
      in: header
      name: X-Auth-Token