Skip to content

Commit

Permalink
Introduce CosmosDB RP API 2024-09-01-preview Version (Azure#29906)
Browse files Browse the repository at this point in the history
* Copy files from preview/2024-05-15-preview

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2024-09-01-preview

Updated the API version from preview/2024-05-15-preview to preview/2024-09-01-preview.

* Added tag for 2024-09-01-preview in readme file

* run npx prettier

* run npx prettier

* run npx prettier

* add the v7 to the swagger (Azure#29977)

* Update dataTransferService.json (Azure#29994)

* CosmosDB: Add chaos fault API in cosmosDB RP (Azure#29984)

* Changes for Chaos Fault RP API.

* Adding readme changes.

* fixing thePR validation error.

* Fixing spelling.

* Fixing the model.

* fixing the build issue.

* Fixing lintDiff.

* fixing lintdiff.

* changing the method in api.

* reveting the response,

* Reverting the rest api call method.

* updating the swagger changes,

* Swagger fix,

* more changes.

* Maxing suggested swagger changes.

* Fix Swagger validation changes.

* Fix lint diff.

* spelling mismatch.

* typo

* commit.

* Swagger fix.

* fixing name,

* Adding an all_of.

* adding api to cosmosdb.json

* Fixing the model.

* adding all changes to cosmos-db

* fix the response.

* removing the readme references.

* Adding a next

* fixing the response.

* adding all of.

* fixing the lint diff error.

* fxing the response

* removing value,

* fixing model.

* adding more items in list reponse.

* fixing api endpoint,

* endpoint update.

* Revert "endpoint update."

This reverts commit 868fef5.

* reverting emaple files endpoint.

* fixing breaking chnages.

* types.json from v5-v1.

* Updating list example.

* moving all changes to chaosfault.jspn

* fxing the allof error.

* fix minor issue

* removing default.

* Revert "removing default."

This reverts commit 41149a2.

* Fixing lint diff.

* reverting changes.

* addig missing property

* Making supression rule.

* Adding another supression.

* Adding Next link property. (Azure#30190)

* Removing supression and adding nextlink property.

* Add readme changes.

* fixing the json.

---------

Co-authored-by: Andrew Khoma <[email protected]>
Co-authored-by: sarwesh <[email protected]>
Co-authored-by: soagar <[email protected]>
  • Loading branch information
4 people authored and Jaskirat Singh committed Sep 16, 2024
1 parent 0a14093 commit 18eab7c
Show file tree
Hide file tree
Showing 271 changed files with 32,466 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,266 @@
{
"swagger": "2.0",
"info": {
"title": "Cosmos DB",
"description": "Azure Cosmos DB Chaos Fault REST API",
"version": "2024-09-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "Impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults": {
"get": {
"operationId": "ChaosFault_List",
"description": "List Chaos Faults for CosmosDB account.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"ChaosFaultList": {
"$ref": "./examples/ChaosFaultList.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "cosmos-db.json#/parameters/accountNameParameter"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/chaosFaultListResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}": {
"put": {
"operationId": "ChaosFault_EnableDisable",
"description": "Enable, disable Chaos Fault in a CosmosDB account.",
"x-ms-examples": {
"ChaosFaultEnableDisable": {
"$ref": "./examples/ChaosFaultEnableDisable.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "cosmos-db.json#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/chaosFault"
},
{
"name": "chaosFaultRequest",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/chaosFaultResource"
},
"description": "A request object to enable/disable the chaos fault."
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/chaosFaultResource"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/chaosFaultResource"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"operationId": "ChaosFault_Get",
"description": "Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.",
"x-ms-examples": {
"ChaosFaultGet": {
"$ref": "./examples/ChaosFaultGet.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "cosmos-db.json#/parameters/accountNameParameter"
},
{
"$ref": "#/parameters/chaosFault"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/chaosFaultResource"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"ProvisioningState": {
"readOnly": true,
"description": "The provisioning state of the resource.",
"type": "string"
},
"chaosFaultResource": {
"description": "A request object to enable/disable the chaos fault",
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/chaosFaultProperties"
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"chaosFaultProperties": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"Enable",
"Disable"
],
"description": "Indicates whether what action to take for the Chaos Fault.",
"x-ms-enum": {
"name": "SupportedActions",
"modelAsString": false
}
},
"region": {
"type": "string",
"description": "Region of the account where the Chaos Fault is to be enabled/disabled."
},
"databaseName": {
"type": "string",
"description": "Database name."
},
"containerName": {
"type": "string",
"description": "Container name."
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "A provisioning state of the Chaos Fault."
}
},
"description": "A request object to enable/disable the chaos fault."
},
"chaosFaultListResponse": {
"type": "object",
"properties": {
"value": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/chaosFaultResource"
},
"description": "List of Chaos Faults."
},
"nextLink": {
"description": "The link used to get the next page of results.",
"type": "string",
"readOnly": true
}
},
"description": "Chaos Fault List Response."
}
},
"parameters": {
"chaosFault": {
"name": "chaosFault",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the ChaosFault.",
"x-ms-parameter-location": "method"
}
}
}
Loading

0 comments on commit 18eab7c

Please sign in to comment.