swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Environment Definitions API
schemes:
- https
tags:
- name: Environment Definitions
paths:
  /projects/{projectName}/environmentDefinitions:
    get:
      tags:
      - Environment Definitions
      description: Lists all environment definitions available for a project.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/TopParameter
      operationId: microsoftAzureEnvironmentsListenvironmentdefinitionsbyproject
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EnvironmentDefinitionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        Environments_ListEnvironmentDefinitions:
          $ref: ./examples/EnvironmentDefinitions_ListByProject.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Projects Projectname Environmentdefinitions
  /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions:
    get:
      tags:
      - Environment Definitions
      description: Lists all environment definitions available within a catalog.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: devcenter.json#/parameters/TopParameter
      - $ref: '#/parameters/CatalogNameParameter'
      operationId: microsoftAzureEnvironmentsListenvironmentdefinitionsbycatalog
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EnvironmentDefinitionListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        Environments_ListEnvironmentDefinitionsByCatalog:
          $ref: ./examples/EnvironmentDefinitions_ListByCatalog.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Projects Projectname Catalogs Catalogname Environmentdefinitions
  /projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}:
    get:
      tags:
      - Environment Definitions
      description: Get an environment definition from a catalog.
      parameters:
      - $ref: devcenter.json#/parameters/ApiVersionParameter
      - $ref: devcenter.json#/parameters/ProjectNameParameter
      - $ref: '#/parameters/CatalogNameParameter'
      - $ref: '#/parameters/EnvironmentDefinitionNameParameter'
      operationId: microsoftAzureEnvironmentsGetenvironmentdefinition
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/EnvironmentDefinition'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: devcenter.json#/definitions/CloudError
          headers:
            x-ms-error-code:
              description: The error code for specific error that occurred.
              type: string
      x-ms-examples:
        Environments_GetEnvironmentDefinition:
          $ref: ./examples/EnvironmentDefinitions_Get.json
      summary: Microsoft Azure Get Projects Projectname Catalogs Catalogname Environmentdefinitions Definitionname
definitions:
  EnvironmentDefinitionParameter:
    type: object
    description: Properties of an Environment Definition parameter
    properties:
      id:
        type: string
        description: Unique ID of the parameter
      name:
        type: string
        description: Display name of the parameter
      description:
        type: string
        description: Description of the parameter
      default:
        type: string
        description: Default value of the parameter
      type:
        description: A string of one of the basic JSON types (number, integer, array, object, boolean, string)
        $ref: '#/definitions/ParameterType'
      readOnly:
        type: boolean
        description: Whether or not this parameter is read-only.  If true, default should have a value.
      required:
        type: boolean
        description: Whether or not this parameter is required
      allowed:
        type: array
        items:
          type: string
        minItems: 1
        uniqueItems: true
        description: An array of allowed values
    required:
    - id
    - type
    - required
  EnvironmentDefinitionListResult:
    description: Results of the environment definition list operation.
    type: object
    properties:
      value:
        description: Current page of results.
        type: array
        items:
          $ref: '#/definitions/EnvironmentDefinition'
      nextLink:
        description: URL to get the next set of results if there are any.
        type: string
    required:
    - value
  EnvironmentDefinition:
    description: An environment definition.
    type: object
    properties:
      uri:
        description: The unique URI of the environment definition
        type: string
      id:
        description: The ID of the environment definition.
        type: string
      name:
        description: Name of the environment definition.
        type: string
      catalogName:
        description: Name of the catalog.
        type: string
      description:
        description: A short description of the environment definition.
        type: string
      parameters:
        type: array
        items:
          $ref: '#/definitions/EnvironmentDefinitionParameter'
        description: Input parameters passed to an environment.
      parametersSchema:
        type: string
        description: JSON schema defining the parameters object passed to an environment.
      templatePath:
        description: Path to the Environment Definition entrypoint file.
        type: string
    required:
    - name
    - uri
    - catalogName
    - id
  ParameterType:
    type: string
    enum:
    - array
    - boolean
    - integer
    - number
    - object
    - string
    description: The type of data a parameter accepts.
    x-ms-enum:
      name: ParameterType
      modelAsString: true
      values:
      - value: array
        description: The parameter accepts an array of values.
      - value: boolean
        description: The parameter accepts a boolean value.
      - value: integer
        description: The parameter accepts an integer value.
      - value: number
        description: The parameter accepts a number value.
      - value: object
        description: The parameter accepts an object value.
      - value: string
        description: The parameter accepts a string value.
parameters:
  CatalogNameParameter:
    name: catalogName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    minLength: 3
    maxLength: 63
    description: The name of the catalog
    x-ms-parameter-location: method
  EnvironmentDefinitionNameParameter:
    name: definitionName
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
    minLength: 3
    maxLength: 63
    description: The name of the environment definition
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'