swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Custom APIs API
schemes:
- https
tags:
- name: Custom APIs
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure List Of Custom Apis
      operationId: microsoftAzureCustomapisList
      description: Gets a list of all custom APIs for a subscription id
      x-ms-examples:
        List all custom APIs:
          $ref: ./examples/customApisList.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/pageSizeParameter'
      - $ref: '#/parameters/skipTokenParameter'
      responses:
        '200':
          description: A list of custom APIs
          schema:
            $ref: '#/definitions/CustomApiDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure List Of Custom Apis
      operationId: microsoftAzureCustomapisListbyresourcegroup
      description: Gets a list of all custom APIs in a subscription for a specific resource group
      x-ms-examples:
        List all custom APIs:
          $ref: ./examples/customApisListByResourceGroup.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/pageSizeParameter'
      - $ref: '#/parameters/skipTokenParameter'
      responses:
        '200':
          description: A list of custom APIs
          schema:
            $ref: '#/definitions/CustomApiDefinitionCollection'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}:
    get:
      tags:
      - Custom APIs
      summary: Microsoft Azure Get A Custom Api
      operationId: microsoftAzureCustomapisGet
      description: Gets a custom API by name for a specific subscription and resource group
      x-ms-examples:
        Get a custom API:
          $ref: ./examples/customApisGet.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: A custom API
          schema:
            $ref: '#/definitions/CustomApiDefinition'
    put:
      tags:
      - Custom APIs
      summary: Microsoft Azure Replaces An Existing Custom Api
      operationId: microsoftAzureCustomapisCreateorupdate
      description: Creates or updates an existing custom API
      x-ms-examples:
        Replace a custom API:
          $ref: ./examples/customApisCreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiNameParameter'
      - $ref: '#/parameters/customApiParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The replacing custom API
          schema:
            $ref: '#/definitions/CustomApiDefinition'
    patch:
      tags:
      - Custom APIs
      summary: Microsoft Azure Update An Existing Custom Api
      operationId: microsoftAzureCustomapisUpdate
      description: Updates an existing custom API's tags
      x-ms-examples:
        Update a custom API's tags:
          $ref: ./examples/customApisUpdate.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiNameParameter'
      - $ref: '#/parameters/customApiParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The updated custom API
          schema:
            $ref: '#/definitions/CustomApiDefinition'
    delete:
      tags:
      - Custom APIs
      summary: Microsoft Azure Delete A Custom Api
      operationId: microsoftAzureCustomapisDelete
      description: Deletes a custom API from the resource group
      x-ms-examples:
        Delete a custom API:
          $ref: ./examples/customApisDelete.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the custom API
        '204':
          description: No custom API to delete
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}/move:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Moves The Custom Api
      operationId: microsoftAzureCustomapisMove
      description: Moves a specific custom API
      x-ms-examples:
        Move a custom API:
          $ref: ./examples/customApisMove.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiNameParameter'
      - $ref: '#/parameters/customApiReferenceParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: custom API successfully moved
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/listWsdlInterfaces:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Lists Wsdl Interfaces
      operationId: microsoftAzureCustomapisListwsdlinterfaces
      description: This returns the list of interfaces in the WSDL
      x-ms-examples:
        List the WSDL interfaces:
          $ref: ./examples/customApisListWsdlInterfaces.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/locationParameter'
      - $ref: '#/parameters/wsdlDefinitionParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: A list of interfaces
          schema:
            $ref: '#/definitions/WsdlServiceCollection'
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/extractApiDefinitionFromWsdl:
    post:
      tags:
      - Custom APIs
      summary: Microsoft Azure Returns Api Definition From Wsdl
      operationId: microsoftAzureCustomapisExtractapidefinitionfromwsdl
      description: Parses the specified WSDL and extracts the API definition
      x-ms-examples:
        Extract definition from WSDL:
          $ref: ./examples/customApisExtractApiDefinitionFromWsdl.json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/locationParameter'
      - $ref: '#/parameters/wsdlDefinitionParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Swagger of the API extracted from the WSDL
          schema: {}
