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.

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

Update Swagger for Static Web Apps database connections #22159

Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
098cd1c
Update Swagger for Static Web Apps database connections
joslinmicrosoft Jan 11, 2023
f6b1ad6
Remove additional newline and comma
joslinmicrosoft Jan 12, 2023
49f2374
Fix up operationId for put / patch on build database connection
joslinmicrosoft Jan 12, 2023
84840f1
Update api-version in examples
joslinmicrosoft Jan 13, 2023
c7e4581
Run prettier
joslinmicrosoft Jan 13, 2023
25493ca
Add 200 status for delete operations
joslinmicrosoft Jan 13, 2023
c62dbc6
Use StaticSiteDatabaseConnectionOverviewARMResource instead of Static…
joslinmicrosoft Jan 13, 2023
6029de6
Remove StaticSite from operationId in suffix
joslinmicrosoft Jan 13, 2023
f08fd74
Fix StaticSiteDatabaseConnectionConfigurationFileOverview definition
joslinmicrosoft Jan 13, 2023
e41ce4c
Add pattern for environmentName and databaseConnectionName, and remov…
joslinmicrosoft Jan 13, 2023
c73d7d9
Add missing pattern and also add x-ms-identifiers for configurationFiles
joslinmicrosoft Jan 14, 2023
438737c
Update description for connectionIdentity
joslinmicrosoft Jan 15, 2023
657be2d
Simplify request and response entity names
joslinmicrosoft Jan 15, 2023
860ec37
Use shared parameter and reference for environmentName and databaseCo…
joslinmicrosoft Jan 15, 2023
a87e95b
Update x-ms-identifiers per comments
joslinmicrosoft Feb 1, 2023
8afcf1f
Add x-ms-secret, combine request and response objects to one with pro…
joslinmicrosoft Feb 1, 2023
634bb44
Run prettier
joslinmicrosoft Feb 1, 2023
8b3f7f4
Add required parameters and update ConnectionString -> connection string
joslinmicrosoft Feb 7, 2023
cc93912
Fix required properties for DatabaseConnection
joslinmicrosoft Feb 8, 2023
c4b7c54
Remove 'name' from DatabaseConnection and update static site object w…
joslinmicrosoft Feb 8, 2023
d73b434
Add x-ms-identifiers
joslinmicrosoft Feb 8, 2023
fe2b320
Remove connectionString as a required property
joslinmicrosoft Feb 16, 2023
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

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"databaseConnectionName": "default",
"api-version": "2022-09-01",
"databaseConnectionRequestEnvelope": {
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2"
}
}
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"databaseConnectionName": "default",
"api-version": "2022-09-01",
"databaseConnectionRequestEnvelope": {
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2"
}
}
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2",
"configurationFiles": [
{
"fileName": "staticwebapp.database.config.json",
"contents": "base64encodeddatabaseconfiguration",
"type": "configuration"
},
{
"fileName": "staticwebapp.database.schema.gql",
"contents": "base64encodeddatabasegraphqlschema",
"type": "graphqlschema"
}
]
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
],
"nextLink": null
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2",
"configurationFiles": [
{
"fileName": "staticwebapp.database.config.json",
"contents": "base64encodeddatabaseconfiguration",
"type": "configuration"
},
{
"fileName": "staticwebapp.database.schema.gql",
"contents": "base64encodeddatabasegraphqlschema",
"type": "graphqlschema"
}
]
}
}
],
"nextLink": null
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"databaseConnectionName": "default",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2",
"configurationFiles": [
{
"fileName": "staticwebapp.database.config.json",
"contents": "base64encodeddatabaseconfiguration",
"type": "configuration"
},
{
"fileName": "staticwebapp.database.schema.gql",
"contents": "base64encodeddatabasegraphqlschema",
"type": "graphqlschema"
}
]
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
],
"nextLink": null
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"api-version": "2022-09-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"connectionString": "AccountEndpoint=https://exampleDatabaseName.documents.azure.com:443/;Database=mydb;",
"region": "West US 2",
"configurationFiles": [
{
"fileName": "staticwebapp.database.config.json",
"contents": "base64encodeddatabaseconfiguration",
"type": "configuration"
},
{
"fileName": "staticwebapp.database.schema.gql",
"contents": "base64encodeddatabasegraphqlschema",
"type": "graphqlschema"
}
]
}
}
],
"nextLink": null
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"name": "testStaticSite0",
"environmentName": "default",
"databaseConnectionName": "default",
"api-version": "2022-09-01",
"databaseConnectionRequestEnvelope": {
"properties": {}
}
},
"responses": {
"200": {
"headers": {},
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/databaseConnections/default",
"name": "default",
"type": "Microsoft.Web/staticSites/builds/databaseConnections",
"properties": {
"resourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/databaseRG/providers/Microsoft.DocumentDB/databaseAccounts/exampleDatabaseName",
"connectionIdentity": "SystemAssigned",
"region": "West US 2"
}
}
}
}
}
Loading