diff --git a/packages/samples/common-types/openapi/v3/types.json b/packages/samples/common-types/openapi/v3/types.json index 67b02967ad..59ebc73c23 100644 --- a/packages/samples/common-types/openapi/v3/types.json +++ b/packages/samples/common-types/openapi/v3/types.json @@ -96,8 +96,23 @@ } } }, + "EncryptionProperties": { + "type": "object", + "description": "Configuration of key for data encryption", + "properties": { + "status": { + "$ref": "#/definitions/EncryptionStatus", + "description": "Indicates whether or not the encryption is enabled for container registry." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, "EncryptionStatus": { "type": "string", + "description": "Indicates whether or not the encryption is enabled for container registry.", "enum": [ "enabled", "disabled" @@ -108,11 +123,13 @@ "values": [ { "name": "enabled", - "value": "enabled" + "value": "enabled", + "description": "Encryption is enabled." }, { "name": "disabled", - "value": "disabled" + "value": "disabled", + "description": "Encryption is disabled." } ] } @@ -227,6 +244,46 @@ } } }, + "LocationData": { + "type": "object", + "description": "Metadata pertaining to the geographic location of the resource.", + "properties": { + "name": { + "type": "string", + "description": "A canonical name for the geographic or physical location.", + "maxLength": 256 + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "LocationResourceParameter": { + "type": "object", + "description": "The default location parameter type.", + "properties": { + "location": { + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1 + } + }, + "required": [ + "location" + ] + }, "Operation": { "type": "object", "description": "Details of a REST API operation, returned from the Resource Provider Operations API", @@ -252,8 +309,7 @@ }, "actionType": { "$ref": "#/definitions/ActionType", - "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", - "readOnly": true + "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs." } } }, @@ -468,7 +524,11 @@ "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.\nIf supported, the resource provider must validate and persist this value.", - "pattern": "^[-\\w\\._,\\(\\)]+$" + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] }, "eTag": { "type": "string", @@ -563,35 +623,29 @@ "properties": { "createdBy": { "type": "string", - "description": "The identity that created the resource.", - "readOnly": true + "description": "The identity that created the resource." }, "createdByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that created the resource.", - "readOnly": true + "description": "The type of identity that created the resource." }, "createdAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource creation (UTC).", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." }, "lastModifiedBy": { "type": "string", - "description": "The identity that last modified the resource.", - "readOnly": true + "description": "The identity that last modified the resource." }, "lastModifiedByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that last modified the resource.", - "readOnly": true + "description": "The type of identity that last modified the resource." }, "lastModifiedAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource last modification (UTC)", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" } } }, @@ -659,46 +713,6 @@ } ] } - }, - "encryptionProperties": { - "type": "object", - "description": "Configuration of key for data encryption", - "properties": { - "status": { - "$ref": "#/definitions/EncryptionStatus", - "description": "Indicates whether or not the encryption is enabled for container registry." - }, - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Key vault properties." - } - } - }, - "locationData": { - "type": "object", - "description": "Metadata pertaining to the geographic location of the resource.", - "properties": { - "name": { - "type": "string", - "description": "A canonical name for the geographic or physical location.", - "maxLength": 256 - }, - "city": { - "type": "string", - "description": "The city or locality where the resource is located." - }, - "district": { - "type": "string", - "description": "The district, state, or province where the resource is located." - }, - "countryOrRegion": { - "type": "string", - "description": "The country or region where the resource is located" - } - }, - "required": [ - "name" - ] } }, "parameters": { @@ -744,7 +758,7 @@ "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", - "description": "The ID of the target subscription. The value must be an UUID.", + "description": "The ID of the target subscription. The value must be an UUID.", "required": true, "type": "string", "x-ms-parameter-location": "client" diff --git a/packages/samples/common-types/openapi/v4/types.json b/packages/samples/common-types/openapi/v4/types.json index b849c6ced6..4fe6503fb0 100644 --- a/packages/samples/common-types/openapi/v4/types.json +++ b/packages/samples/common-types/openapi/v4/types.json @@ -96,8 +96,23 @@ } } }, + "EncryptionProperties": { + "type": "object", + "description": "Configuration of key for data encryption", + "properties": { + "status": { + "$ref": "#/definitions/EncryptionStatus", + "description": "Indicates whether or not the encryption is enabled for container registry." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, "EncryptionStatus": { "type": "string", + "description": "Indicates whether or not the encryption is enabled for container registry.", "enum": [ "enabled", "disabled" @@ -108,11 +123,13 @@ "values": [ { "name": "enabled", - "value": "enabled" + "value": "enabled", + "description": "Encryption is enabled." }, { "name": "disabled", - "value": "disabled" + "value": "disabled", + "description": "Encryption is disabled." } ] } @@ -237,6 +254,46 @@ } } }, + "LocationData": { + "type": "object", + "description": "Metadata pertaining to the geographic location of the resource.", + "properties": { + "name": { + "type": "string", + "description": "A canonical name for the geographic or physical location.", + "maxLength": 256 + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "LocationResourceParameter": { + "type": "object", + "description": "The default location parameter type.", + "properties": { + "location": { + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1 + } + }, + "required": [ + "location" + ] + }, "Operation": { "type": "object", "description": "Details of a REST API operation, returned from the Resource Provider Operations API", @@ -262,8 +319,7 @@ }, "actionType": { "$ref": "#/definitions/ActionType", - "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", - "readOnly": true + "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs." } } }, @@ -479,7 +535,11 @@ "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.\nIf supported, the resource provider must validate and persist this value.", - "pattern": "^[-\\w\\._,\\(\\)]+$" + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] }, "eTag": { "type": "string", @@ -574,35 +634,29 @@ "properties": { "createdBy": { "type": "string", - "description": "The identity that created the resource.", - "readOnly": true + "description": "The identity that created the resource." }, "createdByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that created the resource.", - "readOnly": true + "description": "The type of identity that created the resource." }, "createdAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource creation (UTC).", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." }, "lastModifiedBy": { "type": "string", - "description": "The identity that last modified the resource.", - "readOnly": true + "description": "The identity that last modified the resource." }, "lastModifiedByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that last modified the resource.", - "readOnly": true + "description": "The type of identity that last modified the resource." }, "lastModifiedAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource last modification (UTC)", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" } } }, @@ -670,46 +724,6 @@ } ] } - }, - "encryptionProperties": { - "type": "object", - "description": "Configuration of key for data encryption", - "properties": { - "status": { - "$ref": "#/definitions/EncryptionStatus", - "description": "Indicates whether or not the encryption is enabled for container registry." - }, - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Key vault properties." - } - } - }, - "locationData": { - "type": "object", - "description": "Metadata pertaining to the geographic location of the resource.", - "properties": { - "name": { - "type": "string", - "description": "A canonical name for the geographic or physical location.", - "maxLength": 256 - }, - "city": { - "type": "string", - "description": "The city or locality where the resource is located." - }, - "district": { - "type": "string", - "description": "The district, state, or province where the resource is located." - }, - "countryOrRegion": { - "type": "string", - "description": "The country or region where the resource is located" - } - }, - "required": [ - "name" - ] } }, "parameters": { @@ -775,7 +789,7 @@ "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", - "description": "The ID of the target subscription. The value must be an UUID.", + "description": "The ID of the target subscription. The value must be an UUID.", "required": true, "type": "string", "format": "uuid", diff --git a/packages/samples/common-types/openapi/v5/types.json b/packages/samples/common-types/openapi/v5/types.json index 56edf6eb39..9107b311f5 100644 --- a/packages/samples/common-types/openapi/v5/types.json +++ b/packages/samples/common-types/openapi/v5/types.json @@ -96,8 +96,23 @@ } } }, + "EncryptionProperties": { + "type": "object", + "description": "Configuration of key for data encryption", + "properties": { + "status": { + "$ref": "#/definitions/EncryptionStatus", + "description": "Indicates whether or not the encryption is enabled for container registry." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, "EncryptionStatus": { "type": "string", + "description": "Indicates whether or not the encryption is enabled for container registry.", "enum": [ "enabled", "disabled" @@ -108,11 +123,13 @@ "values": [ { "name": "enabled", - "value": "enabled" + "value": "enabled", + "description": "Encryption is enabled." }, { "name": "disabled", - "value": "disabled" + "value": "disabled", + "description": "Encryption is disabled." } ] } @@ -237,6 +254,46 @@ } } }, + "LocationData": { + "type": "object", + "description": "Metadata pertaining to the geographic location of the resource.", + "properties": { + "name": { + "type": "string", + "description": "A canonical name for the geographic or physical location.", + "maxLength": 256 + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "LocationResourceParameter": { + "type": "object", + "description": "The default location parameter type.", + "properties": { + "location": { + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1 + } + }, + "required": [ + "location" + ] + }, "Operation": { "type": "object", "description": "Details of a REST API operation, returned from the Resource Provider Operations API", @@ -262,8 +319,7 @@ }, "actionType": { "$ref": "#/definitions/ActionType", - "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", - "readOnly": true + "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs." } } }, @@ -479,7 +535,11 @@ "kind": { "type": "string", "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.\nIf supported, the resource provider must validate and persist this value.", - "pattern": "^[-\\w\\._,\\(\\)]+$" + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] }, "eTag": { "type": "string", @@ -574,35 +634,29 @@ "properties": { "createdBy": { "type": "string", - "description": "The identity that created the resource.", - "readOnly": true + "description": "The identity that created the resource." }, "createdByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that created the resource.", - "readOnly": true + "description": "The type of identity that created the resource." }, "createdAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource creation (UTC).", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." }, "lastModifiedBy": { "type": "string", - "description": "The identity that last modified the resource.", - "readOnly": true + "description": "The identity that last modified the resource." }, "lastModifiedByType": { "$ref": "#/definitions/createdByType", - "description": "The type of identity that last modified the resource.", - "readOnly": true + "description": "The type of identity that last modified the resource." }, "lastModifiedAt": { "type": "string", - "format": "date", - "description": "The timestamp of resource last modification (UTC)", - "readOnly": true + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" } } }, @@ -670,46 +724,6 @@ } ] } - }, - "encryptionProperties": { - "type": "object", - "description": "Configuration of key for data encryption", - "properties": { - "status": { - "$ref": "#/definitions/EncryptionStatus", - "description": "Indicates whether or not the encryption is enabled for container registry." - }, - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Key vault properties." - } - } - }, - "locationData": { - "type": "object", - "description": "Metadata pertaining to the geographic location of the resource.", - "properties": { - "name": { - "type": "string", - "description": "A canonical name for the geographic or physical location.", - "maxLength": 256 - }, - "city": { - "type": "string", - "description": "The city or locality where the resource is located." - }, - "district": { - "type": "string", - "description": "The district, state, or province where the resource is located." - }, - "countryOrRegion": { - "type": "string", - "description": "The country or region where the resource is located" - } - }, - "required": [ - "name" - ] } }, "parameters": { @@ -775,7 +789,7 @@ "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", - "description": "The ID of the target subscription. The value must be an UUID.", + "description": "The ID of the target subscription. The value must be an UUID.", "required": true, "type": "string", "format": "uuid",