Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

containerapps: fixing inconsistencies in the swagger #18660

Closed
wants to merge 5 commits into from
Closed

containerapps: fixing inconsistencies in the swagger #18660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
553fc55
contianerapps: fixing swagger inconsistencies in 2022-01-01-preview
tombuildsstuff Apr 12, 2022
288baf2
containerapps: fixing inconsistencies in the 2022-03-01 swagger
tombuildsstuff Apr 12, 2022
9b81fbd
containerapps: updating the examples for 2022-01-01-preview
tombuildsstuff Apr 12, 2022
f9c1f1f
containerapps: updating the examples to account for the updated param…
tombuildsstuff Apr 12, 2022
3c4872f
containerapps: fixing linting
tombuildsstuff Apr 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...fication/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/ContainerApps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,8 +427,8 @@
"activeRevisionsMode": {
"description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n<list><item>Multiple: multiple revisions can be active. If no value if provided, this is the default</item><item>Single: Only one revision can be active at a time. Revision weights can not be used in this mode</item></list>",
"enum": [
"multiple",
"single"
"Multiple",
"Single"
Comment on lines +430 to +431
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in this case, the API returns these in TitleCase:

{
    "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/stedev-ca-regtest/providers/Microsoft.App/containerApps/stedev-ca-regtest",
    "name": "stedev-ca-regtest",
    "type": "Microsoft.App/containerApps",
    "location": "West Europe",
    "systemData": {
        "createdBy": "XXX",
        "createdByType": "User",
        "createdAt": "2022-04-08T10:38:17.4255847",
        "lastModifiedBy": "XXX",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2022-04-08T10:38:17.4255847"
    },
    "properties": {
        "provisioningState": "Succeeded",
        "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/stedev-ca-regtest/providers/Microsoft.App/managedenvironments/stedev-ca-regtest",
        "outboundIpAddresses": [
            "20.31.240.94",
            "20.31.240.109",
            "20.31.240.114"
        ],
        "latestRevisionName": "stedev-ca-regtest--bkb6i1h",
        "latestRevisionFqdn": "stedev-ca-regtest--bkb6i1h.ashycoast-1ca0508f.westeurope.azurecontainerapps.io",
        "customDomainVerificationId": "XXXXXXX",
        "configuration": {
            "activeRevisionsMode": "Single",
            "ingress": {
                "fqdn": "stedev-ca-regtest.ashycoast-1ca0508f.westeurope.azurecontainerapps.io",
                "external": true,
                "targetPort": 80,
                "transport": "Auto",
                "traffic": [
                    {
                        "weight": 100,
                        "latestRevision": true
                    }
                ],
                "allowInsecure": false
            },
            "registries": []
        },
        "template": {
            "containers": [
                {
                    "image": "mcr.microsoft.com/azuredocs/containerapps-helloworld:latest",
                    "name": "simple-hello-world-container",
                    "command": [],
                    "resources": {
                        "cpu": 0.25,
                        "memory": "0.5Gi"
                    }
                }
            ],
            "scale": {
                "maxReplicas": 10
            }
        }
    },
    "identity": {
        "type": "None"
    }
}

],
"type": "string",
"x-ms-enum": {
Expand Down
20 changes: 10 additions & 10 deletions ...app/resource-manager/Microsoft.App/preview/2022-01-01-preview/ContainerAppsRevisions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}": {
"get": {
"tags": [
"ContainerAppsRevisions"
Expand All @@ -86,7 +86,7 @@
"type": "string"
},
{
"name": "name",
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
Expand Down Expand Up @@ -117,7 +117,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/activate": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/activate": {
"post": {
"tags": [
"ContainerAppsRevisions"
Expand All @@ -139,7 +139,7 @@
"type": "string"
},
{
"name": "name",
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
Expand Down Expand Up @@ -167,7 +167,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/deactivate": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/deactivate": {
"post": {
"tags": [
"ContainerAppsRevisions"
Expand All @@ -189,7 +189,7 @@
"type": "string"
},
{
"name": "name",
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
Expand Down Expand Up @@ -217,7 +217,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}": {
"get": {
"tags": [
"ContainerAppsRevisionReplicas"
Expand Down Expand Up @@ -246,7 +246,7 @@
"type": "string"
},
{
"name": "name",
"name": "replicaName",
"in": "path",
"description": "Name of the Container App Revision Replica.",
"required": true,
Expand Down Expand Up @@ -330,7 +330,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{name}/restart": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/restart": {
"post": {
"tags": [
"ContainerAppsRevisions"
Expand All @@ -352,7 +352,7 @@
"type": "string"
},
{
"name": "name",
"name": "revisionName",
"in": "path",
"description": "Name of the Container App Revision.",
"required": true,
Expand Down
8 changes: 4 additions & 4 deletions ...ication/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/DaprComponents.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}": {
"get": {
"tags": [
"DaprComponents"
Expand All @@ -86,7 +86,7 @@
"type": "string"
},
{
"name": "name",
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
Expand Down Expand Up @@ -138,7 +138,7 @@
"type": "string"
},
{
"name": "name",
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
Expand Down Expand Up @@ -200,7 +200,7 @@
"type": "string"
},
{
"name": "name",
"name": "componentName",
"in": "path",
"description": "Name of the Dapr Component.",
"required": true,
Expand Down
32 changes: 16 additions & 16 deletions ...on/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/ManagedEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}": {
"get": {
"tags": [
"ManagedEnvironments"
Expand All @@ -114,7 +114,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
Expand Down Expand Up @@ -159,7 +159,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
Expand Down Expand Up @@ -220,7 +220,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
Expand Down Expand Up @@ -269,7 +269,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
Expand Down Expand Up @@ -309,7 +309,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates": {
"get": {
"tags": [
"ManagedEnvironments",
Expand All @@ -325,7 +325,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "managedEnvironmentName",
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
Expand Down Expand Up @@ -359,7 +359,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}/certificates/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}": {
"get": {
"tags": [
"ManagedEnvironments",
Expand All @@ -375,14 +375,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "managedEnvironmentName",
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
Expand Down Expand Up @@ -427,14 +427,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "managedEnvironmentName",
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
Expand Down Expand Up @@ -487,14 +487,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "managedEnvironmentName",
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
Expand Down Expand Up @@ -540,14 +540,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "managedEnvironmentName",
"name": "environmentName",
"in": "path",
"description": "Name of the Managed Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "certificateName",
"in": "path",
"description": "Name of the Certificate.",
"required": true,
Expand Down
18 changes: 9 additions & 9 deletions ...esource-manager/Microsoft.App/preview/2022-01-01-preview/ManagedEnvironmentsStorages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages": {
"get": {
"tags": [
"ManagedEnvironmentsStorages"
Expand All @@ -31,7 +31,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "envName",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
Expand Down Expand Up @@ -62,7 +62,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{envName}/storages/{name}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}": {
"get": {
"tags": [
"ManagedEnvironmentsStorages"
Expand All @@ -78,14 +78,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "envName",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
Expand Down Expand Up @@ -130,14 +130,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "envName",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
Expand Down Expand Up @@ -191,14 +191,14 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "envName",
"name": "environmentName",
"in": "path",
"description": "Name of the Environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"name": "storageName",
"in": "path",
"description": "Name of the storage.",
"required": true,
Expand Down
4 changes: 2 additions & 2 deletions ...manager/Microsoft.App/preview/2022-01-01-preview/examples/Certificate_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "examplerg",
"managedEnvironmentName": "testcontainerenv",
"name": "certificate-firendly-name",
"environmentName": "testcontainerenv",
"certificateName": "certificate-firendly-name",
"api-version": "2022-01-01-preview",
"certificateEnvelope": {
"location": "East US",
Expand Down
4 changes: 2 additions & 2 deletions ...esource-manager/Microsoft.App/preview/2022-01-01-preview/examples/Certificate_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "examplerg",
"managedEnvironmentName": "testcontainerenv",
"name": "certificate-firendly-name",
"environmentName": "testcontainerenv",
"certificateName": "certificate-firendly-name",
"api-version": "2022-01-01-preview"
},
"responses": {
Expand Down
4 changes: 2 additions & 2 deletions ...p/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/Certificate_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "examplerg",
"managedEnvironmentName": "testcontainerenv",
"name": "certificate-firendly-name",
"environmentName": "testcontainerenv",
"certificateName": "certificate-firendly-name",
"api-version": "2022-01-01-preview"
},
"responses": {
Expand Down
2 changes: 1 addition & 1 deletion ...rosoft.App/preview/2022-01-01-preview/examples/Certificates_ListByManagedEnvironment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "examplerg",
"managedEnvironmentName": "testcontainerenv",
"environmentName": "testcontainerenv",
"api-version": "2022-01-01-preview"
},
"responses": {
Expand Down
Loading