definitions:
  WsdlServiceCollection:
    description: A list of custom API WSDL interfaces
    type: object
    properties:
      value:
        description: Collection of WSDL interfaces
        type: array
        items:
          $ref: '#/definitions/WsdlService'
  ApiResourceBackendService:
    type: object
    description: The API backend service
    additionalProperties: false
    properties:
      serviceUrl:
        type: string
        description: The service URL
  WsdlService:
    type: object
    description: The service with name and endpoint names
    additionalProperties: false
    required:
    - qualifiedName
    properties:
      qualifiedName:
        description: The service's qualified name
        type: string
      endpointQualifiedNames:
        type: array
        description: List of the endpoints' qualified names
        items:
          type: string
  CustomApiDefinition:
    type: object
    description: A custom API
    additionalProperties: false
    properties:
      properties:
        $ref: '#/definitions/CustomApiPropertiesDefinition'
    allOf:
    - $ref: '#/definitions/ResourceDefinition'
  TagsDictionary:
    type: object
    description: Resource tags
    additionalProperties:
      type: string
    example:
      SampleTagName: SampleTagValue
  ResourceDefinition:
    description: A resource
    type: object
    additionalProperties: false
    properties:
      id:
        description: Resource id
        type: string
        readOnly: true
      name:
        description: Resource name
        type: string
        readOnly: true
      type:
        description: Resource type
        type: string
        readOnly: true
      location:
        description: Resource location
        type: string
      etag:
        description: Resource ETag
        type: string
      tags:
        $ref: '#/definitions/TagsDictionary'
    x-ms-azure-resource: true
  WsdlImportMethod:
    type: string
    description: The WSDL import method
    enum:
    - NotSpecified
    - SoapToRest
    - SoapPassThrough
    x-ms-enum:
      name: WsdlImportMethod
      modelAsString: true
  WsdlDefinition:
    type: object
    description: The WSDL definition
    additionalProperties: false
    properties:
      url:
        type: string
        description: The WSDL URL
      content:
        type: string
        description: The WSDL content
      service:
        $ref: '#/definitions/WsdlService'
      importMethod:
        $ref: '#/definitions/WsdlImportMethod'
  CustomApiDefinitionCollection:
    description: A list of custom API definitions
    type: object
    properties:
      value:
        description: Collection of custom APIs
        type: array
        items:
          $ref: '#/definitions/CustomApiDefinition'
  ResourceReference:
    type: object
    x-abstract: true
    additionalProperties: false
    properties:
      id:
        description: Resource reference id
        type: string
      type:
        description: Resource reference type
        type: string
  ApiReference:
    type: object
    x-abstract: true
    additionalProperties: false
    properties:
      swagger:
        type: object
        description: The JSON representation of the swagger
      brandColor:
        type: string
        description: Brand color
      description:
        type: string
        description: The custom API description
      displayName:
        type: string
        description: The display name
      iconUri:
        type: string
        description: The icon URI
      name:
        type: string
        description: The name of the API
    allOf:
    - $ref: '#/definitions/ResourceReference'
  CustomApiPropertiesDefinition:
    type: object
    description: Custom API properties
    additionalProperties: false
    properties:
      connectionParameters:
        description: Connection parameters
        type: object
        additionalProperties:
          $ref: '#/definitions/ConnectionParameter'
      runtimeUrls:
        type: array
        description: Runtime URLs
        items:
          type: string
      capabilities:
        type: array
        description: The custom API capabilities
        items:
          type: string
      swagger:
        type: object
        description: The JSON representation of the swagger
      brandColor:
        type: string
        description: Brand color
      description:
        type: string
        description: The custom API description
      displayName:
        type: string
        description: The display name
      iconUri:
        type: string
        description: The icon URI
      backendService:
        $ref: '#/definitions/ApiResourceBackendService'
      apiDefinitions:
        $ref: '#/definitions/ApiResourceDefinitions'
      apiType:
        $ref: '#/definitions/ApiType'
      wsdlDefinition:
        $ref: '#/definitions/WsdlDefinition'
  ConnectionParameter:
    description: Connection provider parameters
    type: object
    properties:
      type:
        description: Type of the parameter
        enum:
        - string
        - securestring
        - secureobject
        - int
        - bool
        - object
        - array
        - oauthSetting
        - connection
        type: string
        x-ms-enum:
          name: ConnectionParameterType
          modelAsString: false
      oAuthSettings:
        $ref: '#/definitions/ApiOAuthSettings'
  CustomApiReference:
    type: object
    description: The custom API reference
    additionalProperties: false
    properties:
      name:
        type: string
    allOf:
    - $ref: '#/definitions/ApiReference'
  ApiOAuthSettings:
    description: OAuth settings for the connection provider
    type: object
    properties:
      identityProvider:
        description: Identity provider
        type: string
      clientId:
        description: Resource provider client id
        type: string
      clientSecret:
        description: Client Secret needed for OAuth
        type: string
      scopes:
        description: OAuth scopes
        type: array
        items:
          type: string
      redirectUrl:
        description: Url
        type: string
      properties:
        type: object
        description: Read only properties for this oauth setting.
      customParameters:
        description: OAuth parameters key is the name of parameter
        type: object
        additionalProperties:
          $ref: '#/definitions/ApiOAuthSettingsParameter'
  ApiResourceDefinitions:
    type: object
    description: API Definitions
    additionalProperties: false
    properties:
      originalSwaggerUrl:
        type: string
        description: The original swagger URL
      modifiedSwaggerUrl:
        type: string
        description: The modified swagger URL
  ApiType:
    type: string
    description: The API type
    enum:
    - NotSpecified
    - Rest
    - Soap
    x-ms-enum:
      name: ApiType
      modelAsString: true
  ApiOAuthSettingsParameter:
    description: OAuth settings for the API
    type: object
    properties:
      value:
        description: Value of the setting
        type: string
      options:
        type: object
        description: Options available to this parameter
      uiDefinition:
        type: object
        description: UI definitions per culture as caller can specify the culture
parameters:
  customApiParameter:
    name: customApi
    description: The custom API
    in: body
    required: true
    schema:
      $ref: '#/definitions/CustomApiDefinition'
    x-ms-parameter-location: method
  resourceGroupNameParameter:
    name: resourceGroupName
    description: The resource group
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  locationParameter:
    name: location
    description: The location
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  wsdlDefinitionParameter:
    name: wsdlDefinition
    description: WSDL definition
    in: body
    required: true
    schema:
      $ref: '#/definitions/WsdlDefinition'
    x-ms-parameter-location: method
  customApiReferenceParameter:
    name: customApiReference
    description: The custom API reference
    in: body
    required: true
    schema:
      $ref: '#/definitions/CustomApiReference'
    x-ms-parameter-location: method
  apiNameParameter:
    type: string
    name: apiName
    description: API name
    in: path
    required: true
    x-ms-parameter-location: method
  apiVersionParameter:
    name: api-version
    in: query
    description: API Version
    required: true
    type: string
    x-ms-parameter-location: method
  pageSizeParameter:
    name: $top
    description: The number of items to be included in the result
    in: query
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription Id
    required: true
    type: string
    x-ms-parameter-location: method
  skipTokenParameter:
    type: string
    name: skiptoken
    description: Skip Token
    in: query
    required: false
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'