Radius Application Platform API

openapi: 3.1.0
info:
  title: Application Research Radius API
  description: |
    OpenAPI 3.1 specification for Radius - a cloud-native application platform that enables 
    developers to define, deploy, and collaborate on cloud-native applications across public 
    clouds and private infrastructure.
  version: 2023-10-01-preview
  contact:
    name: Radius Project
    url: https://radapp.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0

servers:
  - url: https://management.radapp.io
    description: Radius Management API
  - url: http://localhost:8080
    description: Local Development

tags:
  - name: Applications
    description: Application resource operations
  - name: Containers
    description: Container resource operations
  - name: Credentials
    description: Credential management operations

  - name: Dapr
    description: Dapr component operations
  - name: Datastores
    description: Datastore portable resource operations
  - name: Environments
    description: Environment resource operations
  - name: Extenders
    description: Extender portable resource operations
  - name: Gateways
    description: Gateway resource operations
  - name: Messaging
    description: Messaging portable resource operations
  - name: Planes
    description: Plane management operations
  - name: ResourceGroups
    description: Resource group operations
  - name: SecretStores
    description: Secret store operations
  - name: Volumes
    description: Volume resource operations
paths:
  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/applications:
    get:
      tags: [Applications]
      summary: Application Research List applications
      operationId: Applications_List
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResourceListResult'
              examples:
                applicationList:
                  $ref: '#/components/examples/ApplicationListExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/applications/{applicationName}:
    get:
      tags: [Applications]
      summary: Application Research Get application
      operationId: Applications_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApplicationNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResource'
              examples:
                ecommerceApplication:
                  $ref: '#/components/examples/EcommerceApplicationExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags: [Applications]
      summary: Application Research Create or update application
      operationId: Applications_CreateOrUpdate
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApplicationNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationResource'
            examples:
              ecommerceApplication:
                $ref: '#/components/examples/EcommerceApplicationExample'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResource'
        default:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags: [Applications]
      summary: Application Research Delete application
      operationId: Applications_Delete
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApplicationNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
        '204':
          description: No Content
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/environments:
    get:
      tags: [Environments]
      summary: Application Research List environments
      operationId: Environments_List
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentResourceListResult'
              examples:
                environmentList:
                  $ref: '#/components/examples/EnvironmentListExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/environments/{environmentName}:
    get:
      tags: [Environments]
      summary: Application Research Get environment
      operationId: Environments_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/EnvironmentNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentResource'
              examples:
                kubernetesEnvironment:
                  $ref: '#/components/examples/KubernetesEnvironmentExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags: [Environments]
      summary: Application Research Create or update environment
      operationId: Environments_CreateOrUpdate
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/EnvironmentNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentResource'
            examples:
              kubernetesEnvironment:
                $ref: '#/components/examples/KubernetesEnvironmentExample'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentResource'
        default:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags: [Environments]
      summary: Application Research Delete environment
      operationId: Environments_Delete
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/EnvironmentNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
        '204':
          description: No Content
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/containers:
    get:
      tags: [Containers]
      summary: Application Research List containers
      operationId: Containers_List
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerResourceListResult'
              examples:
                containerList:
                  $ref: '#/components/examples/ContainerListExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/containers/{containerName}:
    get:
      tags: [Containers]
      summary: Application Research Get container
      operationId: Containers_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ContainerNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerResource'
              examples:
                orderServiceContainer:
                  $ref: '#/components/examples/OrderServiceContainerExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags: [Containers]
      summary: Application Research Create or update container
      operationId: Containers_CreateOrUpdate
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ContainerNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerResource'
            examples:
              orderServiceContainer:
                $ref: '#/components/examples/OrderServiceContainerExample'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerResource'
        default:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags: [Containers]
      summary: Application Research Delete container
      operationId: Containers_Delete
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ContainerNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
        '204':
          description: No Content
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/gateways/{gatewayName}:
    get:
      tags: [Gateways]
      summary: Application Research Get gateway
      operationId: Gateways_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/GatewayNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResource'
              examples:
                ecommerceGateway:
                  $ref: '#/components/examples/EcommerceGatewayExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags: [Gateways]
      summary: Application Research Create or update gateway
      operationId: Gateways_CreateOrUpdate
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/GatewayNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayResource'
            examples:
              ecommerceGateway:
                $ref: '#/components/examples/EcommerceGatewayExample'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResource'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/secretStores/{secretStoreName}:
    get:
      tags: [SecretStores]
      summary: Application Research Get secret store
      operationId: SecretStores_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/SecretStoreNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretStoreResource'
              examples:
                genericSecretStore:
                  $ref: '#/components/examples/GenericSecretStoreExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags: [SecretStores]
      summary: Application Research Create or update secret store
      operationId: SecretStores_CreateOrUpdate
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/SecretStoreNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretStoreResource'
            examples:
              genericSecretStore:
                $ref: '#/components/examples/GenericSecretStoreExample'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretStoreResource'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretStoreResource'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/volumes/{volumeName}:
    get:
      tags: [Volumes]
      summary: Application Research Get volume
      operationId: Volumes_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/VolumeNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResource'
              examples:
                azureKeyVaultVolume:
                  $ref: '#/components/examples/AzureKeyVaultVolumeExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Core/extenders/{extenderName}:
    get:
      tags: [Extenders]
      summary: Application Research Get extender
      operationId: Extenders_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ExtenderNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtenderResource'
              examples:
                stripeExtender:
                  $ref: '#/components/examples/StripeExtenderExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Datastores/mongoDatabases/{mongoDatabaseName}
  : get:
      tags: [Datastores]
      summary: Application Research Get MongoDB database
      operationId: MongoDatabases_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/MongoDatabaseNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MongoDatabaseResource'
              examples:
                ordersDatabase:
                  $ref: '#/components/examples/OrdersMongoDatabaseExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Datastores/redisCaches/{redisCacheName}
  : get:
      tags: [Datastores]
      summary: Application Research Get Redis cache
      operationId: RedisCaches_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/RedisCacheNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedisCacheResource'
              examples:
                sessionCache:
                  $ref: '#/components/examples/SessionCacheExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Datastores/sqlDatabases/{sqlDatabaseName}
  : get:
      tags: [Datastores]
      summary: Application Research Get SQL database
      operationId: SqlDatabases_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/SqlDatabaseNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDatabaseResource'
              examples:
                buildMetadataDatabase:
                  $ref: '#/components/examples/BuildMetadataSqlDatabaseExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Messaging/rabbitMQQueues/{rabbitMQQueueName}
  : get:
      tags: [Messaging]
      summary: Application Research Get RabbitMQ queue
      operationId: RabbitMQQueues_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/RabbitMQQueueNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RabbitMQQueueResource'
              examples:
                orderEventsQueue:
                  $ref: '#/components/examples/OrderEventsQueueExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Dapr/stateStores/{stateStoreName}:
    get:
      tags: [Dapr]
      summary: Application Research Get Dapr state store
      operationId: DaprStateStores_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/StateStoreNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DaprStateStoreResource'
              examples:
                redisStateStore:
                  $ref: '#/components/examples/RedisStateStoreExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Dapr/pubSubBrokers/{pubSubBrokerName}:
    get:
      tags: [Dapr]
      summary: Application Research Get Dapr pub/sub broker
      operationId: DaprPubSubBrokers_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/PubSubBrokerNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DaprPubSubBrokerResource'
              examples:
                rabbitMQPubSub:
                  $ref: '#/components/examples/RabbitMQPubSubExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Dapr/secretStores/{daprSecretStoreName}
  : get:
      tags: [Dapr]
      summary: Application Research Get Dapr secret store
      operationId: DaprSecretStores_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/DaprSecretStoreNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DaprSecretStoreResource'
              examples:
                keyVaultSecretStore:
                  $ref: '#/components/examples/KeyVaultSecretStoreExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  ? /planes/radius/{planeName}/resourceGroups/{resourceGroupName}/providers/Applications.Dapr/configurationStores/{configurationStoreName}
  : get:
      tags: [Dapr]
      summary: Application Research Get Dapr configuration store
      operationId: DaprConfigurationStores_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ConfigurationStoreNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DaprConfigurationStoreResource'
              examples:
                appConfigStore:
                  $ref: '#/components/examples/AppConfigConfigurationStoreExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}:
    get:
      tags: [Planes]
      summary: Application Research Get Radius plane
      operationId: RadiusPlanes_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadiusPlaneResource'
              examples:
                radiusPlane:
                  $ref: '#/components/examples/RadiusPlaneExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/radius/{planeName}/resourceGroups/{resourceGroupName}:
    get:
      tags: [ResourceGroups]
      summary: Application Research Get resource group
      operationId: ResourceGroups_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/ResourceGroupNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceGroupResource'
              examples:
                resourceGroup:
                  $ref: '#/components/examples/ResourceGroupExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/azure/{planeName}/providers/System.Azure/credentials/{credentialName}:
    get:
      tags: [Credentials]
      summary: Application Research Get Azure credential
      operationId: AzureCredentials_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureCredentialResource'
              examples:
                workloadIdentityCredential:
                  $ref: '#/components/examples/AzureWorkloadIdentityCredentialExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

  /planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}:
    get:
      tags: [Credentials]
      summary: Application Research Get AWS credential
      operationId: AwsCredentials_Get
      parameters:
        - $ref: '#/components/parameters/PlaneNameParameter'
        - $ref: '#/components/parameters/CredentialNameParameter'
        - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsCredentialResource'
              examples:
                irsaCredential:
                  $ref: '#/components/examples/AwsIrsaCredentialExample'
        default:
          $ref: '#/components/responses/ErrorResponse'

