swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector discoverSolutions API
schemes:
- https
tags:
- name: discoverSolutions
paths:
  /providers/Microsoft.Help/discoverSolutions:
    post:
      tags:
      - discoverSolutions
      description: Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary.
      operationId: microsoftAzureDiscoverysolutionnlptenantscopePost
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: discoverSolutionRequest
        description: Request body for discovering solutions using NLP.
        schema:
          $ref: '#/definitions/DiscoveryNlpRequest'
      responses:
        '200':
          description: Successful fetched list of solution metadata.
          schema:
            $ref: '#/definitions/DiscoveryNlpResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Discovery Solutions using issue summary and service id.:
          $ref: ./examples/DiscoverSolutionsAtTenantScope.json
      summary: Microsoft Azure Post Providers Microsoft Help Discoversolutions
  /subscriptions/{subscriptionId}/providers/Microsoft.Help/discoverSolutions:
    post:
      tags:
      - discoverSolutions
      description: Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.
      operationId: microsoftAzureDiscoverysolutionnlpsubscriptionscopePost
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: discoverSolutionRequest
        description: Request body for discovering solutions using NLP.
        schema:
          $ref: '#/definitions/DiscoveryNlpRequest'
      responses:
        '200':
          description: Successful fetched list of solution metadata.
          schema:
            $ref: '#/definitions/DiscoveryNlpResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Discovery Solutions using issue summary and service id.:
          $ref: ./examples/DiscoverSolutionsAtSubscriptionScope.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Help Discoversolutions
definitions:
  ClassificationService:
    description: Service Classification result object.
    type: object
    properties:
      serviceId:
        description: Azure resource Id of the service.
        type: string
        format: arm-id
        readOnly: true
      displayName:
        description: Localized name of the azure service.
        type: string
        readOnly: true
      resourceTypes:
        description: List of applicable ARM resource types for this service.
        type: array
        items:
          type: string
  SolutionNlpMetadataResource:
    description: Nlp Metadata resource
    type: object
    x-ms-azure-resource: true
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NlpSolutions'
        description: Solution metadata Resource properties.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  DiscoveryNlpRequest:
    description: Discover NLP request.
    type: object
    required:
    - issueSummary
    properties:
      issueSummary:
        description: Natural language description of the issue.
        type: string
      resourceId:
        description: ARM resource Id of the resource that is having the issue.
        type: string
      serviceId:
        description: ARM service Id of the service that is having the issue. For more information on service Id see https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP.
        type: string
      additionalContext:
        description: Additional information in the form of a string.
        type: string
  SolutionType:
    description: Solution Type.
    type: string
    readOnly: true
    enum:
    - Diagnostics
    - Solutions
    - Troubleshooters
    - SelfHelp
    x-ms-enum:
      name: SolutionType
      modelAsString: true
      values:
      - value: Diagnostics
        description: Diagnostics resource type.
      - value: Solutions
        description: Solutions resource type.
      - value: Troubleshooters
        description: Troubleshooters resource type.
      - value: SelfHelp
        description: SelfHelp resource type.
  DiscoveryNlpResponse:
    description: Successfully fetched list of solution metadata.
    type: object
    properties:
      value:
        description: The list of solution metadata.
        type: array
        items:
          $ref: '#/definitions/SolutionNlpMetadataResource'
  SolutionMetadataProperties:
    description: Metadata Properties
    type: object
    properties:
      solutionId:
        description: Solution Id.
        type: string
      solutionType:
        $ref: '#/definitions/SolutionType'
      description:
        description: A detailed description of solution.
        type: string
        readOnly: true
      requiredInputs:
        description: Required parameters for invoking this particular solution.
        type: array
        readOnly: true
        items:
          type: string
        x-ms-identifiers: []
  NlpSolutions:
    description: Nlp metadata.
    type: object
    properties:
      problemTitle:
        description: Title of the problem classification.
        type: string
      problemDescription:
        description: Description of the problem classification.
        type: string
      serviceId:
        description: Id of the service (https://learn.microsoft.com/en-us/rest/api/support/services?view=rest-support-2020-04-01) that may be used to create a support ticket.
        type: string
      problemClassificationId:
        description: Id of the ProblemClassification (https://learn.microsoft.com/en-us/rest/api/support/problem-classifications?view=rest-support-2020-04-01) that may be used to create a support ticket.
        type: string
      solutions:
        description: The list of solution metadata.
        type: array
        items:
          $ref: '#/definitions/SolutionMetadataProperties'
        x-ms-identifiers: []
      relatedServices:
        description: The set of services that are most likely related to the request. If relatedServices is included in the response then solutions may not be discovered until the client calls a second time specifying one of the service Ids in the relatedServices object.
        type: array
        items:
          $ref: '#/definitions/ClassificationService'
        x-ms-identifiers: []
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'