swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SolutionInference API
schemes:
- https
tags:
- name: SolutionInference
paths:
  /solutions/{solutionId}:cancel:
    post:
      tags:
      - SolutionInference
      description: Cancels a job for given solution id.
      operationId: microsoftAzureSolutioninferenceCancel
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: solutionId
        description: Id of solution for which job is to be cancelled.
        required: true
        type: string
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: solutionInferenceRequest
        description: solutionInferenceRequest containing input needed for job request processing.
        required: true
        schema:
          $ref: '#/definitions/SolutionInference'
      responses:
        '200':
          description: Success
          schema:
            type: object
            additionalProperties: {}
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        SolutionInference_Cancel:
          $ref: ./examples/SolutionInference_Cancel.json
      summary: Microsoft Azure Post Solutions Solutionid:cancel
  /solutions/{solutionId}:create:
    post:
      tags:
      - SolutionInference
      description: Creates a job trigger for a solution.
      operationId: microsoftAzureSolutioninferenceCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: solutionId
        description: Id of the solution resource.
        required: true
        type: string
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: solutionInferenceRequest
        description: solutionInferenceRequest containing input needed for job request processing.
        required: true
        schema:
          $ref: '#/definitions/SolutionInference'
      responses:
        '202':
          description: Accepted
          schema:
            type: object
            additionalProperties: {}
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        SolutionInference_CreateOrUpdate:
          $ref: ./examples/SolutionInference_CreateOrUpdate.json
      summary: Microsoft Azure Post Solutions Solutionid:create
  /solutions/{solutionId}:fetch:
    post:
      tags:
      - SolutionInference
      description: Fetches details of triggered job for a solution.
      operationId: microsoftAzureSolutioninferenceFetch
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: solutionId
        description: Id of the solution.
        required: true
        type: string
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: solutionInferenceRequest
        description: solutionInferenceRequest containing input needed for job request processing.
        required: true
        schema:
          $ref: '#/definitions/SolutionInference'
      responses:
        '200':
          description: Success
          schema:
            type: object
            additionalProperties: {}
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        SolutionInference_Fetch:
          $ref: ./examples/SolutionInference_Fetch.json
      summary: Microsoft Azure Post Solutions Solutionid:fetch
definitions:
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  SolutionInference:
    description: SolutionInference request model.
    required:
    - requestPath
    type: object
    properties:
      requestPath:
        description: "RequestPath containing the api-version, query parameters and path route to be called for partner request.\r\nExpected format is \"/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1\".\r\nNot following this format may result into validation errors."
        minLength: 1
        type: string
      partnerRequestBody:
        description: Api input parameters required by partner to trigger/cancel job request.
        type: object
        additionalProperties: {}
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'