components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation
      schema:
        type: string
        default: '2023-10-01-preview'

    PlaneNameParameter:
      name: planeName
      in: path
      required: true
      description: The name of the plane
      schema:
        type: string
        pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$
        maxLength: 63

    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group
      schema:
        type: string
        pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$
        maxLength: 63

    ApplicationNameParameter:
      name: applicationName
      in: path
      required: true
      description: The name of the application
      schema:
        type: string

    EnvironmentNameParameter:
      name: environmentName
      in: path
      required: true
      description: The name of the environment
      schema:
        type: string

    ContainerNameParameter:
      name: containerName
      in: path
      required: true
      description: The name of the container
      schema:
        type: string

    GatewayNameParameter:
      name: gatewayName
      in: path
      required: true
      description: The name of the gateway
      schema:
        type: string

    SecretStoreNameParameter:
      name: secretStoreName
      in: path
      required: true
      description: The name of the secret store
      schema:
        type: string

    VolumeNameParameter:
      name: volumeName
      in: path
      required: true
      description: The name of the volume
      schema:
        type: string

    ExtenderNameParameter:
      name: extenderName
      in: path
      required: true
      description: The name of the extender
      schema:
        type: string

    MongoDatabaseNameParameter:
      name: mongoDatabaseName
      in: path
      required: true
      description: The name of the MongoDB database
      schema:
        type: string

    RedisCacheNameParameter:
      name: redisCacheName
      in: path
      required: true
      description: The name of the Redis cache
      schema:
        type: string

    SqlDatabaseNameParameter:
      name: sqlDatabaseName
      in: path
      required: true
      description: The name of the SQL database
      schema:
        type: string

    RabbitMQQueueNameParameter:
      name: rabbitMQQueueName
      in: path
      required: true
      description: The name of the RabbitMQ queue
      schema:
        type: string

    StateStoreNameParameter:
      name: stateStoreName
      in: path
      required: true
      description: The name of the Dapr state store
      schema:
        type: string

    PubSubBrokerNameParameter:
      name: pubSubBrokerName
      in: path
      required: true
      description: The name of the Dapr pub/sub broker
      schema:
        type: string

    DaprSecretStoreNameParameter:
      name: daprSecretStoreName
      in: path
      required: true
      description: The name of the Dapr secret store
      schema:
        type: string

    ConfigurationStoreNameParameter:
      name: configurationStoreName
      in: path
      required: true
      description: The name of the Dapr configuration store
      schema:
        type: string

    CredentialNameParameter:
      name: credentialName
      in: path
      required: true
      description: The name of the credential
      schema:
        type: string

  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                   

# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/application-research/refs/heads/main/openapi/radius-openapi.yml