openapi: 3.0.0
info:
  title: AAP on Azure - Deployment Driver API
  version: "1.0"
paths:
  /status:
    get:
      summary: Return status of deployment driver
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Status"
  /authcheck:
    get:
      summary: Check if authenticated w/ password (validate cookie)
      responses:
        "200":
          description: Client is authenticated
        "401":
          description: Client is not authenticated
        "500":
          description: Server error
  /authchecksso:
    get:
      summary: Check if SSO authenticated (validate cookie)
      responses:
        "200":
          description: Client is authenticated
        "401":
          description: Client is not authenticated
        "500":
          description: Server error
  /authtype:
    get:
      summary: Authorization type currently enabled
      responses:
        "200":
          description: Type of auth currently enabled
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/AuthType"
  /login:
    get:
      summary: SSO login - Set up SSO login and redirect to SSO server
      responses:
        "307":
          description: Temporary redirect to SSO server (success)
        "500":
          description: Unable to generate SSO nonce value
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Log into API (get cookie) OR SSO login redirect (see GET), depending on configuration
      responses:
        "200":
          description: OK
          headers:
            Set-Cookie:
              schema:
                type: string
                example: madd_session=<token>; Path=/; HttpOnly; Secure
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/LoginStatus"
        "307":
          description: Temporary redirect to SSO server (success) - SSO enabled only
        "500":
          description: Unable to generate SSO nonce value - SSO enabled only
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Invalid user ID or password
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Error"
  /logout:
    post:
      summary: Log out
      responses:
        "200":
          description: OK
  /ssocallback:
    get:
      summary: SSO callback endpoint
      responses:
        "307":
          description: Temporary redirect to deployment driver main URL (success)
          headers:
            Set-Cookie:
              schema:
                type: string
                example: madd_session=<token>; Path=/; HttpOnly; Secure
        "401":
          description: Unauthorized - SSO state value missing or invalid
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Error"
        "500":
          description: Server error - Unable to verify or utilize SSO data/token or create session cookie
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Error"
  /step:
    get:
      summary: Get a list of steps
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Step"
  "/step/{stepId}":
    get:
      summary: Get the specified step
      parameters:
        - in: path
          name: stepId
          description: Step ID to get
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Step"
  /execution:
    get:
      summary: Get a list of executions
      parameters:
        - in: query
          name: stepId
          required: false
          description: Filter executions by step ID
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Execution"
  "/execution/{executionId}":
    get:
      summary: Get the specified execution
      parameters:
        - in: path
          name: executionId
          description: Execution ID to get
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/Execution"
  "/execution/{executionId}/restart":
    post:
      summary: Restart this execution
      parameters:
        - in: path
          name: executionId
          description: Execution ID to restart
          required: true
          schema:
            type: integer
      responses:
        "200":
          description: OK
  /cancelAllSteps:
    post:
      summary: Cancel currently executing and all future steps
      responses:
        "200":
          description: OK
  /terminate:
    post:
      summary: Stop the deployment driver
      responses:
        "200":
          description: OK
  /deleteContainer:
    post:
      summary: Remove the installation container instance
      responses:
        "200":
          description: OK
  /azmarketplaceentitlementscount:
    get:
      summary: Get number of AZ marketplace entitlements
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/EntitlementsCount"
servers:
  - url: /api
components:
  schemas:
    Status:
      properties:
        status:
          type: string
          enum: [DEPLOYING, CANCELED, FAILED, DONE]
    LoginStatus:
      properties:
        status:
          type: string
          enum: [OK]
    Step:
      properties:
        ID:
          type: integer
        name:
          type: string
        order:
          description: Order of execution
          type: integer
        executions:
          description: Executions for this step
          type: array
          items:
            $ref: "#/components/schemas/Execution"
    Execution:
      properties:
        ID:
          type: integer
        status:
          type: string
        stepId:
          type: integer
        error:
          type: string
        errorDetails:
          type: string
        code:
          type: string
        provisioningState:
          type: string
        details:
          type: string
        timestamp:
          type: string
        duration:
          type: string
        correlationId:
          type: string
    Error:
      properties:
        error:
          type: string
    AuthType:
      properties:
        authtype:
          type: string
          enum: [SSO, CREDENTIALS]
    EntitlementsCount:
      properties:
        count:
          type: integer
        error:
          type: string