From 4732a296cf112db7575c6e14a5aeeed6834b2956 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Thu, 21 Nov 2024 15:44:13 +0800 Subject: [PATCH 01/16] refactor(generator): split `description` into `sumary` and doc` - update input types to replace `description` with `summary` and `doc` - update json converters for the emitter schema change - update test cases accordingly resolve #4771 --- package-lock.json | 28 +- samples/AnomalyDetector/tspCodeModel.json | 354 +++++------ .../Common/Input/CodeModelConverter.cs | 25 +- .../Common/Input/InputTypes/InputClient.cs | 5 +- .../Common/Input/InputTypes/InputEnumType.cs | 7 +- .../InputTypes/InputEnumTypeFloatValue.cs | 2 +- .../InputTypes/InputEnumTypeIntegerValue.cs | 2 +- .../InputTypes/InputEnumTypeStringValue.cs | 2 +- .../Input/InputTypes/InputEnumTypeValue.cs | 3 +- .../Input/InputTypes/InputModelProperty.cs | 4 +- .../Common/Input/InputTypes/InputModelType.cs | 4 +- .../Common/Input/InputTypes/InputOperation.cs | 10 +- .../Common/Input/InputTypes/InputParameter.cs | 7 +- .../InputTypes/OperationResponseHeader.cs | 6 +- .../TypeSpecInputClientConverter.cs | 11 +- .../TypeSpecInputEnumTypeConverter.cs | 15 +- .../TypeSpecInputEnumTypeValueConverter.cs | 12 +- .../TypeSpecInputModelPropertyConverter.cs | 11 +- .../TypeSpecInputModelTypeConverter.cs | 21 +- .../TypeSpecInputOperationConverter.cs | 12 +- .../TypeSpecInputParameterConverter.cs | 9 +- .../Common/Output/Builders/BuilderHelpers.cs | 3 + .../Common/Output/Builders/ClientBuilder.cs | 2 +- .../Output/Models/CmcRestClientBuilder.cs | 2 +- .../Output/Models/LongRunningOperation.cs | 2 +- .../Common/Output/Models/RestClientBuilder.cs | 4 +- .../Output/Models/Types/SystemObjectType.cs | 2 +- .../Output/DpgOutputLibraryBuilder.cs | 1 + .../Mgmt/AutoRest/MgmtOutputLibrary.cs | 1 + .../Mgmt/Output/Models/MgmtPropertyBag.cs | 3 +- .../Mgmt/Output/ResourceData.cs | 2 +- .../Emitter.Csharp/package.json | 2 +- .../Output/Models/Shared/ParameterTests.cs | 24 +- .../NamedTypeSymbolExtensionsTests.cs | 4 +- .../Generation/CollectionWritingTests.cs | 22 +- .../Generation/DictionaryWritingTests.cs | 16 +- .../LowLevel/Generation/EnumWritingTests.cs | 44 +- .../Generation/ModelGenerationTestBase.cs | 10 +- .../LowLevel/Generation/ModelWriterTests.cs | 124 ++-- .../Generation/NestedModelWritingTests.cs | 22 +- .../OptionalPropertyWritingTests.cs | 18 +- .../ReadonlyPropertyWritingTests.cs | 34 +- .../authentication/api-key/tspCodeModel.json | 8 +- .../http/custom/tspCodeModel.json | 8 +- .../authentication/oauth2/tspCodeModel.json | 8 +- .../authentication/union/tspCodeModel.json | 8 +- .../access/tspCodeModel.json | 40 +- .../flatten-property/tspCodeModel.json | 16 +- .../usage/tspCodeModel.json | 22 +- .../azure/core/basic/tspCodeModel.json | 96 +-- .../azure/core/lro/rpc/tspCodeModel.json | 76 +-- .../azure/core/lro/standard/tspCodeModel.json | 110 ++-- .../azure/core/model/tspCodeModel.json | 22 +- .../azure/core/page/tspCodeModel.json | 94 +-- .../azure/core/scalar/tspCodeModel.json | 30 +- .../azure/core/traits/tspCodeModel.json | 66 +-- .../azure/example/basic/tspCodeModel.json | 6 +- .../common-properties/tspCodeModel.json | 146 ++--- .../resources/tspCodeModel.json | 348 +++++------ .../client-request-id/tspCodeModel.json | 6 +- .../client/naming/tspCodeModel.json | 32 +- .../client-operation-group/tspCodeModel.json | 20 +- .../structure/default/tspCodeModel.json | 30 +- .../structure/multi-client/tspCodeModel.json | 8 +- .../renamed-operation/tspCodeModel.json | 8 +- .../two-operation-group/tspCodeModel.json | 12 +- .../encode/bytes/tspCodeModel.json | 28 +- .../encode/datetime/tspCodeModel.json | 22 +- .../encode/duration/tspCodeModel.json | 22 +- .../encode/numeric/tspCodeModel.json | 12 +- .../parameters/basic/tspCodeModel.json | 14 +- .../body-optionality/tspCodeModel.json | 14 +- .../collection-format/tspCodeModel.json | 20 +- .../parameters/spread/tspCodeModel.json | 42 +- .../content-negotiation/tspCodeModel.json | 8 +- .../payload/media-type/tspCodeModel.json | 6 +- .../payload/multipart/tspCodeModel.json | 40 +- .../payload/pageable/tspCodeModel.json | 18 +- .../encoded-name/json/tspCodeModel.json | 10 +- .../endpoint/not-defined/tspCodeModel.json | 4 +- .../server/path/multiple/tspCodeModel.json | 8 +- .../single-headAsBoolean/tspCodeModel.json | 4 +- .../server/path/single/tspCodeModel.json | 4 +- .../versions/not-versioned/tspCodeModel.json | 4 +- .../versions/versioned/tspCodeModel.json | 10 +- .../conditional-request/tspCodeModel.json | 20 +- .../repeatability/tspCodeModel.json | 8 +- .../special-words/tspCodeModel.json | 88 +-- .../type/array/tspCodeModel.json | 92 +-- .../type/dictionary/tspCodeModel.json | 74 +-- .../type/enum/extensible/tspCodeModel.json | 24 +- .../type/enum/fixed/tspCodeModel.json | 34 +- .../type/model/empty/tspCodeModel.json | 14 +- .../enum-discriminator/tspCodeModel.json | 56 +- .../not-discriminated/tspCodeModel.json | 14 +- .../inheritance/recursive/tspCodeModel.json | 10 +- .../single-discriminator/tspCodeModel.json | 24 +- .../type/model/usage/tspCodeModel.json | 14 +- .../type/model/visibility/tspCodeModel.json | 36 +- .../additional-properties/tspCodeModel.json | 470 +++++++-------- .../type/property/nullable/tspCodeModel.json | 148 ++--- .../property/optionality/tspCodeModel.json | 308 +++++----- .../property/value-types/tspCodeModel.json | 436 +++++++------- .../type/scalar/tspCodeModel.json | 56 +- .../type/union/tspCodeModel.json | 90 +-- .../versioning/added/tspCodeModel.json | 22 +- .../versioning/madeOptional/tspCodeModel.json | 14 +- .../removed-betaversion/tspCodeModel.json | 30 +- .../removed-oldversion/tspCodeModel.json | 28 +- .../versioning/removed/tspCodeModel.json | 20 +- .../versioning/renamedFrom/tspCodeModel.json | 20 +- .../returnTypeChangedFrom/tspCodeModel.json | 14 +- .../typeChangedFrom/tspCodeModel.json | 14 +- .../authentication/api-key/tspCodeModel.json | 8 +- .../http/custom/tspCodeModel.json | 8 +- .../client/naming/tspCodeModel.json | 32 +- .../body-optionality/tspCodeModel.json | 14 +- .../parameters/spread/tspCodeModel.json | 42 +- .../content-negotiation/tspCodeModel.json | 8 +- .../payload/multipart/tspCodeModel.json | 40 +- .../encoded-name/json/tspCodeModel.json | 10 +- .../endpoint/not-defined/tspCodeModel.json | 4 +- .../special-words/tspCodeModel.json | 88 +-- .../type/array/tspCodeModel.json | 92 +-- .../type/dictionary/tspCodeModel.json | 74 +-- .../type/enum/extensible/tspCodeModel.json | 24 +- .../type/enum/fixed/tspCodeModel.json | 34 +- .../type/model/empty/tspCodeModel.json | 14 +- .../enum-discriminator/tspCodeModel.json | 56 +- .../not-discriminated/tspCodeModel.json | 14 +- .../inheritance/recursive/tspCodeModel.json | 10 +- .../single-discriminator/tspCodeModel.json | 24 +- .../type/model/usage/tspCodeModel.json | 14 +- .../additional-properties/tspCodeModel.json | 470 +++++++-------- .../type/property/nullable/tspCodeModel.json | 148 ++--- .../property/optionality/tspCodeModel.json | 308 +++++----- .../property/value-types/tspCodeModel.json | 436 +++++++------- .../type/scalar/tspCodeModel.json | 56 +- .../type/union/tspCodeModel.json | 90 +-- .../Authoring-TypeSpec/tspCodeModel.json | 240 ++++---- .../tspCodeModel.json | 68 +-- .../Customizations-TypeSpec/tspCodeModel.json | 122 ++-- .../FirstTest-TypeSpec/tspCodeModel.json | 324 +++++------ .../MediaTypes-TypeSpec/tspCodeModel.json | 2 +- .../MgmtTypeSpec/tspCodeModel.json | 296 +++++----- .../tspCodeModel.json | 242 ++++---- .../NoDocs-TypeSpec/tspCodeModel.json | 256 ++++---- .../Parameters-TypeSpec/tspCodeModel.json | 4 +- .../tspCodeModel.json | 150 ++--- .../Customized-TypeSpec/tspCodeModel.json | 122 ++-- .../tspCodeModel.json | 56 +- .../NoTest-TypeSpec/tspCodeModel.json | 60 +- .../src/Generated/AudioTranscriptions.cs | 2 - .../src/Generated/AudioTranslations.cs | 2 - .../src/Generated/Embeddings.cs | 2 - .../src/Generated/Files.cs | 10 - .../src/Generated/FineTunes.cs | 10 - .../src/Generated/FineTuningJobs.cs | 6 - .../src/Generated/Images.cs | 6 - .../src/Generated/ModelsOps.cs | 6 - .../src/Generated/Moderations.cs | 2 - .../tspCodeModel.json | 548 +++++++++--------- .../Unbranded-TypeSpec/tspCodeModel.json | 180 +++--- 163 files changed, 4716 insertions(+), 4698 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1e79b1c45eb..00a591ae2de 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2213,12 +2213,12 @@ } }, "node_modules/@typespec/http-client-csharp": { - "version": "0.1.9-alpha.20241114.1", - "resolved": "https://registry.npmjs.org/@typespec/http-client-csharp/-/http-client-csharp-0.1.9-alpha.20241114.1.tgz", - "integrity": "sha512-O09Gj8j3JR/cBd4WqsPAIeomAnkZibsp33TVdYGTHEOsg0O6BeVRn3k/r4pdWBrfyH6hydpEFerBw088BmQwOg==", + "version": "0.1.9-alpha.20241120.2", + "resolved": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM1MDI0OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241120.2.tgz", "dev": true, "license": "MIT", "dependencies": { + "@typespec/http-client-csharp": "file:", "json-serialize-refs": "0.1.0-0" }, "peerDependencies": { @@ -2231,6 +2231,10 @@ "@typespec/versioning": ">=0.62.0 <1.0.0 || ~0.63.0-0" } }, + "node_modules/@typespec/http-client-csharp/node_modules/@typespec/http-client-csharp": { + "resolved": "node_modules/@typespec/http-client-csharp", + "link": true + }, "node_modules/@typespec/json-schema": { "version": "0.62.0", "resolved": "https://registry.npmjs.org/@typespec/json-schema/-/json-schema-0.62.0.tgz", @@ -7787,7 +7791,7 @@ "license": "MIT", "dependencies": { "@autorest/csharp": "3.0.0-beta.20240625.4", - "@typespec/http-client-csharp": "0.1.9-alpha.20241114.1", + "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM1MDI0OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241120.2.tgz", "json-serialize-refs": "0.1.0-0" }, "devDependencies": { @@ -8102,7 +8106,7 @@ "@types/prettier": "^2.6.3", "@typespec/compiler": "0.62.0", "@typespec/http": "0.62.0", - "@typespec/http-client-csharp": "0.1.9-alpha.20241114.1", + "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM1MDI0OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241120.2.tgz", "@typespec/json-schema": "0.62.0", "@typespec/library-linter": "0.62.0", "@typespec/openapi": "0.62.0", @@ -9294,12 +9298,20 @@ "requires": {} }, "@typespec/http-client-csharp": { - "version": "0.1.9-alpha.20241114.1", - "resolved": "https://registry.npmjs.org/@typespec/http-client-csharp/-/http-client-csharp-0.1.9-alpha.20241114.1.tgz", - "integrity": "sha512-O09Gj8j3JR/cBd4WqsPAIeomAnkZibsp33TVdYGTHEOsg0O6BeVRn3k/r4pdWBrfyH6hydpEFerBw088BmQwOg==", + "version": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM1MDI0OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241120.2.tgz", "dev": true, "requires": { + "@typespec/http-client-csharp": "file:", "json-serialize-refs": "0.1.0-0" + }, + "dependencies": { + "@typespec/http-client-csharp": { + "version": "file:node_modules/@typespec/http-client-csharp", + "requires": { + "@typespec/http-client-csharp": "file:", + "json-serialize-refs": "0.1.0-0" + } + } } }, "@typespec/json-schema": { diff --git a/samples/AnomalyDetector/tspCodeModel.json b/samples/AnomalyDetector/tspCodeModel.json index 461bf7aad0e..06f75ac5b8a 100644 --- a/samples/AnomalyDetector/tspCodeModel.json +++ b/samples/AnomalyDetector/tspCodeModel.json @@ -87,7 +87,7 @@ "decorators": [] } ], - "description": "The batch detection status.", + "doc": "The batch detection status.", "isFixed": true, "isFlags": false, "usage": "Output,Json", @@ -121,7 +121,7 @@ "enumType": { "$ref": "12" }, - "description": "OneTable means that your input data are all in one CSV file, which contains one 'timestamp' column and several variable columns. The default DataSchema is OneTable.", + "doc": "OneTable means that your input data are all in one CSV file, which contains one 'timestamp' column and several variable columns. The default DataSchema is OneTable.", "decorators": [] }, { @@ -139,11 +139,11 @@ "enumType": { "$ref": "12" }, - "description": "MultiTable means that your input data are separated in multiple CSV files, in each file containing one 'timestamp' column and one 'variable' column, and the CSV file name should indicate the name of the variable. The default DataSchema is OneTable.", + "doc": "MultiTable means that your input data are separated in multiple CSV files, in each file containing one 'timestamp' column and one 'variable' column, and the CSV file name should indicate the name of the variable. The default DataSchema is OneTable.", "decorators": [] } ], - "description": "Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable.", + "doc": "Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -197,7 +197,7 @@ "decorators": [] } ], - "description": "The alignment mode.", + "doc": "The alignment mode.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -302,7 +302,7 @@ "decorators": [] } ], - "description": "An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed.", + "doc": "An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -390,7 +390,7 @@ "decorators": [] } ], - "description": "the model status.", + "doc": "the model status.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -563,7 +563,7 @@ "decorators": [] } ], - "description": "the time granularity of the data points.", + "doc": "the time granularity of the data points.", "isFixed": true, "isFlags": false, "usage": "Input,Json", @@ -685,7 +685,7 @@ "decorators": [] } ], - "description": "The impute mode.", + "doc": "The impute mode.", "isFixed": false, "isFlags": false, "usage": "Input,Json", @@ -941,7 +941,7 @@ "name": "MultivariateDetectionResult", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.MultivariateDetectionResult", "usage": "Output,Json", - "description": "Detection results for the given resultId.", + "doc": "Detection results for the given resultId.", "decorators": [], "properties": [ { @@ -949,7 +949,7 @@ "kind": "property", "name": "resultId", "serializedName": "resultId", - "description": "Result identifier, which is used to fetch the results of an inference call.", + "doc": "Result identifier, which is used to fetch the results of an inference call.", "type": { "$id": "110", "kind": "string", @@ -976,14 +976,14 @@ "kind": "property", "name": "summary", "serializedName": "summary", - "description": "Multivariate anomaly detection status.", + "doc": "Multivariate anomaly detection status.", "type": { "$id": "113", "kind": "model", "name": "MultivariateBatchDetectionResultSummary", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.MultivariateBatchDetectionResultSummary", "usage": "Output,Json", - "description": "Multivariate anomaly detection status.", + "doc": "Multivariate anomaly detection status.", "decorators": [], "properties": [ { @@ -991,7 +991,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "Status of detection results. One of CREATED, RUNNING, READY, and FAILED.", + "doc": "Status of detection results. One of CREATED, RUNNING, READY, and FAILED.", "type": { "$ref": "2" }, @@ -1007,7 +1007,7 @@ "kind": "property", "name": "errors", "serializedName": "errors", - "description": "Error message when detection is failed.", + "doc": "Error message when detection is failed.", "type": { "$id": "116", "kind": "array", @@ -1018,7 +1018,7 @@ "name": "ErrorResponse", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.ErrorResponse", "usage": "Output,Error,Json", - "description": "ErrorResponse contains code and message that shows the error information.", + "doc": "ErrorResponse contains code and message that shows the error information.", "decorators": [], "properties": [ { @@ -1026,7 +1026,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$id": "119", "kind": "string", @@ -1046,7 +1046,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The message explaining the error reported by the service.", + "doc": "The message explaining the error reported by the service.", "type": { "$id": "121", "kind": "string", @@ -1078,7 +1078,7 @@ "kind": "property", "name": "variableStates", "serializedName": "variableStates", - "description": "Variable Status.", + "doc": "Variable Status.", "type": { "$id": "123", "kind": "array", @@ -1089,7 +1089,7 @@ "name": "VariableState", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.VariableState", "usage": "Input,Output,Json", - "description": "Variable Status.", + "doc": "Variable Status.", "decorators": [], "properties": [ { @@ -1097,7 +1097,7 @@ "kind": "property", "name": "variable", "serializedName": "variable", - "description": "Variable name in variable states.", + "doc": "Variable name in variable states.", "type": { "$id": "126", "kind": "string", @@ -1117,7 +1117,7 @@ "kind": "property", "name": "filledNARatio", "serializedName": "filledNARatio", - "description": "Proportion of missing values that need to be filled by fillNAMethod.", + "doc": "Proportion of missing values that need to be filled by fillNAMethod.", "type": { "$id": "128", "kind": "float32", @@ -1137,7 +1137,7 @@ "kind": "property", "name": "effectiveCount", "serializedName": "effectiveCount", - "description": "Number of effective data points before applying fillNAMethod.", + "doc": "Number of effective data points before applying fillNAMethod.", "type": { "$id": "130", "kind": "int32", @@ -1157,7 +1157,7 @@ "kind": "property", "name": "firstTimestamp", "serializedName": "firstTimestamp", - "description": "First valid timestamp with value of input data.", + "doc": "First valid timestamp with value of input data.", "type": { "$id": "132", "kind": "utcDateTime", @@ -1185,7 +1185,7 @@ "kind": "property", "name": "lastTimestamp", "serializedName": "lastTimestamp", - "description": "Last valid timestamp with value of input data.", + "doc": "Last valid timestamp with value of input data.", "type": { "$id": "135", "kind": "utcDateTime", @@ -1225,14 +1225,14 @@ "kind": "property", "name": "setupInfo", "serializedName": "setupInfo", - "description": "Detection request for batch inference. This is an asynchronous inference which\nwill need another API to get detection results.", + "doc": "Detection request for batch inference. This is an asynchronous inference which\nwill need another API to get detection results.", "type": { "$id": "138", "kind": "model", "name": "MultivariateBatchDetectionOptions", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.MultivariateBatchDetectionOptions", "usage": "Input,Output,Json", - "description": "Detection request for batch inference. This is an asynchronous inference which\nwill need another API to get detection results.", + "doc": "Detection request for batch inference. This is an asynchronous inference which\nwill need another API to get detection results.", "decorators": [], "properties": [ { @@ -1240,7 +1240,7 @@ "kind": "property", "name": "dataSource", "serializedName": "dataSource", - "description": "Source link to the input data to indicate an accessible Azure storage Uri,\neither pointed to an Azure blob storage folder, or pointed to a CSV file in\nAzure blob storage based on you data schema selection. The data schema should\nbe exactly the same with those used in the training phase.", + "doc": "Source link to the input data to indicate an accessible Azure storage Uri,\neither pointed to an Azure blob storage folder, or pointed to a CSV file in\nAzure blob storage based on you data schema selection. The data schema should\nbe exactly the same with those used in the training phase.", "type": { "$id": "140", "kind": "url", @@ -1260,7 +1260,7 @@ "kind": "property", "name": "topContributorCount", "serializedName": "topContributorCount", - "description": "An optional field, which is used to specify the number of top contributed\nvariables for one anomalous timestamp in the response. The default number is\n10.", + "doc": "An optional field, which is used to specify the number of top contributed\nvariables for one anomalous timestamp in the response. The default number is\n10.", "type": { "$id": "142", "kind": "int32", @@ -1280,7 +1280,7 @@ "kind": "property", "name": "startTime", "serializedName": "startTime", - "description": "A required field, indicating the start time of data for detection, which should\nbe date-time of ISO 8601 format.", + "doc": "A required field, indicating the start time of data for detection, which should\nbe date-time of ISO 8601 format.", "type": { "$id": "144", "kind": "utcDateTime", @@ -1308,7 +1308,7 @@ "kind": "property", "name": "endTime", "serializedName": "endTime", - "description": "A required field, indicating the end time of data for detection, which should\nbe date-time of ISO 8601 format.", + "doc": "A required field, indicating the end time of data for detection, which should\nbe date-time of ISO 8601 format.", "type": { "$id": "147", "kind": "utcDateTime", @@ -1354,7 +1354,7 @@ "kind": "property", "name": "results", "serializedName": "results", - "description": "Detection result for each timestamp.", + "doc": "Detection result for each timestamp.", "type": { "$id": "150", "kind": "array", @@ -1365,7 +1365,7 @@ "name": "AnomalyState", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.AnomalyState", "usage": "Output,Json", - "description": "Anomaly status and information.", + "doc": "Anomaly status and information.", "decorators": [], "properties": [ { @@ -1373,7 +1373,7 @@ "kind": "property", "name": "timestamp", "serializedName": "timestamp", - "description": "The timestamp for this anomaly.", + "doc": "The timestamp for this anomaly.", "type": { "$id": "153", "kind": "utcDateTime", @@ -1401,14 +1401,14 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The detailed value of this anomalous timestamp.", + "doc": "The detailed value of this anomalous timestamp.", "type": { "$id": "156", "kind": "model", "name": "AnomalyValue", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.AnomalyValue", "usage": "Output,Json", - "description": "Detailed information of the anomalous timestamp.", + "doc": "Detailed information of the anomalous timestamp.", "decorators": [], "properties": [ { @@ -1416,7 +1416,7 @@ "kind": "property", "name": "isAnomaly", "serializedName": "isAnomaly", - "description": "True if an anomaly is detected at the current timestamp.", + "doc": "True if an anomaly is detected at the current timestamp.", "type": { "$id": "158", "kind": "boolean", @@ -1436,7 +1436,7 @@ "kind": "property", "name": "severity", "serializedName": "severity", - "description": "Indicates the significance of the anomaly. The higher the severity, the more\nsignificant the anomaly is.", + "doc": "Indicates the significance of the anomaly. The higher the severity, the more\nsignificant the anomaly is.", "type": { "$id": "160", "kind": "float32", @@ -1456,7 +1456,7 @@ "kind": "property", "name": "score", "serializedName": "score", - "description": "Raw anomaly score of severity, will help indicate the degree of abnormality as\nwell.", + "doc": "Raw anomaly score of severity, will help indicate the degree of abnormality as\nwell.", "type": { "$id": "162", "kind": "float32", @@ -1476,7 +1476,7 @@ "kind": "property", "name": "interpretation", "serializedName": "interpretation", - "description": "Interpretation of this anomalous timestamp.", + "doc": "Interpretation of this anomalous timestamp.", "type": { "$id": "164", "kind": "array", @@ -1487,7 +1487,7 @@ "name": "AnomalyInterpretation", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.AnomalyInterpretation", "usage": "Output,Json", - "description": "Interpretation of the anomalous timestamp.", + "doc": "Interpretation of the anomalous timestamp.", "decorators": [], "properties": [ { @@ -1495,7 +1495,7 @@ "kind": "property", "name": "variable", "serializedName": "variable", - "description": "Variable.", + "doc": "Variable.", "type": { "$id": "167", "kind": "string", @@ -1515,7 +1515,7 @@ "kind": "property", "name": "contributionScore", "serializedName": "contributionScore", - "description": "This score shows the percentage contributing to the anomalous timestamp. A\nnumber between 0 and 1.", + "doc": "This score shows the percentage contributing to the anomalous timestamp. A\nnumber between 0 and 1.", "type": { "$id": "169", "kind": "float32", @@ -1535,14 +1535,14 @@ "kind": "property", "name": "correlationChanges", "serializedName": "correlationChanges", - "description": "Correlation changes among the anomalous variables", + "doc": "Correlation changes among the anomalous variables", "type": { "$id": "171", "kind": "model", "name": "CorrelationChanges", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.CorrelationChanges", "usage": "Output,Json", - "description": "Correlation changes among the anomalous variables", + "doc": "Correlation changes among the anomalous variables", "decorators": [], "properties": [ { @@ -1550,7 +1550,7 @@ "kind": "property", "name": "changedVariables", "serializedName": "changedVariables", - "description": "The correlated variables that have correlation changes under an anomaly.", + "doc": "The correlated variables that have correlation changes under an anomaly.", "type": { "$id": "173", "kind": "array", @@ -1607,7 +1607,7 @@ "kind": "property", "name": "errors", "serializedName": "errors", - "description": "Error message for the current timestamp.", + "doc": "Error message for the current timestamp.", "type": { "$id": "176", "kind": "array", @@ -1669,7 +1669,7 @@ "name": "ModelInfo", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.ModelInfo", "usage": "Input,Output,Json", - "description": "Training result of a model including its status, errors and diagnostics\ninformation.", + "doc": "Training result of a model including its status, errors and diagnostics\ninformation.", "decorators": [], "properties": [ { @@ -1677,7 +1677,7 @@ "kind": "property", "name": "dataSource", "serializedName": "dataSource", - "description": "Source link to the input data to indicate an accessible Azure storage Uri,\neither pointed to an Azure blob storage folder, or pointed to a CSV file in\nAzure blob storage based on you data schema selection. ", + "doc": "Source link to the input data to indicate an accessible Azure storage Uri,\neither pointed to an Azure blob storage folder, or pointed to a CSV file in\nAzure blob storage based on you data schema selection. ", "type": { "$id": "179", "kind": "string", @@ -1697,7 +1697,7 @@ "kind": "property", "name": "dataSchema", "serializedName": "dataSchema", - "description": "Data schema of input data source: OneTable or MultiTable. The default\nDataSchema is OneTable.", + "doc": "Data schema of input data source: OneTable or MultiTable. The default\nDataSchema is OneTable.", "type": { "$ref": "12" }, @@ -1713,7 +1713,7 @@ "kind": "property", "name": "startTime", "serializedName": "startTime", - "description": "A required field, indicating the start time of training data, which should be\ndate-time of ISO 8601 format.", + "doc": "A required field, indicating the start time of training data, which should be\ndate-time of ISO 8601 format.", "type": { "$id": "182", "kind": "utcDateTime", @@ -1741,7 +1741,7 @@ "kind": "property", "name": "endTime", "serializedName": "endTime", - "description": "A required field, indicating the end time of training data, which should be\ndate-time of ISO 8601 format.", + "doc": "A required field, indicating the end time of training data, which should be\ndate-time of ISO 8601 format.", "type": { "$id": "185", "kind": "utcDateTime", @@ -1769,7 +1769,7 @@ "kind": "property", "name": "displayName", "serializedName": "displayName", - "description": "An optional field. The display name of the model whose maximum length is 24\ncharacters.", + "doc": "An optional field. The display name of the model whose maximum length is 24\ncharacters.", "type": { "$id": "188", "kind": "string", @@ -1789,7 +1789,7 @@ "kind": "property", "name": "slidingWindow", "serializedName": "slidingWindow", - "description": "An optional field, indicating how many previous timestamps will be used to\ndetect whether the timestamp is anomaly or not. ", + "doc": "An optional field, indicating how many previous timestamps will be used to\ndetect whether the timestamp is anomaly or not. ", "type": { "$id": "190", "kind": "int32", @@ -1809,14 +1809,14 @@ "kind": "property", "name": "alignPolicy", "serializedName": "alignPolicy", - "description": "An optional field, indicating the manner to align multiple variables.", + "doc": "An optional field, indicating the manner to align multiple variables.", "type": { "$id": "192", "kind": "model", "name": "AlignPolicy", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.AlignPolicy", "usage": "Input,Output,Json", - "description": "An optional field, indicating the manner to align multiple variables.", + "doc": "An optional field, indicating the manner to align multiple variables.", "decorators": [], "properties": [ { @@ -1824,7 +1824,7 @@ "kind": "property", "name": "alignMode", "serializedName": "alignMode", - "description": "An optional field, indicating how to align different variables to the same\ntime-range. Either Inner or Outer. ", + "doc": "An optional field, indicating how to align different variables to the same\ntime-range. Either Inner or Outer. ", "type": { "$ref": "18" }, @@ -1840,7 +1840,7 @@ "kind": "property", "name": "fillNAMethod", "serializedName": "fillNAMethod", - "description": "An optional field, indicating how missing values will be filled. One of\nPrevious, Subsequent, Linear, Zero, Fixed.", + "doc": "An optional field, indicating how missing values will be filled. One of\nPrevious, Subsequent, Linear, Zero, Fixed.", "type": { "$ref": "24" }, @@ -1856,7 +1856,7 @@ "kind": "property", "name": "paddingValue", "serializedName": "paddingValue", - "description": "An optional field. Required when fillNAMethod is Fixed.", + "doc": "An optional field. Required when fillNAMethod is Fixed.", "type": { "$id": "196", "kind": "float32", @@ -1885,7 +1885,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "Model status. One of CREATED, RUNNING, READY, and FAILED.", + "doc": "Model status. One of CREATED, RUNNING, READY, and FAILED.", "type": { "$ref": "36" }, @@ -1901,7 +1901,7 @@ "kind": "property", "name": "errors", "serializedName": "errors", - "description": "Error messages when failed to create a model.", + "doc": "Error messages when failed to create a model.", "type": { "$id": "199", "kind": "array", @@ -1924,14 +1924,14 @@ "kind": "property", "name": "diagnosticsInfo", "serializedName": "diagnosticsInfo", - "description": "Diagnostics information to help inspect the states of model or variable.", + "doc": "Diagnostics information to help inspect the states of model or variable.", "type": { "$id": "201", "kind": "model", "name": "DiagnosticsInfo", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.DiagnosticsInfo", "usage": "Input,Output,Json", - "description": "Diagnostics information to help inspect the states of model or variable.", + "doc": "Diagnostics information to help inspect the states of model or variable.", "decorators": [], "properties": [ { @@ -1939,14 +1939,14 @@ "kind": "property", "name": "modelState", "serializedName": "modelState", - "description": "Model status.", + "doc": "Model status.", "type": { "$id": "203", "kind": "model", "name": "ModelState", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.ModelState", "usage": "Input,Output,Json", - "description": "Model status.", + "doc": "Model status.", "decorators": [], "properties": [ { @@ -1954,7 +1954,7 @@ "kind": "property", "name": "epochIds", "serializedName": "epochIds", - "description": "This indicates the number of passes of the entire training dataset the\nalgorithm has completed.", + "doc": "This indicates the number of passes of the entire training dataset the\nalgorithm has completed.", "type": { "$id": "205", "kind": "array", @@ -1981,7 +1981,7 @@ "kind": "property", "name": "trainLosses", "serializedName": "trainLosses", - "description": "List of metrics used to assess how the model fits the training data for each\nepoch.", + "doc": "List of metrics used to assess how the model fits the training data for each\nepoch.", "type": { "$id": "208", "kind": "array", @@ -2008,7 +2008,7 @@ "kind": "property", "name": "validationLosses", "serializedName": "validationLosses", - "description": "List of metrics used to assess how the model fits the validation set for each\nepoch.", + "doc": "List of metrics used to assess how the model fits the validation set for each\nepoch.", "type": { "$id": "211", "kind": "array", @@ -2035,7 +2035,7 @@ "kind": "property", "name": "latenciesInSeconds", "serializedName": "latenciesInSeconds", - "description": "Latency for each epoch. ", + "doc": "Latency for each epoch. ", "type": { "$id": "214", "kind": "array", @@ -2071,7 +2071,7 @@ "kind": "property", "name": "variableStates", "serializedName": "variableStates", - "description": "Variable Status.", + "doc": "Variable Status.", "type": { "$id": "217", "kind": "array", @@ -2115,7 +2115,7 @@ "name": "AnomalyDetectionModel", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.AnomalyDetectionModel", "usage": "Output,Json", - "description": "Response of getting a model.", + "doc": "Response of getting a model.", "decorators": [], "properties": [ { @@ -2123,7 +2123,7 @@ "kind": "property", "name": "modelId", "serializedName": "modelId", - "description": "Model identifier.", + "doc": "Model identifier.", "type": { "$id": "220", "kind": "string", @@ -2150,7 +2150,7 @@ "kind": "property", "name": "createdTime", "serializedName": "createdTime", - "description": "Date and time (UTC) when the model was created.", + "doc": "Date and time (UTC) when the model was created.", "type": { "$id": "223", "kind": "utcDateTime", @@ -2178,7 +2178,7 @@ "kind": "property", "name": "lastUpdatedTime", "serializedName": "lastUpdatedTime", - "description": "Date and time (UTC) when the model was last updated.", + "doc": "Date and time (UTC) when the model was last updated.", "type": { "$id": "226", "kind": "utcDateTime", @@ -2206,7 +2206,7 @@ "kind": "property", "name": "modelInfo", "serializedName": "modelInfo", - "description": "Training result of a model including its status, errors and diagnostics\ninformation.", + "doc": "Training result of a model including its status, errors and diagnostics\ninformation.", "type": { "$ref": "177" }, @@ -2225,7 +2225,7 @@ "name": "ModelList", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.ModelList", "usage": "Output,Json", - "description": "Response of listing models.", + "doc": "Response of listing models.", "decorators": [], "properties": [ { @@ -2233,7 +2233,7 @@ "kind": "property", "name": "models", "serializedName": "models", - "description": "List of models.", + "doc": "List of models.", "type": { "$id": "231", "kind": "array", @@ -2256,7 +2256,7 @@ "kind": "property", "name": "currentCount", "serializedName": "currentCount", - "description": "Number of trained multivariate models.", + "doc": "Number of trained multivariate models.", "type": { "$id": "233", "kind": "int32", @@ -2276,7 +2276,7 @@ "kind": "property", "name": "maxCount", "serializedName": "maxCount", - "description": "Maximum number of models that can be trained for this Anomaly Detector resource.", + "doc": "Maximum number of models that can be trained for this Anomaly Detector resource.", "type": { "$id": "235", "kind": "int32", @@ -2296,7 +2296,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to fetch more models.", + "doc": "The link to fetch more models.", "type": { "$id": "237", "kind": "string", @@ -2319,7 +2319,7 @@ "name": "MultivariateLastDetectionOptions", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.MultivariateLastDetectionOptions", "usage": "Input,Json", - "description": "Request of last detection.", + "doc": "Request of last detection.", "decorators": [], "properties": [ { @@ -2327,7 +2327,7 @@ "kind": "property", "name": "variables", "serializedName": "variables", - "description": "This contains the inference data, including the name, timestamps(ISO 8601) and\nvalues of variables.", + "doc": "This contains the inference data, including the name, timestamps(ISO 8601) and\nvalues of variables.", "type": { "$id": "240", "kind": "array", @@ -2338,7 +2338,7 @@ "name": "VariableValues", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.VariableValues", "usage": "Input,Json", - "description": "Variable values.", + "doc": "Variable values.", "decorators": [], "properties": [ { @@ -2346,7 +2346,7 @@ "kind": "property", "name": "variable", "serializedName": "variable", - "description": "Variable name of last detection request.", + "doc": "Variable name of last detection request.", "type": { "$id": "243", "kind": "string", @@ -2366,7 +2366,7 @@ "kind": "property", "name": "timestamps", "serializedName": "timestamps", - "description": "Timestamps of last detection request", + "doc": "Timestamps of last detection request", "type": { "$id": "245", "kind": "array", @@ -2393,7 +2393,7 @@ "kind": "property", "name": "values", "serializedName": "values", - "description": "Values of variables.", + "doc": "Values of variables.", "type": { "$id": "248", "kind": "array", @@ -2432,7 +2432,7 @@ "kind": "property", "name": "topContributorCount", "serializedName": "topContributorCount", - "description": "An optional field, which is used to specify the number of top contributed\nvariables for one anomalous timestamp in the response. The default number is\n10.", + "doc": "An optional field, which is used to specify the number of top contributed\nvariables for one anomalous timestamp in the response. The default number is\n10.", "type": { "$id": "251", "kind": "int32", @@ -2458,7 +2458,7 @@ "name": "MultivariateLastDetectionResult", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.MultivariateLastDetectionResult", "usage": "Output,Json", - "description": "Results of last detection.", + "doc": "Results of last detection.", "decorators": [], "properties": [ { @@ -2466,7 +2466,7 @@ "kind": "property", "name": "variableStates", "serializedName": "variableStates", - "description": "Variable Status.", + "doc": "Variable Status.", "type": { "$id": "254", "kind": "array", @@ -2489,7 +2489,7 @@ "kind": "property", "name": "results", "serializedName": "results", - "description": "Anomaly status and information.", + "doc": "Anomaly status and information.", "type": { "$id": "256", "kind": "array", @@ -2515,7 +2515,7 @@ "name": "UnivariateDetectionOptions", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.UnivariateDetectionOptions", "usage": "Input,Json", - "description": "The request of entire or last anomaly detection.", + "doc": "The request of entire or last anomaly detection.", "decorators": [], "properties": [ { @@ -2523,7 +2523,7 @@ "kind": "property", "name": "series", "serializedName": "series", - "description": "Time series data points. Points should be sorted by timestamp in ascending\norder to match the anomaly detection result. If the data is not sorted\ncorrectly or there is duplicated timestamp, the API will not work. In such\ncase, an error message will be returned.", + "doc": "Time series data points. Points should be sorted by timestamp in ascending\norder to match the anomaly detection result. If the data is not sorted\ncorrectly or there is duplicated timestamp, the API will not work. In such\ncase, an error message will be returned.", "type": { "$id": "259", "kind": "array", @@ -2534,7 +2534,7 @@ "name": "TimeSeriesPoint", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.TimeSeriesPoint", "usage": "Input,Json", - "description": "The definition of input timeseries points.", + "doc": "The definition of input timeseries points.", "decorators": [], "properties": [ { @@ -2542,7 +2542,7 @@ "kind": "property", "name": "timestamp", "serializedName": "timestamp", - "description": "Optional argument, timestamp of a data point (ISO8601 format).", + "doc": "Optional argument, timestamp of a data point (ISO8601 format).", "type": { "$id": "262", "kind": "utcDateTime", @@ -2570,7 +2570,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The measurement of that point, should be float.", + "doc": "The measurement of that point, should be float.", "type": { "$id": "265", "kind": "float32", @@ -2602,7 +2602,7 @@ "kind": "property", "name": "granularity", "serializedName": "granularity", - "description": "Optional argument, can be one of yearly, monthly, weekly, daily, hourly,\nminutely, secondly, microsecond or none. If granularity is not present, it will\nbe none by default. If granularity is none, the timestamp property in time\nseries point can be absent.", + "doc": "Optional argument, can be one of yearly, monthly, weekly, daily, hourly,\nminutely, secondly, microsecond or none. If granularity is not present, it will\nbe none by default. If granularity is none, the timestamp property in time\nseries point can be absent.", "type": { "$ref": "46" }, @@ -2618,7 +2618,7 @@ "kind": "property", "name": "customInterval", "serializedName": "customInterval", - "description": "Custom Interval is used to set non-standard time interval, for example, if the\nseries is 5 minutes, request can be set as {\"granularity\":\"minutely\",\n\"customInterval\":5}.", + "doc": "Custom Interval is used to set non-standard time interval, for example, if the\nseries is 5 minutes, request can be set as {\"granularity\":\"minutely\",\n\"customInterval\":5}.", "type": { "$id": "268", "kind": "int32", @@ -2638,7 +2638,7 @@ "kind": "property", "name": "period", "serializedName": "period", - "description": "Optional argument, periodic value of a time series. If the value is null or\ndoes not present, the API will determine the period automatically.", + "doc": "Optional argument, periodic value of a time series. If the value is null or\ndoes not present, the API will determine the period automatically.", "type": { "$id": "270", "kind": "int32", @@ -2658,7 +2658,7 @@ "kind": "property", "name": "maxAnomalyRatio", "serializedName": "maxAnomalyRatio", - "description": "Optional argument, advanced model parameter, max anomaly ratio in a time series.", + "doc": "Optional argument, advanced model parameter, max anomaly ratio in a time series.", "type": { "$id": "272", "kind": "float32", @@ -2678,7 +2678,7 @@ "kind": "property", "name": "sensitivity", "serializedName": "sensitivity", - "description": "Optional argument, advanced model parameter, between 0-99, the lower the value\nis, the larger the margin value will be which means less anomalies will be\naccepted.", + "doc": "Optional argument, advanced model parameter, between 0-99, the lower the value\nis, the larger the margin value will be which means less anomalies will be\naccepted.", "type": { "$id": "274", "kind": "int32", @@ -2698,7 +2698,7 @@ "kind": "property", "name": "imputeMode", "serializedName": "imputeMode", - "description": "Used to specify how to deal with missing values in the input series, it's used\nwhen granularity is not \"none\".", + "doc": "Used to specify how to deal with missing values in the input series, it's used\nwhen granularity is not \"none\".", "type": { "$ref": "66" }, @@ -2714,7 +2714,7 @@ "kind": "property", "name": "imputeFixedValue", "serializedName": "imputeFixedValue", - "description": "Used to specify the value to fill, it's used when granularity is not \"none\"\nand imputeMode is \"fixed\".", + "doc": "Used to specify the value to fill, it's used when granularity is not \"none\"\nand imputeMode is \"fixed\".", "type": { "$id": "277", "kind": "float32", @@ -2740,7 +2740,7 @@ "name": "UnivariateEntireDetectionResult", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.UnivariateEntireDetectionResult", "usage": "Output,Json", - "description": "The response of entire anomaly detection.", + "doc": "The response of entire anomaly detection.", "decorators": [], "properties": [ { @@ -2748,7 +2748,7 @@ "kind": "property", "name": "period", "serializedName": "period", - "description": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", + "doc": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", "type": { "$id": "280", "kind": "int32", @@ -2768,7 +2768,7 @@ "kind": "property", "name": "expectedValues", "serializedName": "expectedValues", - "description": "ExpectedValues contain expected value for each input point. The index of the\narray is consistent with the input series.", + "doc": "ExpectedValues contain expected value for each input point. The index of the\narray is consistent with the input series.", "type": { "$id": "282", "kind": "array", @@ -2795,7 +2795,7 @@ "kind": "property", "name": "upperMargins", "serializedName": "upperMargins", - "description": "UpperMargins contain upper margin of each input point. UpperMargin is used to\ncalculate upperBoundary, which equals to expectedValue + (100 -\nmarginScale)*upperMargin. Anomalies in response can be filtered by\nupperBoundary and lowerBoundary. By adjusting marginScale value, less\nsignificant anomalies can be filtered in client side. The index of the array is\nconsistent with the input series.", + "doc": "UpperMargins contain upper margin of each input point. UpperMargin is used to\ncalculate upperBoundary, which equals to expectedValue + (100 -\nmarginScale)*upperMargin. Anomalies in response can be filtered by\nupperBoundary and lowerBoundary. By adjusting marginScale value, less\nsignificant anomalies can be filtered in client side. The index of the array is\nconsistent with the input series.", "type": { "$id": "285", "kind": "array", @@ -2822,7 +2822,7 @@ "kind": "property", "name": "lowerMargins", "serializedName": "lowerMargins", - "description": "LowerMargins contain lower margin of each input point. LowerMargin is used to\ncalculate lowerBoundary, which equals to expectedValue - (100 -\nmarginScale)*lowerMargin. Points between the boundary can be marked as normal\nones in client side. The index of the array is consistent with the input\nseries.", + "doc": "LowerMargins contain lower margin of each input point. LowerMargin is used to\ncalculate lowerBoundary, which equals to expectedValue - (100 -\nmarginScale)*lowerMargin. Points between the boundary can be marked as normal\nones in client side. The index of the array is consistent with the input\nseries.", "type": { "$id": "288", "kind": "array", @@ -2849,7 +2849,7 @@ "kind": "property", "name": "isAnomaly", "serializedName": "isAnomaly", - "description": "IsAnomaly contains anomaly properties for each input point. True means an\nanomaly either negative or positive has been detected. The index of the array\nis consistent with the input series.", + "doc": "IsAnomaly contains anomaly properties for each input point. True means an\nanomaly either negative or positive has been detected. The index of the array\nis consistent with the input series.", "type": { "$id": "291", "kind": "array", @@ -2876,7 +2876,7 @@ "kind": "property", "name": "isNegativeAnomaly", "serializedName": "isNegativeAnomaly", - "description": "IsNegativeAnomaly contains anomaly status in negative direction for each input\npoint. True means a negative anomaly has been detected. A negative anomaly\nmeans the point is detected as an anomaly and its real value is smaller than\nthe expected one. The index of the array is consistent with the input series.", + "doc": "IsNegativeAnomaly contains anomaly status in negative direction for each input\npoint. True means a negative anomaly has been detected. A negative anomaly\nmeans the point is detected as an anomaly and its real value is smaller than\nthe expected one. The index of the array is consistent with the input series.", "type": { "$id": "294", "kind": "array", @@ -2903,7 +2903,7 @@ "kind": "property", "name": "isPositiveAnomaly", "serializedName": "isPositiveAnomaly", - "description": "IsPositiveAnomaly contain anomaly status in positive direction for each input\npoint. True means a positive anomaly has been detected. A positive anomaly\nmeans the point is detected as an anomaly and its real value is larger than the\nexpected one. The index of the array is consistent with the input series.", + "doc": "IsPositiveAnomaly contain anomaly status in positive direction for each input\npoint. True means a positive anomaly has been detected. A positive anomaly\nmeans the point is detected as an anomaly and its real value is larger than the\nexpected one. The index of the array is consistent with the input series.", "type": { "$id": "297", "kind": "array", @@ -2930,7 +2930,7 @@ "kind": "property", "name": "severity", "serializedName": "severity", - "description": "The severity score for each input point. The larger the value is, the more\nsever the anomaly is. For normal points, the \"severity\" is always 0.", + "doc": "The severity score for each input point. The larger the value is, the more\nsever the anomaly is. For normal points, the \"severity\" is always 0.", "type": { "$id": "300", "kind": "array", @@ -2960,7 +2960,7 @@ "name": "AnomalyDetectorError", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.AnomalyDetectorError", "usage": "Output,Error,Json", - "description": "Error information returned by the API.", + "doc": "Error information returned by the API.", "decorators": [], "properties": [ { @@ -2968,7 +2968,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$ref": "80" }, @@ -2984,7 +2984,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A message explaining the error reported by the service.", + "doc": "A message explaining the error reported by the service.", "type": { "$id": "305", "kind": "string", @@ -3007,7 +3007,7 @@ "name": "UnivariateLastDetectionResult", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.UnivariateLastDetectionResult", "usage": "Output,Json", - "description": "The response of last anomaly detection.", + "doc": "The response of last anomaly detection.", "decorators": [], "properties": [ { @@ -3015,7 +3015,7 @@ "kind": "property", "name": "period", "serializedName": "period", - "description": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", + "doc": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", "type": { "$id": "308", "kind": "int32", @@ -3035,7 +3035,7 @@ "kind": "property", "name": "suggestedWindow", "serializedName": "suggestedWindow", - "description": "Suggested input series points needed for detecting the latest point.", + "doc": "Suggested input series points needed for detecting the latest point.", "type": { "$id": "310", "kind": "int32", @@ -3055,7 +3055,7 @@ "kind": "property", "name": "expectedValue", "serializedName": "expectedValue", - "description": "Expected value of the latest point.", + "doc": "Expected value of the latest point.", "type": { "$id": "312", "kind": "float32", @@ -3075,7 +3075,7 @@ "kind": "property", "name": "upperMargin", "serializedName": "upperMargin", - "description": "Upper margin of the latest point. UpperMargin is used to calculate\nupperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin.\nIf the value of latest point is between upperBoundary and lowerBoundary, it\nshould be treated as normal value. By adjusting marginScale value, anomaly\nstatus of latest point can be changed.", + "doc": "Upper margin of the latest point. UpperMargin is used to calculate\nupperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin.\nIf the value of latest point is between upperBoundary and lowerBoundary, it\nshould be treated as normal value. By adjusting marginScale value, anomaly\nstatus of latest point can be changed.", "type": { "$id": "314", "kind": "float32", @@ -3095,7 +3095,7 @@ "kind": "property", "name": "lowerMargin", "serializedName": "lowerMargin", - "description": "Lower margin of the latest point. LowerMargin is used to calculate\nlowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.\n", + "doc": "Lower margin of the latest point. LowerMargin is used to calculate\nlowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.\n", "type": { "$id": "316", "kind": "float32", @@ -3115,7 +3115,7 @@ "kind": "property", "name": "isAnomaly", "serializedName": "isAnomaly", - "description": "Anomaly status of the latest point, true means the latest point is an anomaly\neither in negative direction or positive direction.", + "doc": "Anomaly status of the latest point, true means the latest point is an anomaly\neither in negative direction or positive direction.", "type": { "$id": "318", "kind": "boolean", @@ -3135,7 +3135,7 @@ "kind": "property", "name": "isNegativeAnomaly", "serializedName": "isNegativeAnomaly", - "description": "Anomaly status in negative direction of the latest point. True means the latest\npoint is an anomaly and its real value is smaller than the expected one.", + "doc": "Anomaly status in negative direction of the latest point. True means the latest\npoint is an anomaly and its real value is smaller than the expected one.", "type": { "$id": "320", "kind": "boolean", @@ -3155,7 +3155,7 @@ "kind": "property", "name": "isPositiveAnomaly", "serializedName": "isPositiveAnomaly", - "description": "Anomaly status in positive direction of the latest point. True means the latest\npoint is an anomaly and its real value is larger than the expected one.", + "doc": "Anomaly status in positive direction of the latest point. True means the latest\npoint is an anomaly and its real value is larger than the expected one.", "type": { "$id": "322", "kind": "boolean", @@ -3175,7 +3175,7 @@ "kind": "property", "name": "severity", "serializedName": "severity", - "description": "The severity score for the last input point. The larger the value is, the more\nsever the anomaly is. For normal points, the \"severity\" is always 0.", + "doc": "The severity score for the last input point. The larger the value is, the more\nsever the anomaly is. For normal points, the \"severity\" is always 0.", "type": { "$id": "324", "kind": "float32", @@ -3198,7 +3198,7 @@ "name": "UnivariateChangePointDetectionOptions", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.UnivariateChangePointDetectionOptions", "usage": "Input,Json", - "description": "The request of change point detection.", + "doc": "The request of change point detection.", "decorators": [], "properties": [ { @@ -3206,7 +3206,7 @@ "kind": "property", "name": "series", "serializedName": "series", - "description": "Time series data points. Points should be sorted by timestamp in ascending\norder to match the change point detection result.", + "doc": "Time series data points. Points should be sorted by timestamp in ascending\norder to match the change point detection result.", "type": { "$id": "327", "kind": "array", @@ -3229,7 +3229,7 @@ "kind": "property", "name": "granularity", "serializedName": "granularity", - "description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or\nsecondly. Granularity is used for verify whether input series is valid.", + "doc": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or\nsecondly. Granularity is used for verify whether input series is valid.", "type": { "$ref": "46" }, @@ -3245,7 +3245,7 @@ "kind": "property", "name": "customInterval", "serializedName": "customInterval", - "description": "Custom Interval is used to set non-standard time interval, for example, if the\nseries is 5 minutes, request can be set as {\"granularity\":\"minutely\",\n\"customInterval\":5}.", + "doc": "Custom Interval is used to set non-standard time interval, for example, if the\nseries is 5 minutes, request can be set as {\"granularity\":\"minutely\",\n\"customInterval\":5}.", "type": { "$id": "330", "kind": "int32", @@ -3265,7 +3265,7 @@ "kind": "property", "name": "period", "serializedName": "period", - "description": "Optional argument, periodic value of a time series. If the value is null or\ndoes not present, the API will determine the period automatically.", + "doc": "Optional argument, periodic value of a time series. If the value is null or\ndoes not present, the API will determine the period automatically.", "type": { "$id": "332", "kind": "int32", @@ -3285,7 +3285,7 @@ "kind": "property", "name": "stableTrendWindow", "serializedName": "stableTrendWindow", - "description": "Optional argument, advanced model parameter, a default stableTrendWindow will\nbe used in detection.", + "doc": "Optional argument, advanced model parameter, a default stableTrendWindow will\nbe used in detection.", "type": { "$id": "334", "kind": "int32", @@ -3305,7 +3305,7 @@ "kind": "property", "name": "threshold", "serializedName": "threshold", - "description": "Optional argument, advanced model parameter, between 0.0-1.0, the lower the\nvalue is, the larger the trend error will be which means less change point will\nbe accepted.", + "doc": "Optional argument, advanced model parameter, between 0.0-1.0, the lower the\nvalue is, the larger the trend error will be which means less change point will\nbe accepted.", "type": { "$id": "336", "kind": "float32", @@ -3328,7 +3328,7 @@ "name": "UnivariateChangePointDetectionResult", "crossLanguageDefinitionId": "AnomalyDetector.Univariate.UnivariateChangePointDetectionResult", "usage": "Output,Json", - "description": "The response of change point detection.", + "doc": "The response of change point detection.", "decorators": [], "properties": [ { @@ -3336,7 +3336,7 @@ "kind": "property", "name": "period", "serializedName": "period", - "description": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", + "doc": "Frequency extracted from the series, zero means no recurrent pattern has been\nfound.", "type": { "$id": "339", "kind": "int32", @@ -3356,7 +3356,7 @@ "kind": "property", "name": "isChangePoint", "serializedName": "isChangePoint", - "description": "isChangePoint contains change point properties for each input point. True means\nan anomaly either negative or positive has been detected. The index of the\narray is consistent with the input series.", + "doc": "isChangePoint contains change point properties for each input point. True means\nan anomaly either negative or positive has been detected. The index of the\narray is consistent with the input series.", "type": { "$id": "341", "kind": "array", @@ -3383,7 +3383,7 @@ "kind": "property", "name": "confidenceScores", "serializedName": "confidenceScores", - "description": "the change point confidence of each point", + "doc": "the change point confidence of each point", "type": { "$id": "344", "kind": "array", @@ -3413,7 +3413,7 @@ "name": "ResponseError", "crossLanguageDefinitionId": "AnomalyDetector.Multivariate.ResponseError", "usage": "Error", - "description": "Error response", + "doc": "Error response", "decorators": [], "properties": [ { @@ -3421,7 +3421,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$id": "348", "kind": "string", @@ -3441,7 +3441,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The message explaining the error reported by the service.", + "doc": "The message explaining the error reported by the service.", "type": { "$id": "350", "kind": "string", @@ -3463,7 +3463,7 @@ { "$id": "351", "Name": "AnomalyDetectorClient", - "Description": "The Anomaly Detector API detects anomalies automatically in time series data.\nIt supports two kinds of mode, one is for stateless using, another is for\nstateful using. In stateless mode, there are three functionalities. Entire\nDetect is for detecting the whole series with model trained by the time series,\nLast Detect is detecting last point with model trained by points before.\nChangePoint Detect is for detecting trend changes in time series. In stateful\nmode, user can store time series, the stored time series will be used for\ndetection anomalies. Under this mode, user can still use the above three\nfunctionalities by only giving a time range without preparing time series in\nclient side. Besides the above three functionalities, stateful model also\nprovide group based detection and labeling service. By leveraging labeling\nservice user can provide labels for each detection result, these labels will be\nused for retuning or regenerating detection models. Inconsistency detection is\na kind of group based detection, this detection will find inconsistency ones in\na set of time series. By using anomaly detector service, business customers can\ndiscover incidents and establish a logic flow for root cause analysis.", + "Doc": "The Anomaly Detector API detects anomalies automatically in time series data.\nIt supports two kinds of mode, one is for stateless using, another is for\nstateful using. In stateless mode, there are three functionalities. Entire\nDetect is for detecting the whole series with model trained by the time series,\nLast Detect is detecting last point with model trained by points before.\nChangePoint Detect is for detecting trend changes in time series. In stateful\nmode, user can store time series, the stored time series will be used for\ndetection anomalies. Under this mode, user can still use the above three\nfunctionalities by only giving a time range without preparing time series in\nclient side. Besides the above three functionalities, stateful model also\nprovide group based detection and labeling service. By leveraging labeling\nservice user can provide labels for each detection result, these labels will be\nused for retuning or regenerating detection models. Inconsistency detection is\na kind of group based detection, this detection will find inconsistency ones in\na set of time series. By using anomaly detector service, business customers can\ndiscover incidents and establish a logic flow for root cause analysis.", "Operations": [], "Protocol": { "$id": "352" @@ -3473,7 +3473,7 @@ "$id": "353", "Name": "Endpoint", "NameInRequest": "Endpoint", - "Description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", + "Doc": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", "Type": { "$id": "354", "kind": "url", @@ -3494,7 +3494,7 @@ "$id": "355", "Name": "ApiVersion", "NameInRequest": "ApiVersion", - "Description": "Api Version", + "Doc": "Api Version", "Type": { "$id": "356", "kind": "string", @@ -3541,14 +3541,14 @@ "Name": "DetectUnivariateEntireSeries", "ResourceName": "Univariate", "Summary": "Detect anomalies for the entire series in batch.", - "Description": "This operation generates a model with an entire series, each point is detected\nwith the same model. With this method, points before and after a certain point\nare used to determine whether it is an anomaly. The entire detection can give\nuser an overall status of the time series.", + "Doc": "This operation generates a model with an entire series, each point is detected\nwith the same model. With this method, points before and after a certain point\nare used to determine whether it is an anomaly. The entire detection can give\nuser an overall status of the time series.", "Accessibility": "public", "Parameters": [ { "$id": "362", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "363", "kind": "constant", @@ -3603,7 +3603,7 @@ "$id": "368", "Name": "options", "NameInRequest": "options", - "Description": "Method of univariate anomaly detection.", + "Doc": "Method of univariate anomaly detection.", "Type": { "$ref": "257" }, @@ -7761,14 +7761,14 @@ "Name": "DetectUnivariateLastPoint", "ResourceName": "Univariate", "Summary": "Detect anomaly status of the latest point in time series.", - "Description": "This operation generates a model using the points that you sent into the API,\nand based on all data to determine whether the last point is anomalous.", + "Doc": "This operation generates a model using the points that you sent into the API,\nand based on all data to determine whether the last point is anomalous.", "Accessibility": "public", "Parameters": [ { "$id": "921", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "922", "kind": "constant", @@ -7823,7 +7823,7 @@ "$id": "927", "Name": "options", "NameInRequest": "options", - "Description": "Method of univariate anomaly detection.", + "Doc": "Method of univariate anomaly detection.", "Type": { "$ref": "257" }, @@ -9302,14 +9302,14 @@ "Name": "DetectUnivariateChangePoint", "ResourceName": "Univariate", "Summary": "Detect change point for the entire series", - "Description": "Evaluate change point score of every series point", + "Doc": "Evaluate change point score of every series point", "Accessibility": "public", "Parameters": [ { "$id": "1146", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1147", "kind": "constant", @@ -9364,7 +9364,7 @@ "$id": "1152", "Name": "options", "NameInRequest": "options", - "Description": "Method of univariate anomaly detection.", + "Doc": "Method of univariate anomaly detection.", "Type": { "$ref": "325" }, @@ -20348,7 +20348,7 @@ "$id": "2715", "Name": "Endpoint", "NameInRequest": "Endpoint", - "Description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", + "Doc": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", "Type": { "$id": "2716", "kind": "url", @@ -20369,7 +20369,7 @@ "$id": "2717", "Name": "ApiVersion", "NameInRequest": "ApiVersion", - "Description": "Api Version", + "Doc": "Api Version", "Type": { "$id": "2718", "kind": "string", @@ -20416,14 +20416,14 @@ "Name": "GetMultivariateBatchDetectionResult", "ResourceName": "Multivariate", "Summary": "Get Multivariate Anomaly Detection Result", - "Description": "For asynchronous inference, get multivariate anomaly detection result based on\nresultId returned by the BatchDetectAnomaly api.", + "Doc": "For asynchronous inference, get multivariate anomaly detection result based on\nresultId returned by the BatchDetectAnomaly api.", "Accessibility": "public", "Parameters": [ { "$id": "2724", "Name": "resultId", "NameInRequest": "resultId", - "Description": "ID of a batch detection result.", + "Doc": "ID of a batch detection result.", "Type": { "$id": "2725", "kind": "string", @@ -21075,14 +21075,14 @@ "Name": "TrainMultivariateModel", "ResourceName": "Multivariate", "Summary": "Train a Multivariate Anomaly Detection Model", - "Description": "Create and train a multivariate anomaly detection model. The request must\ninclude a source parameter to indicate an externally accessible Azure blob\nstorage URI.There are two types of data input: An URI pointed to an Azure blob\nstorage folder which contains multiple CSV files, and each CSV file contains\ntwo columns, timestamp and variable. Another type of input is an URI pointed to\na CSV file in Azure blob storage, which contains all the variables and a\ntimestamp column.", + "Doc": "Create and train a multivariate anomaly detection model. The request must\ninclude a source parameter to indicate an externally accessible Azure blob\nstorage URI.There are two types of data input: An URI pointed to an Azure blob\nstorage folder which contains multiple CSV files, and each CSV file contains\ntwo columns, timestamp and variable. Another type of input is an URI pointed to\na CSV file in Azure blob storage, which contains all the variables and a\ntimestamp column.", "Accessibility": "public", "Parameters": [ { "$id": "2814", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "2815", "kind": "constant", @@ -21137,7 +21137,7 @@ "$id": "2820", "Name": "modelInfo", "NameInRequest": "modelInfo", - "Description": "Model information.", + "Doc": "Model information.", "Type": { "$ref": "177" }, @@ -21167,7 +21167,7 @@ "$id": "2822", "Name": "Location", "NameInResponse": "location", - "Description": "Location and ID of the model.", + "Doc": "Location and ID of the model.", "Type": { "$id": "2823", "kind": "string", @@ -21475,14 +21475,14 @@ "Name": "ListMultivariateModels", "ResourceName": "Multivariate", "Summary": "List Multivariate Models", - "Description": "List models of a resource.", + "Doc": "List models of a resource.", "Accessibility": "public", "Parameters": [ { "$id": "2863", "Name": "skip", "NameInRequest": "skip", - "Description": "Skip indicates how many models will be skipped.", + "Doc": "Skip indicates how many models will be skipped.", "Type": { "$id": "2864", "kind": "int32", @@ -21504,7 +21504,7 @@ "$id": "2865", "Name": "top", "NameInRequest": "top", - "Description": "Top indicates how many models will be fetched.", + "Doc": "Top indicates how many models will be fetched.", "Type": { "$id": "2866", "kind": "int32", @@ -22655,14 +22655,14 @@ "Name": "DeleteMultivariateModel", "ResourceName": "Multivariate", "Summary": "Delete Multivariate Model", - "Description": "Delete an existing multivariate model according to the modelId", + "Doc": "Delete an existing multivariate model according to the modelId", "Accessibility": "public", "Parameters": [ { "$id": "3017", "Name": "modelId", "NameInRequest": "modelId", - "Description": "Model identifier.", + "Doc": "Model identifier.", "Type": { "$id": "3018", "kind": "string", @@ -22768,14 +22768,14 @@ "Name": "GetMultivariateModel", "ResourceName": "Multivariate", "Summary": "Get Multivariate Model", - "Description": "Get detailed information of multivariate model, including the training status\nand variables used in the model.", + "Doc": "Get detailed information of multivariate model, including the training status\nand variables used in the model.", "Accessibility": "public", "Parameters": [ { "$id": "3028", "Name": "modelId", "NameInRequest": "modelId", - "Description": "Model identifier.", + "Doc": "Model identifier.", "Type": { "$id": "3029", "kind": "string", @@ -23864,14 +23864,14 @@ "Name": "DetectMultivariateBatchAnomaly", "ResourceName": "Multivariate", "Summary": "Detect Multivariate Anomaly", - "Description": "Submit multivariate anomaly detection task with the modelId of trained model\nand inference data, the input schema should be the same with the training\nrequest. The request will complete asynchronously and return a resultId to\nquery the detection result.The request should be a source link to indicate an\nexternally accessible Azure storage Uri, either pointed to an Azure blob\nstorage folder, or pointed to a CSV file in Azure blob storage.", + "Doc": "Submit multivariate anomaly detection task with the modelId of trained model\nand inference data, the input schema should be the same with the training\nrequest. The request will complete asynchronously and return a resultId to\nquery the detection result.The request should be a source link to indicate an\nexternally accessible Azure storage Uri, either pointed to an Azure blob\nstorage folder, or pointed to a CSV file in Azure blob storage.", "Accessibility": "public", "Parameters": [ { "$id": "3171", "Name": "modelId", "NameInRequest": "modelId", - "Description": "Model identifier.", + "Doc": "Model identifier.", "Type": { "$id": "3172", "kind": "string", @@ -23893,7 +23893,7 @@ "$id": "3173", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "3174", "kind": "constant", @@ -23948,7 +23948,7 @@ "$id": "3179", "Name": "options", "NameInRequest": "options", - "Description": "Request of multivariate anomaly detection.", + "Doc": "Request of multivariate anomaly detection.", "Type": { "$ref": "138" }, @@ -23978,7 +23978,7 @@ "$id": "3181", "Name": "Operation-Id", "NameInResponse": "operation-id", - "Description": "Id of the detection result.", + "Doc": "Id of the detection result.", "Type": { "$id": "3182", "kind": "string", @@ -23991,7 +23991,7 @@ "$id": "3183", "Name": "Operation-Location", "NameInResponse": "operation-location", - "Description": "Location of the detection result.", + "Doc": "Location of the detection result.", "Type": { "$id": "3184", "kind": "string", @@ -24215,14 +24215,14 @@ "Name": "DetectMultivariateLastAnomaly", "ResourceName": "Multivariate", "Summary": "Detect anomalies in the last point of the request body", - "Description": "Submit multivariate anomaly detection task with the modelId of trained model\nand inference data, and the inference data should be put into request body in a\nJSON format. The request will complete synchronously and return the detection\nimmediately in the response body.", + "Doc": "Submit multivariate anomaly detection task with the modelId of trained model\nand inference data, and the inference data should be put into request body in a\nJSON format. The request will complete synchronously and return the detection\nimmediately in the response body.", "Accessibility": "public", "Parameters": [ { "$id": "3213", "Name": "modelId", "NameInRequest": "modelId", - "Description": "Model identifier.", + "Doc": "Model identifier.", "Type": { "$id": "3214", "kind": "string", @@ -24244,7 +24244,7 @@ "$id": "3215", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "3216", "kind": "constant", @@ -24299,7 +24299,7 @@ "$id": "3221", "Name": "options", "NameInRequest": "options", - "Description": "Request of last detection.", + "Doc": "Request of last detection.", "Type": { "$ref": "238" }, @@ -26448,7 +26448,7 @@ "$id": "3498", "Name": "Endpoint", "NameInRequest": "Endpoint", - "Description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", + "Doc": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus2.api.cognitive.microsoft.com).", "Type": { "$id": "3499", "kind": "url", @@ -26469,7 +26469,7 @@ "$id": "3500", "Name": "ApiVersion", "NameInRequest": "ApiVersion", - "Description": "Api Version", + "Doc": "Api Version", "Type": { "$id": "3501", "kind": "string", diff --git a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs index cf16a4d5045..f3ad84841dc 100644 --- a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs @@ -71,7 +71,8 @@ private IReadOnlyList CreateClients(IEnumerable ope private InputClient CreateClient(OperationGroup operationGroup, Dictionary? serviceRequestToInputOperation, Dictionary? inputOperationToOperation) => new( Name: operationGroup.Language.Default.Name, - Description: operationGroup.Language.Default.Description, + Summary: operationGroup.Language.Default.Summary ?? string.Empty, + Doc: operationGroup.Language.Default.Description, Operations: CreateOperations(operationGroup.Operations, serviceRequestToInputOperation, inputOperationToOperation), Parameters: Array.Empty(), Parent: null) @@ -139,7 +140,7 @@ private InputOperation CreateOperation(ServiceRequest serviceRequest, Operation resourceName: Configuration.AzureArm ? GetResoureName(operationId) : null, summary: operation.Language.Default.Summary, deprecated: operation.Deprecated?.Reason, - description: operation.Language.Default.Description, + doc: operation.Language.Default.Description, accessibility: operation.Accessibility, parameters: parameters, responses: operation.Responses.Select(CreateOperationResponse).ToList(), @@ -264,7 +265,8 @@ private List CreateOperationParameters(IReadOnlyCollection new( Name: input.Language.Default.Name, NameInRequest: input.Language.Default.SerializedName ?? input.Language.Default.Name, - Description: input.Language.Default.Description, + Summary: input.Language.Default.Summary ?? string.Empty, + Doc: input.Language.Default.Description, Type: GetOrCreateType(input), Location: GetRequestLocation(input), DefaultValue: GetDefaultValue(input), @@ -296,7 +298,8 @@ private List CreateOperationParameters(IReadOnlyCollection new( Name: header.CSharpName(), NameInResponse: header.Extensions?.HeaderCollectionPrefix ?? header.Header, - Description: header.Language.Default.Description, + Summary: header.Language.Default.Summary ?? string.Empty, + Doc: header.Language.Default.Description, Type: GetOrCreateType(header.Schema, header.Extensions?.Format, true) ); @@ -417,7 +420,8 @@ private InputModelType GetOrCreateModel(ObjectSchema schema) CrossLanguageDefinitionId: GetCrossLanguageDefinitionId(schema), Access: schema.Extensions?.Accessibility ?? (usage.HasFlag(SchemaTypeUsage.Model) ? "public" : "internal"), Deprecation: schema.Deprecated?.Reason, - Description: schema.CreateDescription(), + Summary: schema.CreateSummary(), + Doc: schema.CreateDescription(), Usage: (schema.Extensions != null && schema.Extensions.Formats.Contains("multipart/form-data") ? InputModelTypeUsage.MultipartFormData : InputModelTypeUsage.None) | GetUsage(usage), Properties: properties, @@ -468,7 +472,8 @@ private InputModelProperty GetOrCreateProperty(Property property) inputProperty = new( Name: property.Language.Default.Name, SerializedName: property.SerializedName, - Description: property.Language.Default.Description, + Summary: property.Language.Default.Summary ?? string.Empty, + Doc: property.Language.Default.Description, Type: GetOrCreateType(property), ConstantValue: property.Schema is ConstantSchema constantSchema ? CreateConstant(constantSchema, constantSchema.Extensions?.Format, property.IsNullable) : null, IsRequired: property.IsRequired, @@ -729,7 +734,7 @@ private InputType CreateTypeForObjectSchema(ObjectSchema objectSchema) } private static InputType CreateDataFactoryElementInputType(bool isNullable, InputType argumentType) - => new InputModelType("DataFactoryElement", "Azure.Core.Resources.DataFactoryElement", null, null, null, InputModelTypeUsage.None, Array.Empty(), null, Array.Empty(), null, null, new Dictionary(), null, new List { argumentType }).WithNullable(isNullable); + => new InputModelType("DataFactoryElement", "Azure.Core.Resources.DataFactoryElement", null, null, null, null, InputModelTypeUsage.None, Array.Empty(), null, Array.Empty(), null, null, new Dictionary(), null, new List { argumentType }).WithNullable(isNullable); private InputConstant CreateConstant(ConstantSchema constantSchema, string? format, bool isNullable) { @@ -770,7 +775,8 @@ private InputEnumType CreateEnumType(Schema schema, PrimitiveSchema choiceType, CrossLanguageDefinitionId: GetCrossLanguageDefinitionId(schema), Accessibility: schema.Extensions?.Accessibility ?? (usage.HasFlag(SchemaTypeUsage.Model) ? "public" : "internal"), Deprecated: schema.Deprecated?.Reason, - Description: schema.CreateDescription(), + Summary: schema.CreateSummary(), + Doc: schema.CreateDescription(), Usage: GetUsage(usage), ValueType: valueType, Values: choices.Select(c => CreateEnumValue(c, valueType)).ToList(), @@ -800,7 +806,8 @@ private static InputEnumTypeValue CreateEnumValue(ChoiceValue choiceValue, Input var value = ConvertRawValue(valueType, choiceValue.Value); return new( Name: choiceValue.Language.Default.Name, - Description: choiceValue.Language.Default.Description, + Summary: choiceValue.Language.Default.Summary ?? string.Empty, + Doc: choiceValue.Language.Default.Description, Value: value!); } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs index 496778149ec..a4b11cff28d 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs @@ -6,8 +6,9 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputClient(string Name, string Description, IReadOnlyList Operations, IReadOnlyList Parameters, string? Parent) +internal record InputClient(string Name, string Summary, string Doc, IReadOnlyList Operations, IReadOnlyList Parameters, string? Parent) { + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; private readonly string? _key; public string Key @@ -19,5 +20,5 @@ public string Key public IReadOnlyList Operations { get; internal set; } = Operations ?? Array.Empty(); public IReadOnlyList Decorators { get; internal set; } = new List(); - public InputClient() : this(string.Empty, string.Empty, Array.Empty(), Array.Empty(), null) { } + public InputClient() : this(string.Empty, string.Empty, string.Empty, Array.Empty(), Array.Empty(), null) { } } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs index 347d242a141..9baac763e0d 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs @@ -5,5 +5,8 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumType(string Name, string CrossLanguageDefinitionId, string? Accessibility, string? Deprecated, string Description, InputModelTypeUsage Usage, InputPrimitiveType ValueType, IReadOnlyList Values, bool IsExtensible) - : InputType(Name); +internal record InputEnumType(string Name, string CrossLanguageDefinitionId, string? Accessibility, string? Deprecated, string Summary, string Doc, InputModelTypeUsage Usage, InputPrimitiveType ValueType, IReadOnlyList Values, bool IsExtensible) + : InputType(Name) + { + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; + }; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeFloatValue.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeFloatValue.cs index fd36ed51bad..cbff3876037 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeFloatValue.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeFloatValue.cs @@ -3,4 +3,4 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumTypeFloatValue(string Name, float FloatValue, string? Description) : InputEnumTypeValue(Name, FloatValue, Description); +internal record InputEnumTypeFloatValue(string Name, float FloatValue, string? Summary, string? Doc) : InputEnumTypeValue(Name, FloatValue, Summary, Doc); diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeIntegerValue.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeIntegerValue.cs index 4e893e3d320..569d54e830e 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeIntegerValue.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeIntegerValue.cs @@ -3,4 +3,4 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumTypeIntegerValue(string Name, int IntegerValue, string? Description) : InputEnumTypeValue(Name, IntegerValue, Description); +internal record InputEnumTypeIntegerValue(string Name, int IntegerValue, string? Summary, string? Doc) : InputEnumTypeValue(Name, IntegerValue, Summary, Doc); diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeStringValue.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeStringValue.cs index cf6c83fde97..191d40b30e2 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeStringValue.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeStringValue.cs @@ -3,4 +3,4 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumTypeStringValue(string Name, string StringValue, string? Description) : InputEnumTypeValue(Name, StringValue, Description); +internal record InputEnumTypeStringValue(string Name, string StringValue, string? Summary, string? Doc) : InputEnumTypeValue(Name, StringValue, Summary, Doc); diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs index aad8f112f24..63b4f6bdfb3 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs @@ -5,11 +5,12 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumTypeValue(string Name, object Value, string? Description) +internal record InputEnumTypeValue(string Name, object Value, string? Summary, string? Doc) { public virtual string GetJsonValueString() => GetValueString(); public string GetValueString() => (Value.ToString() ?? string.Empty); + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; public string Name { get; internal set; } = Name; public IReadOnlyList Decorators { get; internal set; } = new List(); } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs index 4c3c10dd557..cac3acac547 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs @@ -6,7 +6,7 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputModelProperty(string Name, string SerializedName, string Description, InputType Type, InputConstant? ConstantValue, bool IsRequired, bool IsReadOnly, bool IsDiscriminator) +internal record InputModelProperty(string Name, string SerializedName, string Summary, string Doc, InputType Type, InputConstant? ConstantValue, bool IsRequired, bool IsReadOnly, bool IsDiscriminator) { public FormattableString? DefaultValue { get; init; } @@ -18,4 +18,6 @@ internal record InputModelProperty(string Name, string SerializedName, string De // calculated flatten prefix names public IReadOnlyList? FlattenedNames { get; internal set; } + + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; }; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs index 273a7e15544..467bc74d5f1 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs @@ -10,7 +10,7 @@ namespace AutoRest.CSharp.Common.Input { - internal record InputModelType(string Name, string CrossLanguageDefinitionId, string? Access, string? Deprecation, string? Description, InputModelTypeUsage Usage, IReadOnlyList Properties, InputModelType? BaseModel, IReadOnlyList DerivedModels, string? DiscriminatorValue, InputModelProperty? DiscriminatorProperty, IReadOnlyDictionary DiscriminatedSubtypes, InputType? AdditionalProperties, IReadOnlyList? ArgumentTypes = null) + internal record InputModelType(string Name, string CrossLanguageDefinitionId, string? Access, string? Deprecation, string? Summary, string? Doc, InputModelTypeUsage Usage, IReadOnlyList Properties, InputModelType? BaseModel, IReadOnlyList DerivedModels, string? DiscriminatorValue, InputModelProperty? DiscriminatorProperty, IReadOnlyDictionary DiscriminatedSubtypes, InputType? AdditionalProperties, IReadOnlyList? ArgumentTypes = null) : InputType(Name) { /// @@ -39,6 +39,8 @@ internal void SetBaseModel(InputModelType? baseModel, [CallerFilePath] string fi public IEnumerable GetAllBaseModels() => EnumerateBase(BaseModel); + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; + // The setter is only used for swagger input private bool? _useSystemTextJsonConverter; public bool UseSystemTextJsonConverter diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs index 6c84e09ad4e..0147e2f4d24 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs @@ -17,7 +17,7 @@ public InputOperation( string? resourceName, string? summary, string? deprecated, - string description, + string doc, string? accessibility, IReadOnlyList parameters, IReadOnlyList responses, @@ -41,7 +41,7 @@ public InputOperation( ResourceName = resourceName; Summary = summary; Deprecated = deprecated; - Description = description; + Doc = doc; Accessibility = accessibility; Parameters = parameters; Responses = responses; @@ -66,7 +66,7 @@ public InputOperation() : this( resourceName: null, summary: null, deprecated: null, - description: string.Empty, + doc: string.Empty, accessibility: null, parameters: Array.Empty(), responses: Array.Empty(), @@ -94,7 +94,7 @@ public static InputOperation RemoveApiVersionParam(InputOperation operation) operation.ResourceName, operation.Summary, operation.Deprecated, - operation.Description, + operation.Doc, operation.Accessibility, operation.Parameters.Where(p => !p.IsApiVersion).ToList(), operation.Responses, @@ -138,7 +138,7 @@ private IReadOnlyList EnsureExamples() public string? ResourceName { get; } public string? Summary { get; } public string? Deprecated { get; } - public string Description { get; } + public string Doc { get; } public string? Accessibility { get; } public IReadOnlyList Parameters { get; init; } public IReadOnlyList Responses { get; } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs index e3a3dae3c17..c62a34b5ee2 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs @@ -8,7 +8,8 @@ namespace AutoRest.CSharp.Common.Input; internal record InputParameter( string Name, string NameInRequest, - string? Description, + string? Summary, + string? Doc, InputType Type, RequestLocation Location, InputConstant? DefaultValue, @@ -29,7 +30,8 @@ internal record InputParameter( public InputParameter() : this( Name: string.Empty, NameInRequest: string.Empty, - Description: null, + Summary: null, + Doc: null, Type: InputPrimitiveType.Unknown, Location: RequestLocation.None, DefaultValue: null, @@ -52,4 +54,5 @@ public InputParameter() : this( public InputType Type { get; internal set; } = Type; public InputOperationParameterKind Kind { get; internal set; } = Kind; public IReadOnlyList Decorators { get; internal set; } = new List(); + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs index b5b3601292d..97941af0454 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs @@ -6,7 +6,9 @@ namespace AutoRest.CSharp.Common.Input; -internal record OperationResponseHeader(string Name, string NameInResponse, string Description, InputType Type) +internal record OperationResponseHeader(string Name, string NameInResponse, string Summary, string Doc, InputType Type) { - public OperationResponseHeader() : this("", "", "", InputPrimitiveType.String) { } + public OperationResponseHeader() : this(string.Empty, string.Empty, string.Empty, string.Empty, InputPrimitiveType.String) { } + + public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; } diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs index 857bb645b9b..4382532604b 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs @@ -28,7 +28,8 @@ public override void Write(Utf8JsonWriter writer, InputClient value, JsonSeriali { var isFirstProperty = id == null; string? name = null; - string? description = null; + string? summary = null; + string? doc = null; IReadOnlyList? operations = null; IReadOnlyList? parameters = null; string? parent = null; @@ -37,7 +38,8 @@ public override void Write(Utf8JsonWriter writer, InputClient value, JsonSeriali { var isKnownProperty = reader.TryReadReferenceId(ref isFirstProperty, ref id) || reader.TryReadString(nameof(InputClient.Name), ref name) - || reader.TryReadString(nameof(InputClient.Description), ref description) + || reader.TryReadString("Summary", ref summary) + || reader.TryReadString("Doc", ref doc) || reader.TryReadWithConverter(nameof(InputClient.Operations), options, ref operations) || reader.TryReadWithConverter(nameof(InputClient.Parameters), options, ref parameters) || reader.TryReadString(nameof(InputClient.Parent), ref parent); @@ -49,10 +51,11 @@ public override void Write(Utf8JsonWriter writer, InputClient value, JsonSeriali } name= name ?? throw new JsonException("InputClient must have name"); - description = description ?? string.Empty; + summary = summary ?? string.Empty; + doc = doc ?? string.Empty; operations = operations ?? Array.Empty(); parameters = parameters ?? Array.Empty(); - var inputClient = new InputClient(name, description, operations, parameters, parent); + var inputClient = new InputClient(name, summary, doc, operations, parameters, parent); if (id != null) { resolver.AddReference(id, inputClient); diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeConverter.cs index 87ae604121f..a54922f8729 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeConverter.cs @@ -30,7 +30,8 @@ public static InputEnumType CreateEnumType(ref Utf8JsonReader reader, string? id string? crossLanguageDefinitionId = null; string? access = null; string? deprecation = null; - string? description = null; + string? summary = null; + string? doc = null; string? usageString = null; bool isFixed = false; InputType? valueType = null; @@ -44,7 +45,8 @@ public static InputEnumType CreateEnumType(ref Utf8JsonReader reader, string? id || reader.TryReadString("crossLanguageDefinitionId", ref crossLanguageDefinitionId) || reader.TryReadString("access", ref access) || reader.TryReadString("deprecation", ref deprecation) - || reader.TryReadString("description", ref description) + || reader.TryReadString("summary", ref summary) + || reader.TryReadString("doc", ref doc) || reader.TryReadString("usage", ref usageString) || reader.TryReadBoolean("isFixed", ref isFixed) || reader.TryReadWithConverter("valueType", options, ref valueType) @@ -60,10 +62,11 @@ public static InputEnumType CreateEnumType(ref Utf8JsonReader reader, string? id name = name ?? throw new JsonException("Enum must have name"); // TODO: roll back to throw JSON error when there is linter on the upstream to check enum without @doc //description = description ?? throw new JsonException("Enum must have a description"); - if (description.IsNullOrEmpty()) + if (doc.IsNullOrEmpty() && summary.IsNullOrEmpty()) { - Console.Error.WriteLine($"[Warn]: Enum '{name}' must have a description"); - description = $"The {name}."; + Console.Error.WriteLine($"[Warn]: Enum '{name}' must have either a summary or description"); + summary = string.Empty; + doc = $"The {name}."; } if (!Enum.TryParse(usageString, out var usage)) @@ -81,7 +84,7 @@ public static InputEnumType CreateEnumType(ref Utf8JsonReader reader, string? id throw new JsonException("The ValueType of an EnumType must be a primitive type."); } - var enumType = new InputEnumType(name, crossLanguageDefinitionId ?? string.Empty, access, deprecation, description!, usage, inputValueType, values, !isFixed) + var enumType = new InputEnumType(name, crossLanguageDefinitionId ?? string.Empty, access, deprecation, summary!, doc!, usage, inputValueType, values, !isFixed) { Decorators = decorators ?? [] }; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeValueConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeValueConverter.cs index d70441725c9..4be11f70b4f 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeValueConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputEnumTypeValueConverter.cs @@ -28,7 +28,8 @@ private static InputEnumTypeValue CreateEnumTypeValue(ref Utf8JsonReader reader, var isFirstProperty = id == null; JsonElement? rawValue = null; InputPrimitiveType? valueType = null; - string? description = null; + string? summary = null; + string? doc = null; IReadOnlyList? decorators = null; while (reader.TokenType != JsonTokenType.EndObject) { @@ -36,7 +37,8 @@ private static InputEnumTypeValue CreateEnumTypeValue(ref Utf8JsonReader reader, || reader.TryReadString("name", ref name) || reader.TryReadWithConverter("value", options, ref rawValue) || reader.TryReadWithConverter("valueType", options, ref valueType) - || reader.TryReadString("description", ref description) + || reader.TryReadString("summary", ref summary) + || reader.TryReadString("doc", ref doc) || reader.TryReadWithConverter("decorators", options, ref decorators); if (!isKnownProperty) @@ -56,9 +58,9 @@ private static InputEnumTypeValue CreateEnumTypeValue(ref Utf8JsonReader reader, InputEnumTypeValue enumValue = valueType.Kind switch { - InputPrimitiveTypeKind.String => new InputEnumTypeStringValue(name, rawValue.Value.GetString() ?? throw new JsonException(), description) { Decorators = decorators ?? [] }, - InputPrimitiveTypeKind.Int32 => new InputEnumTypeIntegerValue(name, rawValue.Value.GetInt32(), description) { Decorators = decorators ?? [] }, - InputPrimitiveTypeKind.Float32 => new InputEnumTypeFloatValue(name, rawValue.Value.GetSingle(), description) { Decorators = decorators ?? [] }, + InputPrimitiveTypeKind.String => new InputEnumTypeStringValue(name, rawValue.Value.GetString() ?? throw new JsonException(), summary, doc) { Decorators = decorators ?? [] }, + InputPrimitiveTypeKind.Int32 => new InputEnumTypeIntegerValue(name, rawValue.Value.GetInt32(), summary, doc) { Decorators = decorators ?? [] }, + InputPrimitiveTypeKind.Float32 => new InputEnumTypeFloatValue(name, rawValue.Value.GetSingle(), summary, doc) { Decorators = decorators ?? [] }, _ => throw new JsonException() }; if (id != null) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs index 1bb45eafd22..1740b316194 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs @@ -28,7 +28,8 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read { var isFirstProperty = true; string? serializedName = null; - string? description = null; + string? summary = null; + string? doc = null; InputType? propertyType = null; InputConstant? defaultValue = null; bool isReadOnly = false; @@ -42,7 +43,8 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read var isKnownProperty = reader.TryReadReferenceId(ref isFirstProperty, ref id) || reader.TryReadString("name", ref name) || reader.TryReadString("serializedName", ref serializedName) - || reader.TryReadString("description", ref description) + || reader.TryReadString("summary", ref summary) + || reader.TryReadString("doc", ref doc) || reader.TryReadWithConverter("type", options, ref propertyType) || reader.TryReadBoolean("readOnly", ref isReadOnly) || reader.TryReadBoolean("optional", ref isOptional) @@ -57,7 +59,8 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read } name = name ?? throw new JsonException($"{nameof(InputModelProperty)} must have a name."); - description = BuilderHelpers.EscapeXmlDocDescription(description ?? string.Empty); + summary = BuilderHelpers.EscapeXmlDocDescription(summary ?? string.Empty); + doc = BuilderHelpers.EscapeXmlDocDescription(doc ?? string.Empty); propertyType = propertyType ?? throw new JsonException($"{nameof(InputModelProperty)} must have a property type."); if (propertyType is InputLiteralType lt) @@ -66,7 +69,7 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read propertyType = lt.ValueType; } - var property = new InputModelProperty(name, serializedName ?? name, description, propertyType, defaultValue, !isOptional, isReadOnly, isDiscriminator) + var property = new InputModelProperty(name, serializedName ?? name, summary, doc, propertyType, defaultValue, !isOptional, isReadOnly, isDiscriminator) { Decorators = decorators ?? [], IsFlattened = isFlattened diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelTypeConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelTypeConverter.cs index cc98645b86e..000d1fc17a8 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelTypeConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelTypeConverter.cs @@ -35,7 +35,8 @@ public static InputModelType CreateModelType(ref Utf8JsonReader reader, string? string? crossLanguageDefinitionId = null; string? access = null; string? deprecation = null; - string? description = null; + string? summary = null; + string? doc = null; string? usageString = null; InputModelProperty? discriminatorProperty = null; string? discriminatorValue = null; @@ -51,7 +52,8 @@ public static InputModelType CreateModelType(ref Utf8JsonReader reader, string? || reader.TryReadString("crossLanguageDefinitionId", ref crossLanguageDefinitionId) || reader.TryReadString("access", ref access) || reader.TryReadString("deprecation", ref deprecation) - || reader.TryReadString("description", ref description) + || reader.TryReadString("summary", ref summary) + || reader.TryReadString("doc", ref doc) || reader.TryReadString("usage", ref usageString) || reader.TryReadWithConverter("discriminatorProperty", options, ref discriminatorProperty) || reader.TryReadString("discriminatorValue", ref discriminatorValue) @@ -68,7 +70,7 @@ public static InputModelType CreateModelType(ref Utf8JsonReader reader, string? */ if (reader.GetString() == "baseModel") { - model = CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, description, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); + model = CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, summary, doc, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); reader.TryReadWithConverter("baseModel", options, ref baseModel); if (baseModel != null) { @@ -80,14 +82,14 @@ public static InputModelType CreateModelType(ref Utf8JsonReader reader, string? } if (reader.GetString() == "properties") { - model = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, description, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); + model = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, summary, doc, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); reader.Read(); CreateProperties(ref reader, properties, options, name!, model.Usage.HasFlag(InputModelTypeUsage.MultipartFormData)); continue; } if (reader.GetString() == "discriminatedSubtypes") { - model = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, description, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); + model = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, summary, doc, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); reader.Read(); CreateDiscriminatedSubtypes(ref reader, discriminatedSubtypes, options); if (reader.TokenType != JsonTokenType.EndObject) @@ -100,12 +102,12 @@ public static InputModelType CreateModelType(ref Utf8JsonReader reader, string? reader.SkipProperty(); } - var result = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation, description, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); + var result = model ?? CreateInputModelTypeInstance(id, name, crossLanguageDefinitionId, access, deprecation,summary, doc, usageString, discriminatorValue, discriminatorProperty, baseModel, properties, discriminatedSubtypes, additionalProperties, decorators, resolver); result.Decorators = decorators ?? Array.Empty(); return result; } - private static InputModelType CreateInputModelTypeInstance(string? id, string? name, string? crossLanguageDefinitionId, string? accessibility, string? deprecated, string? description, string? usageString, string? discriminatorValue, InputModelProperty? discriminatorProperty, InputModelType? baseModel, IReadOnlyList properties, IReadOnlyDictionary discriminatedSubtypes, InputType? additionalProperties, IReadOnlyList? decorators, ReferenceResolver resolver) + private static InputModelType CreateInputModelTypeInstance(string? id, string? name, string? crossLanguageDefinitionId, string? accessibility, string? deprecated, string? summary, string? doc, string? usageString, string? discriminatorValue, InputModelProperty? discriminatorProperty, InputModelType? baseModel, IReadOnlyList properties, IReadOnlyDictionary discriminatedSubtypes, InputType? additionalProperties, IReadOnlyList? decorators, ReferenceResolver resolver) { name = name ?? throw new JsonException("Model must have name"); if (!Enum.TryParse(usageString, out var usage)) @@ -115,7 +117,7 @@ private static InputModelType CreateInputModelTypeInstance(string? id, string? n var derivedModels = new List(); decorators = decorators ?? Array.Empty(); - var model = new InputModelType(name, crossLanguageDefinitionId ?? string.Empty, accessibility, deprecated, description, usage, properties, baseModel, derivedModels, discriminatorValue, discriminatorProperty, discriminatedSubtypes, additionalProperties) + var model = new InputModelType(name, crossLanguageDefinitionId ?? string.Empty, accessibility, deprecated, summary, doc, usage, properties, baseModel, derivedModels, discriminatorValue, discriminatorProperty, discriminatedSubtypes, additionalProperties) { Decorators = decorators }; @@ -231,7 +233,8 @@ private static InputModelProperty ConvertMultipartProperty(InputModelProperty pr => new InputModelProperty( property.Name, property.SerializedName, - property.Description, + property.Summary, + property.Doc, ConvertPropertyType(property.Type), property.ConstantValue, property.IsRequired, diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs index 4de539ebda9..580347c3e96 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs @@ -33,7 +33,7 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? string? summary = null; string? deprecated = null; string? accessibility = null; - string? description = null; + string? doc = null; IReadOnlyList? parameters = null; IReadOnlyList? responses = null; RequestMethod httpMethod = default; @@ -58,7 +58,7 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? || reader.TryReadString(nameof(InputOperation.ResourceName), ref resourceName) || reader.TryReadString(nameof(InputOperation.Summary), ref summary) || reader.TryReadString(nameof(InputOperation.Deprecated), ref deprecated) - || reader.TryReadString(nameof(InputOperation.Description), ref description) + || reader.TryReadString(nameof(InputOperation.Doc), ref doc) || reader.TryReadString(nameof(InputOperation.Accessibility), ref accessibility) || reader.TryReadWithConverter(nameof(InputOperation.Parameters), options, ref parameters) || reader.TryReadWithConverter(nameof(InputOperation.Responses), options, ref responses) @@ -84,10 +84,10 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? } name = name ?? throw new JsonException("Enum must have name"); - if (string.IsNullOrEmpty(description)) + if (string.IsNullOrEmpty(doc) && string.IsNullOrEmpty(summary)) { - Console.Error.WriteLine($"[Warn]: InputOperation '{name}' does not have a description"); - description = $"{name.Humanize()}."; + Console.Error.WriteLine($"[Warn]: InputOperation '{name}' must have either a summary or description"); + doc = $"{name.Humanize()}."; } crossLanguageDefinitionId = crossLanguageDefinitionId ?? throw new JsonException("InputOperation must have crossLanguageDefinitionId"); uri = uri ?? throw new JsonException("InputOperation must have uri"); @@ -95,7 +95,7 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? parameters = parameters ?? throw new JsonException("InputOperation must have parameters"); responses = responses ?? throw new JsonException("InputOperation must have responses"); - var inputOperation = new InputOperation(name, resourceName, summary, deprecated, description, accessibility, parameters, responses, httpMethod, requestBodyMediaType, uri, path, externalDocsUri, requestMediaTypes, bufferResponse, longRunning, paging, generateProtocolMethod, generateConvenienceMethod, crossLanguageDefinitionId, keepClientDefaultValue, examples) + var inputOperation = new InputOperation(name, resourceName, summary, deprecated, doc!, accessibility, parameters, responses, httpMethod, requestBodyMediaType, uri, path, externalDocsUri, requestMediaTypes, bufferResponse, longRunning, paging, generateProtocolMethod, generateConvenienceMethod, crossLanguageDefinitionId, keepClientDefaultValue, examples) { IsNameChanged = IsNameChanged(crossLanguageDefinitionId, name) }; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputParameterConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputParameterConverter.cs index cad323bd7b1..e67664ed2ab 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputParameterConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputParameterConverter.cs @@ -29,7 +29,8 @@ public static InputParameter CreateInputParameter(ref Utf8JsonReader reader, str var isFirstProperty = id == null && name == null; string? nameInRequest = null; - string? description = null; + string? summary = null; + string? doc = null; InputType? parameterType = null; string? location = null; InputConstant? defaultValue = null; @@ -49,7 +50,8 @@ public static InputParameter CreateInputParameter(ref Utf8JsonReader reader, str var isKnownProperty = reader.TryReadReferenceId(ref isFirstProperty, ref id) || reader.TryReadString(nameof(InputParameter.Name), ref name) || reader.TryReadString(nameof(InputParameter.NameInRequest), ref nameInRequest) - || reader.TryReadString(nameof(InputParameter.Description), ref description) + || reader.TryReadString(nameof(InputParameter.Summary), ref summary) + || reader.TryReadString(nameof(InputParameter.Doc), ref doc) || reader.TryReadWithConverter(nameof(InputParameter.Type), options, ref parameterType) || reader.TryReadString(nameof(InputParameter.Location), ref location) || reader.TryReadWithConverter(nameof(InputParameter.DefaultValue), options, ref defaultValue) @@ -90,7 +92,8 @@ public static InputParameter CreateInputParameter(ref Utf8JsonReader reader, str var parameter = new InputParameter( Name: name, NameInRequest: nameInRequest, - Description: description, + Summary: summary, + Doc: doc, Type: parameterType, Location: requestLocation, DefaultValue: defaultValue, diff --git a/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs b/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs index c39723be253..3f9a1c9ac2e 100644 --- a/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs +++ b/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs @@ -313,6 +313,9 @@ public static FormattableString CreateDerivedTypesDescription(CSharpType type) return $""; } + public static string CreateSummary(this Schema schema) + => schema.Language.Default.Summary is not null ? EscapeXmlDocDescription(schema.Language.Default.Summary) : string.Empty; + public static string CreateDescription(this Schema schema) => EscapeXmlDocDescription(schema.Language.Default.Description); diff --git a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs index f29d0593f97..8e34de6c13a 100644 --- a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs +++ b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs @@ -103,7 +103,7 @@ public static IEnumerable BuildMethods(InputClient inputClient, Re yield return new ClientMethod( name, startMethod, - BuilderHelpers.EscapeXmlDocDescription(operation.Description), + BuilderHelpers.EscapeXmlDocDescription(operation.Doc), new Diagnostic($"{declaration.Name}.{name}", Array.Empty()), operation.Accessibility ?? "public"); } diff --git a/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs b/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs index d477c5b8a57..2ef02a5926f 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs @@ -95,7 +95,7 @@ public RestClientMethod BuildMethod(InputOperation operation, IEnumerable BuildProperties() { inputType = new InputListType(string.Empty, string.Empty, InputPrimitiveType.Boolean); } - inputModelProperty = new InputModelProperty(property.Name, GetSerializedName(property.Name, SystemType), GetPropertySummary(setter != null, property.Name), inputType, null, IsRequired(property, SystemType), property.IsReadOnly(), false); + inputModelProperty = new InputModelProperty(property.Name, GetSerializedName(property.Name, SystemType), string.Empty, GetPropertySummary(setter != null, property.Name), inputType, null, IsRequired(property, SystemType), property.IsReadOnly(), false); } diff --git a/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs b/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs index 1e72cbf02bb..27588d74ae5 100644 --- a/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs +++ b/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs @@ -130,6 +130,7 @@ public static void CreateModels(IReadOnlyList inputModels, IDict string.Empty, "internal", null, + null, $"Unknown version of {actualBase.Name}", model.Usage.HasFlag(InputModelTypeUsage.Input) ? InputModelTypeUsage.Input | InputModelTypeUsage.Output : InputModelTypeUsage.Output, Array.Empty(), diff --git a/src/AutoRest.CSharp/Mgmt/AutoRest/MgmtOutputLibrary.cs b/src/AutoRest.CSharp/Mgmt/AutoRest/MgmtOutputLibrary.cs index d692cf0f0dd..cdf898b1f37 100644 --- a/src/AutoRest.CSharp/Mgmt/AutoRest/MgmtOutputLibrary.cs +++ b/src/AutoRest.CSharp/Mgmt/AutoRest/MgmtOutputLibrary.cs @@ -353,6 +353,7 @@ private Dictionary InitializeModels() string.Empty, "internal", null, + null, // [TODO]: Condition is added to minimize change $"Unknown version of {actualBase.SpecName ?? actualBase.Name}", actualBase.Usage, diff --git a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs index 58ac678ddc0..4bba4c83b09 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs @@ -44,7 +44,7 @@ protected override TypeProvider EnsurePackModel() { var inputParameter = _operation.Parameters.First(p => string.Equals(p.Name, parameter.Name, StringComparison.OrdinalIgnoreCase)); var description = !string.IsNullOrEmpty(inputParameter.Description) && parameter.Description is not null ? parameter.Description.ToString() : $"The {parameter.Name}"; - var property = new InputModelProperty(parameter.Name, parameter.Name, description, inputParameter!.Type, parameter.DefaultValue == null ? null : inputParameter.DefaultValue, parameter.DefaultValue == null, false, false); + var property = new InputModelProperty(parameter.Name, parameter.Name, string.Empty, description, inputParameter!.Type, parameter.DefaultValue == null ? null : inputParameter.DefaultValue, parameter.DefaultValue == null, false, false); properties.Add(property); } var defaultNamespace = $"{MgmtContext.Context.DefaultNamespace}.Models"; @@ -53,6 +53,7 @@ protected override TypeProvider EnsurePackModel() defaultNamespace, "public", null, + string.Empty, $"The {packModelName}.", InputModelTypeUsage.Input, properties, diff --git a/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs b/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs index 16a34430843..ffc3117a526 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs @@ -20,7 +20,7 @@ public ResourceData(InputModelType inputModel, SerializableObjectType? defaultDe _clientPrefix = inputModel.Name; } - public static ResourceData Empty = new ResourceData(new InputModelType(string.Empty, string.Empty, null, null, null, InputModelTypeUsage.None, Array.Empty(), null, Array.Empty(), null, null, new Dictionary(), null)); + public static ResourceData Empty = new ResourceData(new InputModelType(string.Empty, string.Empty, null, null, null, null, InputModelTypeUsage.None, Array.Empty(), null, Array.Empty(), null, null, new Dictionary(), null)); protected override bool IsResourceType => true; diff --git a/src/TypeSpec.Extension/Emitter.Csharp/package.json b/src/TypeSpec.Extension/Emitter.Csharp/package.json index 6868419ffdc..b43c4ebbb62 100644 --- a/src/TypeSpec.Extension/Emitter.Csharp/package.json +++ b/src/TypeSpec.Extension/Emitter.Csharp/package.json @@ -36,7 +36,7 @@ "dependencies": { "@autorest/csharp": "3.0.0-beta.20240625.4", "json-serialize-refs": "0.1.0-0", - "@typespec/http-client-csharp": "0.1.9-alpha.20241114.1" + "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM1MDI0OS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241120.2.tgz" }, "peerDependencies": { "@azure-tools/typespec-azure-core": ">=0.48.0 <1.0.0", diff --git a/test/AutoRest.CSharp.UnitTests/Common/Output/Models/Shared/ParameterTests.cs b/test/AutoRest.CSharp.UnitTests/Common/Output/Models/Shared/ParameterTests.cs index 3dbf69127aa..2bc760775d7 100644 --- a/test/AutoRest.CSharp.UnitTests/Common/Output/Models/Shared/ParameterTests.cs +++ b/test/AutoRest.CSharp.UnitTests/Common/Output/Models/Shared/ParameterTests.cs @@ -38,7 +38,8 @@ public void TestCreateDescription_DefaultDescription() CrossLanguageDefinitionId: "ns.testInputModel", Access: "accessibility", Deprecation: "test", - Description: "sample", + Summary: string.Empty, + Doc: "sample", DiscriminatorValue: null, DiscriminatorProperty: null, DiscriminatedSubtypes: null, @@ -50,7 +51,8 @@ public void TestCreateDescription_DefaultDescription() InputParameter opParam = new InputParameter( Name: "testParam", NameInRequest: "testParam", - Description: "default", + Summary: string.Empty, + Doc: "default", Type: inputModel, Location: new RequestLocation(), DefaultValue: null, @@ -94,7 +96,8 @@ public void TestCreateDescription_InputModelType() CrossLanguageDefinitionId: "ns.testInputModel", Access: "accessibility", Deprecation: "test", - Description: "sample", + Summary: string.Empty, + Doc: "sample", DiscriminatorValue: null, DiscriminatorProperty: null, DiscriminatedSubtypes: null, @@ -107,7 +110,8 @@ public void TestCreateDescription_InputModelType() InputParameter opParam = new InputParameter( Name: "testParam", NameInRequest: "testParam", - Description: string.Empty, + Summary: string.Empty, + Doc: string.Empty, Type: nullableInputModel, Location: new RequestLocation(), DefaultValue: null, @@ -153,7 +157,8 @@ public void TestCreateDescription_NonInputModelType() InputParameter opParam = new InputParameter( Name: "testParam", NameInRequest: "testParam", - Description: string.Empty, + Summary: string.Empty, + Doc: string.Empty, Type: literalType, Location: new RequestLocation(), DefaultValue: null, @@ -192,7 +197,8 @@ public void TestFromInputParameter_InputModelType() CrossLanguageDefinitionId: "ns.testInputModel", Access: "accessibility", Deprecation: "test", - Description: "sample", + Summary: string.Empty, + Doc: "sample", DiscriminatorValue: null, DiscriminatorProperty: null, DiscriminatedSubtypes: null, @@ -205,7 +211,8 @@ public void TestFromInputParameter_InputModelType() InputParameter inputParam = new InputParameter( Name: "testParam", NameInRequest: "testParam", - Description: "sampleDescription", + Summary: string.Empty, + Doc: "sampleDescription", Type: nullableInputModel, Location: new RequestLocation(), DefaultValue: null, @@ -250,7 +257,8 @@ public void TestFromInputParameter_NonInputModelType() InputParameter inputParam = new InputParameter( Name: "testParam", NameInRequest: "testParam", - Description: "sampleDescription", + Summary: string.Empty, + Doc: "sampleDescription", Type: literalType, Location: new RequestLocation(), DefaultValue: null, diff --git a/test/AutoRest.TestServer.Tests/Common/Utilities/NamedTypeSymbolExtensionsTests.cs b/test/AutoRest.TestServer.Tests/Common/Utilities/NamedTypeSymbolExtensionsTests.cs index 8d11f2c5fbc..14ff0f906aa 100644 --- a/test/AutoRest.TestServer.Tests/Common/Utilities/NamedTypeSymbolExtensionsTests.cs +++ b/test/AutoRest.TestServer.Tests/Common/Utilities/NamedTypeSymbolExtensionsTests.cs @@ -162,12 +162,12 @@ public void IsSameType_PrimitiveTypes() public void IsSameType_ModelTypes() { // Different namespace - var input = new InputModelType("MetadataModel", "", null, null, null, InputModelTypeUsage.Input | InputModelTypeUsage.Output, null, null, Array.Empty(), null, null, null, null); + var input = new InputModelType("MetadataModel", "", null, null, null, null, InputModelTypeUsage.Input | InputModelTypeUsage.Output, null, null, Array.Empty(), null, null, null, null); CSharpType modelType = new CSharpType(new ModelTypeProvider(input, "", null, null)); Assert.IsFalse(_modelSymbol.IsSameType(modelType)); // Same namespace - input = new InputModelType("MetadataModel", "NamedTypeSymbolExtensionsTests", null, null, null, InputModelTypeUsage.Input | InputModelTypeUsage.Output, null, null, Array.Empty(), null, null, null, null); + input = new InputModelType("MetadataModel", "NamedTypeSymbolExtensionsTests", null, null, null, null, InputModelTypeUsage.Input | InputModelTypeUsage.Output, null, null, Array.Empty(), null, null, null, null); modelType = new CSharpType(new ModelTypeProvider(input, "NamedTypeSymbolExtensionsTests", null, null)); Assert.IsTrue(_modelSymbol.IsSameType(modelType)); } diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/CollectionWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/CollectionWritingTests.cs index 30ba848b549..eee84b4b7c1 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/CollectionWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/CollectionWritingTests.cs @@ -16,7 +16,7 @@ public class CollectionWritingTests : ModelGenerationTestBase public void RoundTripPrimitiveCollectionProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/primitive-properties/main.cadl - var input = new InputModelType("RoundTripModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, "Round-trip model with collection properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var input = new InputModelType("RoundTripModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, null, "Round-trip model with collection properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); @@ -28,7 +28,7 @@ public void RoundTripPrimitiveCollectionProperties(string expectedModelCodes, st public void InputPrimitiveCollectionProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/collections-basic/main.cadl#L16-L24 - var input = new InputModelType("InputModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, "Input model with collection properties", InputModelTypeUsage.Input, + var input = new InputModelType("InputModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, null, "Input model with collection properties", InputModelTypeUsage.Input, new List { RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); @@ -40,7 +40,7 @@ public void InputPrimitiveCollectionProperties(string expectedModelCodes, string public void OutputPrimitiveCollectionProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/collections-basic/main.cadl#L26-L34 - var input = new InputModelType("OutputModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, "Output model with collection properties", InputModelTypeUsage.Output, + var input = new InputModelType("OutputModel", "Cadl.TestServer.CollectionPropertiesBasic.Models", "public", null, null, "Output model with collection properties", InputModelTypeUsage.Output, new List { RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); @@ -52,16 +52,16 @@ public void OutputPrimitiveCollectionProperties(string expectedModelCodes, strin public void ModelTypeCollectionProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/collections-models/main.cadl#L36-L44 - var elementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, + var elementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, null, "Simple model that will appear in a collection.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); - var collectionModelType = new InputModelType("ModelCollectionModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, + var collectionModelType = new InputModelType("ModelCollectionModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, null, "Simple model with model collection properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { - new InputModelProperty("requiredModelCollection", "requiredModelCollection", "Required collection of models.", new InputListType("requiredModelCollection", "TypeSpec.Array", elementModelType), null, true, false, false), - new InputModelProperty("optionalModelCollection", "optionalModelCollection", "Optional collection of models.", new InputListType("optionalModelCollection", "TypeSpec.Array",elementModelType), null, false, false, false), + new InputModelProperty("requiredModelCollection", "requiredModelCollection", null, "Required collection of models.", new InputListType("requiredModelCollection", "TypeSpec.Array", elementModelType), null, true, false, false), + new InputModelProperty("optionalModelCollection", "optionalModelCollection", null, "Optional collection of models.", new InputListType("optionalModelCollection", "TypeSpec.Array",elementModelType), null, false, false, false), }, null, new List(), null, null, null, null); @@ -75,16 +75,16 @@ public void ModelTypeCollectionProperties(string expectedModelCodes, string expe public void ModelType2DCollectionProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/collections-models/main.cadl#L36-L44 - var elementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, + var elementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, null, "Simple model that will appear in a collection.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); - var collectionModelType = new InputModelType("ModelCollectionModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, + var collectionModelType = new InputModelType("ModelCollectionModel", "Cadl.TestServer.ModelCollectionProperties.Models", "public", null, null, "Simple model with model collection properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { - new InputModelProperty("required2DCollection", "required2DCollection", "Required collection of models.", new InputListType("required2DCollection","TypeSpec.Array", new InputListType("requiredModelCollection","TypeSpec.Array", elementModelType)), null, true, false, false), - new InputModelProperty("optional2DCollection", "optional2DCollection", "Optional collection of models.", new InputListType("optional2DCollection", "TypeSpec.Array", new InputListType("optionalModelCollection","TypeSpec.Array", elementModelType)), null, false, false, false), + new InputModelProperty("required2DCollection", "required2DCollection", null, "Required collection of models.", new InputListType("required2DCollection","TypeSpec.Array", new InputListType("requiredModelCollection","TypeSpec.Array", elementModelType)), null, true, false, false), + new InputModelProperty("optional2DCollection", "optional2DCollection", null, "Optional collection of models.", new InputListType("optional2DCollection", "TypeSpec.Array", new InputListType("optionalModelCollection","TypeSpec.Array", elementModelType)), null, false, false, false), }, null, new List(), null, null, null, null); diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/DictionaryWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/DictionaryWritingTests.cs index 86302651abf..5f7e548ad72 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/DictionaryWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/DictionaryWritingTests.cs @@ -14,7 +14,7 @@ public class DictionaryWritingTests : ModelGenerationTestBase [TestCaseSource(nameof(RoundTripDictionaryPropertiesCase))] public void RoundTripDictionaryProperties(string expectedModelCodes, string expectedSerializationCodes) { - var model = new InputModelType("RoundTripModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, "Round-trip model with dictionary properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var model = new InputModelType("RoundTripModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, null, "Round-trip model with dictionary properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, DictionaryProperties, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.DictionaryProperties.Models", new List(), @@ -26,7 +26,7 @@ public void RoundTripDictionaryProperties(string expectedModelCodes, string expe [TestCaseSource(nameof(InputDictionaryPropertiesCase))] public void InputDictionaryProperties(string expectedModelCodes, string expectedSerializationCodes) { - var model = new InputModelType("InputModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, "Input model with dictionary properties", InputModelTypeUsage.Input, + var model = new InputModelType("InputModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, null, "Input model with dictionary properties", InputModelTypeUsage.Input, DictionaryProperties, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.DictionaryProperties.Models", new List(), @@ -39,7 +39,7 @@ public void InputDictionaryProperties(string expectedModelCodes, string expected [TestCaseSource(nameof(OutputDictionaryPropertiesCase))] public void OutputDictionaryProperties(string expectedModelCodes, string expectedSerializationCodes) { - var model = new InputModelType("OutputModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, "Output model with dictionary properties", InputModelTypeUsage.Output, + var model = new InputModelType("OutputModel", "Cadl.TestServer.DictionaryProperties.Models", "public", null, null, "Output model with dictionary properties", InputModelTypeUsage.Output, DictionaryProperties, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.DictionaryProperties.Models", new List(), @@ -50,12 +50,12 @@ public void OutputDictionaryProperties(string expectedModelCodes, string expecte private static readonly IReadOnlyList DictionaryProperties = new List { - new InputModelProperty("requiredStringDictionary", "requiredStringDictionary", "Required dictionary of strings, illustrating a dictionary of reference types.", new InputDictionaryType("requiredStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, true, false, false), - new InputModelProperty("requiredIntDictionary", "requiredIntDictionary", "Required dictionary of ints, illustrating a dictionary of value types.", new InputDictionaryType("requiredIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, true, false, false), - new InputModelProperty("requiredModelDictionary", "requiredModelDictionary", "Required dictionary of models, illustrating a dictionary of model types.", new InputDictionaryType("requiredIntDictionary", ElementModelType, ElementModelType), null, true, false, false), - new InputModelProperty("requiredModelDictionaryDictionary", "requiredModelDictionaryDictionary", "Required dictionary of dictionary of models, illustrating a dictionary of dictionary types.", + new InputModelProperty("requiredStringDictionary", "requiredStringDictionary", null, "Required dictionary of strings, illustrating a dictionary of reference types.", new InputDictionaryType("requiredStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, true, false, false), + new InputModelProperty("requiredIntDictionary", "requiredIntDictionary", null, "Required dictionary of ints, illustrating a dictionary of value types.", new InputDictionaryType("requiredIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, true, false, false), + new InputModelProperty("requiredModelDictionary", "requiredModelDictionary", null, "Required dictionary of models, illustrating a dictionary of model types.", new InputDictionaryType("requiredIntDictionary", ElementModelType, ElementModelType), null, true, false, false), + new InputModelProperty("requiredModelDictionaryDictionary", "requiredModelDictionaryDictionary", null, "Required dictionary of dictionary of models, illustrating a dictionary of dictionary types.", new InputDictionaryType("requiredModelDictionaryDictionary", InputPrimitiveType.String, new InputDictionaryType("requiredModelDictionary", ElementModelType, ElementModelType)), null, true, false, false), - new InputModelProperty("requiredModelListDictionary", "requiredModelListDictionary", "Required dictionary of list of models, illustrating a dictionary of list types.", + new InputModelProperty("requiredModelListDictionary", "requiredModelListDictionary", null, "Required dictionary of list of models, illustrating a dictionary of list types.", new InputDictionaryType("requiredModelListDictionary", InputPrimitiveType.String, new InputListType("requiredModelList", string.Empty, ElementModelType)), null, true, false, false) }; diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/EnumWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/EnumWritingTests.cs index 157faf03a45..3f55f44b919 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/EnumWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/EnumWritingTests.cs @@ -24,10 +24,10 @@ public void FixedEnums(EnumWrapper enumType, string expectedModelCodes, string e public void RoundTripEnumProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/c4f41f483eac812527f7b6dc837bd22d255a18ed/packages/cadl-ranch-specs/http/models/enum-properties/main.cadl#L67-L75 - var modelType = new InputModelType("RoundTripModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, "Round-trip model with enum properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var modelType = new InputModelType("RoundTripModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, null, "Round-trip model with enum properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List{ - new InputModelProperty("Day", "Day", "Required standard enum value.", FixedEnumType, null, true, false, false), - new InputModelProperty("Language", "Language", "Required string enum value.", ExtensibleEnumType, null, true, false, false) + new InputModelProperty("Day", "Day", string.Empty, "Required standard enum value.", FixedEnumType, null, true, false, false), + new InputModelProperty("Language", "Language", string.Empty, "Required string enum value.", ExtensibleEnumType, null, true, false, false) }, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.EnumPropertiesBasic", new List(), @@ -40,10 +40,10 @@ public void RoundTripEnumProperties(string expectedModelCodes, string expectedSe public void InputEnumProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/c4f41f483eac812527f7b6dc837bd22d255a18ed/packages/cadl-ranch-specs/http/models/enum-properties/main.cadl#L47-L55 - var modelType = new InputModelType("InputModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, "Input model with enum properties", InputModelTypeUsage.Input, + var modelType = new InputModelType("InputModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, null, "Input model with enum properties", InputModelTypeUsage.Input, new List{ - new InputModelProperty("Day", "Day", "Required standard enum value.", FixedEnumType, null, true, false, false), - new InputModelProperty("Language", "Language", "Required string enum value.", ExtensibleEnumType, null, true, false, false) + new InputModelProperty("Day", "Day", string.Empty, "Required standard enum value.", FixedEnumType, null, true, false, false), + new InputModelProperty("Language", "Language", string.Empty, "Required string enum value.", ExtensibleEnumType, null, true, false, false) }, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.EnumPropertiesBasic", new List(), @@ -56,10 +56,10 @@ public void InputEnumProperties(string expectedModelCodes, string expectedSerial public void OutputEnumProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/c4f41f483eac812527f7b6dc837bd22d255a18ed/packages/cadl-ranch-specs/http/models/enum-properties/main.cadl#L57-L65 - var modelType = new InputModelType("OutputModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, "Output model with enum properties", InputModelTypeUsage.Output, + var modelType = new InputModelType("OutputModel", "Cadl.TestServer.EnumPropertiesBasic", "public", null, null, "Output model with enum properties", InputModelTypeUsage.Output, new List{ - new InputModelProperty("Day", "Day", "Required standard enum value.", FixedEnumType, null, true, false, false), - new InputModelProperty("Language", "Language", "Required string enum value.", ExtensibleEnumType, null, true, false, false) + new InputModelProperty("Day", "Day", string.Empty, "Required standard enum value.", FixedEnumType, null, true, false, false), + new InputModelProperty("Language", "Language", string.Empty, "Required string enum value.", ExtensibleEnumType, null, true, false, false) }, null, new List(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.EnumPropertiesBasic", new List(), @@ -98,23 +98,23 @@ public class EnumWrapper internal EnumWrapper(EnumType enumType) => this.EnumType = enumType; } - private static readonly InputEnumType ExtensibleEnumType = new InputEnumType("TranslationLanguageValues", "Cadl.TestServer.EnumPropertiesBasic", "public", null, "The supported languages to translate input text into.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, InputPrimitiveType.String, + private static readonly InputEnumType ExtensibleEnumType = new InputEnumType("TranslationLanguageValues", "Cadl.TestServer.EnumPropertiesBasic", "public", null, null, "The supported languages to translate input text into.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, InputPrimitiveType.String, new List() { - new("English", "English", "Translate to English"), - new("Spanish", "Spanish", "Translate to Spanish"), - new("Mandarin", "Mandarin", "Translate to Mandarin"), - new("Undocumented", "Undocumented", null) + new("English", "English", null, "Translate to English"), + new("Spanish", "Spanish", null, "Translate to Spanish"), + new("Mandarin", "Mandarin", null, "Translate to Mandarin"), + new("Undocumented", "Undocumented", null, null) }, true); - private static readonly InputEnumType FixedEnumType = new InputEnumType("DayOfTheWeek", "Cadl.TestServer.EnumPropertiesBasic", "public", null, "Represents the days of the week using a standard, non-string enum.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, InputPrimitiveType.String, + private static readonly InputEnumType FixedEnumType = new InputEnumType("DayOfTheWeek", "Cadl.TestServer.EnumPropertiesBasic", "public", null, null, "Represents the days of the week using a standard, non-string enum.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, InputPrimitiveType.String, new List() { - new("Monday", "Monday", null), - new("Tuesday", "Tuesday", null), - new("Wednesday", "Wednesday", null), - new("Thursday", "Thursday", "Wednesday is documented to test this case."), - new("Friday", "Friday", null), - new("Saturday", "Saturday", null), - new("Sunday", "Sunday", null) + new("Monday", "Monday", null, null), + new("Tuesday", "Tuesday", null, null), + new("Wednesday", "Wednesday", null, null), + new("Thursday", "Thursday", null, "Wednesday is documented to test this case."), + new("Friday", "Friday", null, null), + new("Saturday", "Saturday", null, null), + new("Sunday", "Sunday", null, null) }, false); private static readonly object[] ExtensibleEnumCase = diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelGenerationTestBase.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelGenerationTestBase.cs index c6ffd755411..163e94033fb 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelGenerationTestBase.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelGenerationTestBase.cs @@ -14,17 +14,17 @@ namespace AutoRest.CSharp.Generation.Writers.Tests public class ModelGenerationTestBase { // common usages definitions - internal static readonly InputModelProperty RequiredStringProperty = new InputModelProperty("requiredString", "requiredString", "Required string, illustrating a reference type property.", InputPrimitiveType.String, null, true, false, false); + internal static readonly InputModelProperty RequiredStringProperty = new InputModelProperty("requiredString", "requiredString", string.Empty, "Required string, illustrating a reference type property.", InputPrimitiveType.String, null, true, false, false); - internal static readonly InputModelProperty RequiredIntProperty = new InputModelProperty("requiredInt", "requiredInt", "Required int, illustrating a value type property.", InputPrimitiveType.Int32, null, true, false, false); + internal static readonly InputModelProperty RequiredIntProperty = new InputModelProperty("requiredInt", "requiredInt", string.Empty, "Required int, illustrating a value type property.", InputPrimitiveType.Int32, null, true, false, false); - internal static readonly InputModelProperty RequiredStringListProperty = new InputModelProperty("requiredStringList", "requiredStringList", "Required collection of strings, illustrating a collection of reference types.", new InputListType("requiredStringList", "TypeSpec.Array", InputPrimitiveType.String), null, true, false, false); + internal static readonly InputModelProperty RequiredStringListProperty = new InputModelProperty("requiredStringList", "requiredStringList", string.Empty, "Required collection of strings, illustrating a collection of reference types.", new InputListType("requiredStringList", "TypeSpec.Array", InputPrimitiveType.String), null, true, false, false); - internal static readonly InputModelProperty RequiredIntListProperty = new InputModelProperty("requiredIntList", "requiredIntList", "Required collection of ints, illustrating a collection of value types.", new InputListType("requiredIntList", "TypeSpec.Array", InputPrimitiveType.Int32), null, true, false, false); + internal static readonly InputModelProperty RequiredIntListProperty = new InputModelProperty("requiredIntList", "requiredIntList", string.Empty, "Required collection of ints, illustrating a collection of value types.", new InputListType("requiredIntList", "TypeSpec.Array", InputPrimitiveType.Int32), null, true, false, false); internal static TypeFactory CadlTypeFactory => new TypeFactory(null, typeof(BinaryData)); - internal static readonly InputModelType ElementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", null, "public", + internal static readonly InputModelType ElementModelType = new InputModelType("SimpleModel", "Cadl.TestServer.ModelCollectionProperties.Models", null, "public", null, "Simple model that will appear in a collection.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelWriterTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelWriterTests.cs index f1ccbad21bb..15b141572d6 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelWriterTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ModelWriterTests.cs @@ -15,7 +15,7 @@ public class LowLevelModelWriterTests : ModelGenerationTestBase public void RoundTripBasic(string expectedModelCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/c4f41f483eac812527f7b6dc837bd22d255a18ed/packages/cadl-ranch-specs/http/models/roundtrip-basic/main.cadl#L15-L23 - var input = new InputModelType("InputModel", "Cadl.TestServer.InputBasic", null, "public", "Round-trip Model", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var input = new InputModelType("InputModel", "Cadl.TestServer.InputBasic", null, "public", null, "Round-trip Model", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); @@ -27,7 +27,7 @@ public void RoundTripBasic(string expectedModelCodes) public void InputBasic(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/input-basic/main.cadl - var input = new InputModelType("InputModel", "Cadl.TestServer.InputBasic", null, "public", "Input Model", InputModelTypeUsage.Input, + var input = new InputModelType("InputModel", "Cadl.TestServer.InputBasic", null, "public", null, "Input Model", InputModelTypeUsage.Input, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); @@ -39,7 +39,7 @@ public void InputBasic(string expectedModelCodes, string expectedSerializationCo public void OutputBasic(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/c4f41f483eac812527f7b6dc837bd22d255a18ed/packages/cadl-ranch-specs/http/models/output-basic/main.cadl#L15-L23 - var input = new InputModelType("OutputModel", "Cadl.TestServer.OutputBasic", null, "public", "Output Model", InputModelTypeUsage.Output, + var input = new InputModelType("OutputModel", "Cadl.TestServer.OutputBasic", null, "public", null, "Output Model", InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty }, null, new List(), null, null, null, null); @@ -51,19 +51,19 @@ public void OutputBasic(string expectedModelCodes, string expectedSerializationC public void PrimitiveProperties(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/primitive-properties/main.cadl - var input = new InputModelType("PrimitivePropertyModel", "Cadl.TestServer.PrimitiveProperties", null, "public", + var input = new InputModelType("PrimitivePropertyModel", "Cadl.TestServer.PrimitiveProperties", null, "public", null, "Round-trip model with primitive properties to show serialization and deserialization of each.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List{ - new InputModelProperty("requiredString", "requiredString", "", InputPrimitiveType.String, null, true, false, false), - new InputModelProperty("requiredInt", "requiredInt", "", InputPrimitiveType.Int32, null, true, false, false), - new InputModelProperty("requiredLong", "requiredLong", "", InputPrimitiveType.Int64, null, true, false, false), - new InputModelProperty("requiredSafeInt", "requiredSafeInt", "", InputPrimitiveType.Int64, null, true, false, false), - new InputModelProperty("requiredFloat", "requiredFloat", "", InputPrimitiveType.Float32, null, true, false, false), - new InputModelProperty("requiredDouble", "requiredDouble", "", InputPrimitiveType.Float64, null, true, false, false), - new InputModelProperty("requiredBodyDateTime", "requiredBodyDateTime", "Illustrate a zonedDateTime body parameter, serialized as (https://datatracker.ietf.org/doc/html/rfc3339)", new InputDateTimeType(DateTimeKnownEncoding.Rfc3339, "dateTime", string.Empty, InputPrimitiveType.String), null, true, false, false), - new InputModelProperty("requiredDuration", "requiredDuration", "", new InputDurationType(DurationKnownEncoding.Iso8601, "dateTime", string.Empty, InputPrimitiveType.String), null, true, false, false), - new InputModelProperty("requiredBoolean", "requiredBoolean", "", InputPrimitiveType.Boolean, null, true, false, false), - new InputModelProperty("requiredBytes", "requiredBytes", "", InputPrimitiveType.Base64, null, true, false, false) + new InputModelProperty("requiredString", "requiredString", string.Empty, string.Empty, InputPrimitiveType.String, null, true, false, false), + new InputModelProperty("requiredInt", "requiredInt", string.Empty, string.Empty, InputPrimitiveType.Int32, null, true, false, false), + new InputModelProperty("requiredLong", "requiredLong", string.Empty, string.Empty, InputPrimitiveType.Int64, null, true, false, false), + new InputModelProperty("requiredSafeInt", "requiredSafeInt", string.Empty, string.Empty, InputPrimitiveType.Int64, null, true, false, false), + new InputModelProperty("requiredFloat", "requiredFloat", string.Empty, string.Empty, InputPrimitiveType.Float32, null, true, false, false), + new InputModelProperty("requiredDouble", "requiredDouble", string.Empty, string.Empty, InputPrimitiveType.Float64, null, true, false, false), + new InputModelProperty("requiredBodyDateTime", "requiredBodyDateTime", string.Empty, "Illustrate a zonedDateTime body parameter, serialized as (https://datatracker.ietf.org/doc/html/rfc3339)", new InputDateTimeType(DateTimeKnownEncoding.Rfc3339, "dateTime", string.Empty, InputPrimitiveType.String), null, true, false, false), + new InputModelProperty("requiredDuration", "requiredDuration", string.Empty, string.Empty, new InputDurationType(DurationKnownEncoding.Iso8601, "dateTime", string.Empty, InputPrimitiveType.String), null, true, false, false), + new InputModelProperty("requiredBoolean", "requiredBoolean", string.Empty, string.Empty, InputPrimitiveType.Boolean, null, true, false, false), + new InputModelProperty("requiredBytes", "requiredBytes", string.Empty, string.Empty, InputPrimitiveType.Base64, null, true, false, false) }, null, Array.Empty(), null, null, null, null); @@ -90,9 +90,9 @@ namespace Cadl.TestServer.InputBasic public partial class InputModel { /// Initializes a new instance of InputModel. -/// Required string, illustrating a reference type property. -/// Required int, illustrating a value type property. -/// is null. +/// Required string, illustrating a reference type property. +/// Required int, illustrating a value type property. +/// is null. public InputModel(string requiredString,int requiredInt) { global::Azure.Core.Argument.AssertNotNull(requiredString, nameof(requiredString)); @@ -131,9 +131,9 @@ namespace Cadl.TestServer.InputBasic public partial class InputModel { /// Initializes a new instance of InputModel. -/// Required string, illustrating a reference type property. -/// Required int, illustrating a value type property. -/// is null. +/// Required string, illustrating a reference type property. +/// Required int, illustrating a value type property. +/// is null. public InputModel(string requiredString,int requiredInt) { global::Azure.Core.Argument.AssertNotNull(requiredString, nameof(requiredString)); @@ -167,9 +167,9 @@ public partial class InputModel: global::Azure.Core.IUtf8JsonSerializable void global::Azure.Core.IUtf8JsonSerializable.Write(global::System.Text.Json.Utf8JsonWriter writer) { writer.WriteStartObject(); -writer.WritePropertyName(""requiredString""); +writer.WritePropertyName(string.EmptyrequiredStringstring.Empty); writer.WriteStringValue(RequiredString); -writer.WritePropertyName(""requiredInt""); +writer.WritePropertyName(string.EmptyrequiredIntstring.Empty); writer.WriteNumberValue(RequiredInt); writer.WriteEndObject(); } @@ -206,9 +206,9 @@ namespace Cadl.TestServer.OutputBasic public partial class OutputModel { /// Initializes a new instance of OutputModel. -/// Required string, illustrating a reference type property. -/// Required int, illustrating a value type property. -/// is null. +/// Required string, illustrating a reference type property. +/// Required int, illustrating a value type property. +/// is null. internal OutputModel(string requiredString,int requiredInt) { global::Azure.Core.Argument.AssertNotNull(requiredString, nameof(requiredString)); @@ -246,11 +246,11 @@ public partial class OutputModel int requiredInt = default; foreach (var property in element.EnumerateObject()) { -if(property.NameEquals(""requiredString"")){ +if(property.NameEquals(string.EmptyrequiredStringstring.Empty)){ requiredString = property.Value.GetString(); continue; } -if(property.NameEquals(""requiredInt"")){ +if(property.NameEquals(string.EmptyrequiredIntstring.Empty)){ requiredInt = property.Value.GetInt32(); continue; } @@ -288,17 +288,17 @@ namespace Cadl.TestServer.PrimitiveProperties public partial class PrimitivePropertyModel { /// Initializes a new instance of PrimitivePropertyModel. -/// -/// -/// -/// -/// -/// -/// Illustrate a zonedDateTime body parameter, serialized as (https://datatracker.ietf.org/doc/html/rfc3339). -/// -/// -/// -/// or is null. +/// +/// +/// +/// +/// +/// +/// Illustrate a zonedDateTime body parameter, serialized as (https://datatracker.ietf.org/doc/html/rfc3339). +/// +/// +/// +/// or is null. public PrimitivePropertyModel(string requiredString,int requiredInt,long requiredLong,long requiredSafeInt,float requiredFloat,double requiredDouble,global::System.DateTimeOffset requiredBodyDateTime,global::System.TimeSpan requiredDuration,bool requiredBoolean,global::System.BinaryData requiredBytes) { global::Azure.Core.Argument.AssertNotNull(requiredString, nameof(requiredString)); @@ -358,25 +358,25 @@ public partial class PrimitivePropertyModel: global::Azure.Core.IUtf8JsonSeriali void global::Azure.Core.IUtf8JsonSerializable.Write(global::System.Text.Json.Utf8JsonWriter writer) { writer.WriteStartObject(); -writer.WritePropertyName(""requiredString""); +writer.WritePropertyName(string.EmptyrequiredStringstring.Empty); writer.WriteStringValue(RequiredString); -writer.WritePropertyName(""requiredInt""); +writer.WritePropertyName(string.EmptyrequiredIntstring.Empty); writer.WriteNumberValue(RequiredInt); -writer.WritePropertyName(""requiredLong""); +writer.WritePropertyName(string.EmptyrequiredLongstring.Empty); writer.WriteNumberValue(RequiredLong); -writer.WritePropertyName(""requiredSafeInt""); +writer.WritePropertyName(string.EmptyrequiredSafeIntstring.Empty); writer.WriteNumberValue(RequiredSafeInt); -writer.WritePropertyName(""requiredFloat""); +writer.WritePropertyName(string.EmptyrequiredFloatstring.Empty); writer.WriteNumberValue(RequiredFloat); -writer.WritePropertyName(""requiredDouble""); +writer.WritePropertyName(string.EmptyrequiredDoublestring.Empty); writer.WriteNumberValue(RequiredDouble); -writer.WritePropertyName(""requiredBodyDateTime""); -writer.WriteStringValue(RequiredBodyDateTime, ""O""); -writer.WritePropertyName(""requiredDuration""); -writer.WriteStringValue(RequiredDuration, ""P""); -writer.WritePropertyName(""requiredBoolean""); +writer.WritePropertyName(string.EmptyrequiredBodyDateTimestring.Empty); +writer.WriteStringValue(RequiredBodyDateTime, string.EmptyOstring.Empty); +writer.WritePropertyName(string.EmptyrequiredDurationstring.Empty); +writer.WriteStringValue(RequiredDuration, string.EmptyPstring.Empty); +writer.WritePropertyName(string.EmptyrequiredBooleanstring.Empty); writer.WriteBooleanValue(RequiredBoolean); -writer.WritePropertyName(""requiredBytes""); +writer.WritePropertyName(string.EmptyrequiredBytesstring.Empty); #if NET6_0_OR_GREATER writer.WriteRawValue(RequiredBytes); #else @@ -399,43 +399,43 @@ public partial class PrimitivePropertyModel: global::Azure.Core.IUtf8JsonSeriali global::System.BinaryData requiredBytes = default; foreach (var property in element.EnumerateObject()) { -if(property.NameEquals(""requiredString"")){ +if(property.NameEquals(string.EmptyrequiredStringstring.Empty)){ requiredString = property.Value.GetString(); continue; } -if(property.NameEquals(""requiredInt"")){ +if(property.NameEquals(string.EmptyrequiredIntstring.Empty)){ requiredInt = property.Value.GetInt32(); continue; } -if(property.NameEquals(""requiredLong"")){ +if(property.NameEquals(string.EmptyrequiredLongstring.Empty)){ requiredLong = property.Value.GetInt64(); continue; } -if(property.NameEquals(""requiredSafeInt"")){ +if(property.NameEquals(string.EmptyrequiredSafeIntstring.Empty)){ requiredSafeInt = property.Value.GetInt64(); continue; } -if(property.NameEquals(""requiredFloat"")){ +if(property.NameEquals(string.EmptyrequiredFloatstring.Empty)){ requiredFloat = property.Value.GetSingle(); continue; } -if(property.NameEquals(""requiredDouble"")){ +if(property.NameEquals(string.EmptyrequiredDoublestring.Empty)){ requiredDouble = property.Value.GetDouble(); continue; } -if(property.NameEquals(""requiredBodyDateTime"")){ -requiredBodyDateTime = property.Value.GetDateTimeOffset(""O""); +if(property.NameEquals(string.EmptyrequiredBodyDateTimestring.Empty)){ +requiredBodyDateTime = property.Value.GetDateTimeOffset(string.EmptyOstring.Empty); continue; } -if(property.NameEquals(""requiredDuration"")){ -requiredDuration = property.Value.GetTimeSpan(""P""); +if(property.NameEquals(string.EmptyrequiredDurationstring.Empty)){ +requiredDuration = property.Value.GetTimeSpan(string.EmptyPstring.Empty); continue; } -if(property.NameEquals(""requiredBoolean"")){ +if(property.NameEquals(string.EmptyrequiredBooleanstring.Empty)){ requiredBoolean = property.Value.GetBoolean(); continue; } -if(property.NameEquals(""requiredBytes"")){ +if(property.NameEquals(string.EmptyrequiredBytesstring.Empty)){ requiredBytes = global::System.BinaryData.FromString(property.Value.GetRawText()); continue; } diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/NestedModelWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/NestedModelWritingTests.cs index b3fa3c00e91..68be98b3b77 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/NestedModelWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/NestedModelWritingTests.cs @@ -14,10 +14,10 @@ public class NestedModelWritingTests : ModelGenerationTestBase public void RoundTripModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/7435655e82b732b3573379f76e0e613423d244e9/packages/cadl-ranch-specs/http/models/nested-models/main.cadl#L60-L67 - var model = new InputModelType("RoundTripModel", "NestedModelsBasic.Models", "public", null, "Round-trip model with nested model properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var model = new InputModelType("RoundTripModel", "NestedModelsBasic.Models", "public", null, null, "Round-trip model with nested model properties", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { - new InputModelProperty("NestedRoundTripModel", "NestedRoundTripModel", "Required nested round-trip model.", NestedRoundTripOnlyModelType, null, true, false, false), + new InputModelProperty("NestedRoundTripModel", "NestedRoundTripModel", null, "Required nested round-trip model.", NestedRoundTripOnlyModelType, null, true, false, false), NestedRoundTripSharedModelProperty }, null, new List(), null, null, null, null); @@ -32,10 +32,10 @@ public void RoundTripModel(string expectedModelCodes, string expectedSerializati public void InputModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/7435655e82b732b3573379f76e0e613423d244e9/packages/cadl-ranch-specs/http/models/nested-models/main.cadl#L42-L49 - var model = new InputModelType("InputModel", "NestedModelsBasic.Models", "public", null, "Input model with nested model properties", InputModelTypeUsage.Input, + var model = new InputModelType("InputModel", "NestedModelsBasic.Models", "public", null, null, "Input model with nested model properties", InputModelTypeUsage.Input, new List { - new InputModelProperty("NestedInputModel", "NestedInputModel", "Required nested input model.", NestedInputOnlyModelType, null, true, false, false), + new InputModelProperty("NestedInputModel", "NestedInputModel", null, "Required nested input model.", NestedInputOnlyModelType, null, true, false, false), NestedRoundTripSharedModelProperty }, null, new List(), null, null, null, null); @@ -50,10 +50,10 @@ public void InputModel(string expectedModelCodes, string expectedSerializationCo public void OutpuModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/7435655e82b732b3573379f76e0e613423d244e9/packages/cadl-ranch-specs/http/models/nested-models/main.cadl#L51-L58 - var model = new InputModelType("OutputModel", "NestedModelsBasic.Models", "public", null, "Output model with nested model properties", InputModelTypeUsage.Output, + var model = new InputModelType("OutputModel", "NestedModelsBasic.Models", "public", null, null, "Output model with nested model properties", InputModelTypeUsage.Output, new List { - new InputModelProperty("NestedOutputModel", "NestedOutputModel", "Required nested output model.", NestedOutputOnlyModelType, null, true, false, false), + new InputModelProperty("NestedOutputModel", "NestedOutputModel", null, "Required nested output model.", NestedOutputOnlyModelType, null, true, false, false), NestedRoundTripSharedModelProperty }, null, new List(), null, null, null, null); @@ -64,23 +64,23 @@ public void OutpuModel(string expectedModelCodes, string expectedSerializationCo ValidateGeneratedCodes("OutputModel", expectedModelCodes, expectedSerializationCodes, library); } - private static readonly InputModelType NestedInputOnlyModelType = new InputModelType("NestedInputOnlyModel", "NestedInputOnlyModel", "public", null, "Model to illustrate a nested model that only appears on an input model.", InputModelTypeUsage.Input, + private static readonly InputModelType NestedInputOnlyModelType = new InputModelType("NestedInputOnlyModel", "NestedInputOnlyModel", "public", null, null, "Model to illustrate a nested model that only appears on an input model.", InputModelTypeUsage.Input, new List { RequiredStringProperty, RequiredIntProperty, RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); - private static readonly InputModelType NestedOutputOnlyModelType = new InputModelType("NestedOutputOnlyModel", "NestedOutputOnlyModel", "public", null, "Model to illustrate a nested model that only appears on an ouput model.", InputModelTypeUsage.Output, + private static readonly InputModelType NestedOutputOnlyModelType = new InputModelType("NestedOutputOnlyModel", "NestedOutputOnlyModel", "public", null, null, "Model to illustrate a nested model that only appears on an ouput model.", InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty, RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); - private static readonly InputModelType NestedRoundTripOnlyModelType = new InputModelType("NestedRoundTripOnlyModel", "NestedRoundTripOnlyModel", "public", null, "Model to illustrate a nested model that only appears on a nested model.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + private static readonly InputModelType NestedRoundTripOnlyModelType = new InputModelType("NestedRoundTripOnlyModel", "NestedRoundTripOnlyModel", "public", null, null, "Model to illustrate a nested model that only appears on a nested model.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty, RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); - private static readonly InputModelType NestedRoundTripSharedModelType = new InputModelType("NestedRoundTripSharedModel", "NestedRoundTripSharedModel", "public", null, "Model to illustrate a nested model that appears as a nested model on input, output, and round-trip models.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + private static readonly InputModelType NestedRoundTripSharedModelType = new InputModelType("NestedRoundTripSharedModel", "NestedRoundTripSharedModel", "public", null, null, "Model to illustrate a nested model that appears as a nested model on input, output, and round-trip models.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, new List { RequiredStringProperty, RequiredIntProperty, RequiredStringListProperty, RequiredIntListProperty }, null, new List(), null, null, null, null); - private static readonly InputModelProperty NestedRoundTripSharedModelProperty = new InputModelProperty("NestedSharedModel", "NestedSharedModel", "Required nested shared model.", NestedRoundTripSharedModelType, null, true, false, false); + private static readonly InputModelProperty NestedRoundTripSharedModelProperty = new InputModelProperty("NestedSharedModel", "NestedSharedModel", null, "Required nested shared model.", NestedRoundTripSharedModelType, null, true, false, false); // below are test cases private static readonly object[] RoundTripCase = diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/OptionalPropertyWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/OptionalPropertyWritingTests.cs index 98117197746..ceb26e0a349 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/OptionalPropertyWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/OptionalPropertyWritingTests.cs @@ -12,7 +12,7 @@ public class OptionalPropertyWritingTests : ModelGenerationTestBase public void RoundTripModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/bed837a2e29e55569360206afa3393e044dfb070/packages/cadl-ranch-specs/http/models/optional-properties/main.cadl#L35-L38 - var model = new InputModelType("RoundTripModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, "Round-trip model with optional properties.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var model = new InputModelType("RoundTripModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, null, "Round-trip model with optional properties.", InputModelTypeUsage.Input | InputModelTypeUsage.Output, OptionalProperties, null, Array.Empty(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.OptionalProperties.Models", new List(), @@ -25,7 +25,7 @@ public void RoundTripModel(string expectedModelCodes, string expectedSerializati public void InputModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/bed837a2e29e55569360206afa3393e044dfb070/packages/cadl-ranch-specs/http/models/optional-properties/main.cadl#L15-L28 - var model = new InputModelType("InputModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, "Input model with optional properties.", InputModelTypeUsage.Input, + var model = new InputModelType("InputModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, null, "Input model with optional properties.", InputModelTypeUsage.Input, OptionalProperties, null, Array.Empty(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.OptionalProperties.Models", new List(), @@ -38,7 +38,7 @@ public void InputModel(string expectedModelCodes, string expectedSerializationCo public void OutputModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/bed837a2e29e55569360206afa3393e044dfb070/packages/cadl-ranch-specs/http/models/optional-properties/main.cadl#L30-L33 - var model = new InputModelType("OutputModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, "Output model with optional properties.", InputModelTypeUsage.Output, + var model = new InputModelType("OutputModel", "Cadl.TestServer.OptionalProperties.Models", "public", null, null, "Output model with optional properties.", InputModelTypeUsage.Output, OptionalProperties, null, Array.Empty(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.OptionalProperties.Models", new List(), @@ -48,12 +48,12 @@ public void OutputModel(string expectedModelCodes, string expectedSerializationC } private static readonly IReadOnlyList OptionalProperties = new List{ - new InputModelProperty("optionalString", "optionalString", "Optional string, illustrating an optional reference type property.", InputPrimitiveType.String, null, false, false, false), - new InputModelProperty("optionalInt", "optionalInt", "Optional int, illustrating an optional reference type property.", InputPrimitiveType.Int32, null, false, false, false), - new InputModelProperty("optionalStringList", "optionalStringList", "Optional string collection.", new InputListType("optionalStringList", string.Empty, InputPrimitiveType.String), null, false, false, false), - new InputModelProperty("optionalIntList", "optionalIntList", "Optional int collection.", new InputListType("optionalIntList", string.Empty, InputPrimitiveType.Int32), null, false, false, false), - new InputModelProperty("optionalModelCollection", "optionalModelCollection", "Optional collection of models.", new InputListType("optionalModelCollection", string.Empty, ElementModelType), null, false, false, false), - new InputModelProperty("optionalModelDictionary", "optionalModelDictionary", "Optional dictionary of models.", new InputDictionaryType("optionalModelDictionary", InputPrimitiveType.String, ElementModelType), null, false, false, false) + new InputModelProperty("optionalString", "optionalString", null, "Optional string, illustrating an optional reference type property.", InputPrimitiveType.String, null, false, false, false), + new InputModelProperty("optionalInt", "optionalInt", null, "Optional int, illustrating an optional reference type property.", InputPrimitiveType.Int32, null, false, false, false), + new InputModelProperty("optionalStringList", "optionalStringList", null, "Optional string collection.", new InputListType("optionalStringList", string.Empty, InputPrimitiveType.String), null, false, false, false), + new InputModelProperty("optionalIntList", "optionalIntList", null, "Optional int collection.", new InputListType("optionalIntList", string.Empty, InputPrimitiveType.Int32), null, false, false, false), + new InputModelProperty("optionalModelCollection", "optionalModelCollection", null, "Optional collection of models.", new InputListType("optionalModelCollection", string.Empty, ElementModelType), null, false, false, false), + new InputModelProperty("optionalModelDictionary", "optionalModelDictionary", null, "Optional dictionary of models.", new InputDictionaryType("optionalModelDictionary", InputPrimitiveType.String, ElementModelType), null, false, false, false) }; // below are test cases diff --git a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ReadonlyPropertyWritingTests.cs b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ReadonlyPropertyWritingTests.cs index 5b9f3514710..cd89a90b500 100644 --- a/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ReadonlyPropertyWritingTests.cs +++ b/test/AutoRest.TestServerLowLevel.Tests/LowLevel/Generation/ReadonlyPropertyWritingTests.cs @@ -12,7 +12,7 @@ public class ReadonlyPropertyWritingTests : ModelGenerationTestBase public void RoundTripModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/main/packages/cadl-ranch-specs/http/models/readonly-properties/main.cadl - var model = new InputModelType("RoundTripModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, "Readonly model", InputModelTypeUsage.Input | InputModelTypeUsage.Output, + var model = new InputModelType("RoundTripModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, null, "Readonly model", InputModelTypeUsage.Input | InputModelTypeUsage.Output, ReadOnlyProperties, null, Array.Empty(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.ReadonlyProperties.Models", new List(), @@ -25,7 +25,7 @@ public void RoundTripModel(string expectedModelCodes, string expectedSerializati public void OutputModel(string expectedModelCodes, string expectedSerializationCodes) { // refer to the original CADL file: https://github.com/Azure/cadl-ranch/blob/dc6d00c98983f34b2f723c90fe840678a863438c/packages/cadl-ranch-specs/http/models/readonly-properties/main.cadl#L24-L65 - var model = new InputModelType("OutputModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, "Readonly model", InputModelTypeUsage.Output, + var model = new InputModelType("OutputModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, null, "Readonly model", InputModelTypeUsage.Output, ReadOnlyProperties, null, Array.Empty(), null, null, null, null); var library = new DpgOutputLibraryBuilder(new InputNamespace("Cadl.TestServer.ReadonlyProperties.Models", new List(), @@ -35,24 +35,24 @@ public void OutputModel(string expectedModelCodes, string expectedSerializationC } // below are test cases - private static readonly InputModelType ReadonlyModel = new InputModelType("ReadonlyModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, "Readonly model", InputModelTypeUsage.Output, + private static readonly InputModelType ReadonlyModel = new InputModelType("ReadonlyModel", "Cadl.TestServer.ReadonlyProperties.Models", "public", null, null, "Readonly model", InputModelTypeUsage.Output, new List { RequiredStringProperty }, null, Array.Empty(), null, null, null, null); private static readonly IReadOnlyList ReadOnlyProperties = new List{ - new InputModelProperty("requiredReadonlyString", "requiredReadonlyString", "Required string, illustrating a readonly reference type property.", InputPrimitiveType.String, null, true, true, false), - new InputModelProperty("requiredReadonlyInt", "requiredReadonlyInt", "Required int, illustrating a readonly reference type property.", InputPrimitiveType.Int32, null, true, true, false), - new InputModelProperty("optionalReadonlyString", "optionalReadonlyString", "Optional string, illustrating a readonly reference type property.", InputPrimitiveType.String, null, false, true, false), - new InputModelProperty("optionalReadonlyInt", "optionalReadonlyInt", "Optional int, illustrating a readonly reference type property.", InputPrimitiveType.Int32, null, false, true, false), - new InputModelProperty("requiredReadonlyModel", "requiredReadonlyModel", "Required readonly model.", ReadonlyModel, null, true, true, false), - new InputModelProperty("optionalReadonlyModel", "optionalReadonlyModel", "Optional readonly model", ReadonlyModel, null, false, true, false), - new InputModelProperty("requiredReadonlyStringList", "requiredReadonlyStringList", "Required readonly string collection.", new InputListType("requiredReadonlyStringList", string.Empty, InputPrimitiveType.String), null, true, true, false), - new InputModelProperty("requiredReadonlyIntList", "requiredReadonlyIntList", "Required readonly int collection.", new InputListType("requiredReadonlyIntList", string.Empty, InputPrimitiveType.Int32), null, true, true, false), - new InputModelProperty("optionalReadonlyStringList", "optionalReadonlyStringList", "Optional readonly string collection.", new InputListType("optionalReadonlyStringList", string.Empty, InputPrimitiveType.String), null, false, true, false), - new InputModelProperty("optionalReadonlyIntList", "optionalReadonlyIntList", "Optional readonly int collection.", new InputListType("optionalReadonlyIntList", string.Empty, InputPrimitiveType.Int32), null, false, true, false), - new InputModelProperty("requiredReadonlyStringDictionary", "requiredReadonlyStringDictionary", "Required readonly string collection.", new InputDictionaryType("requiredReadonlyStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, true, true, false), - new InputModelProperty("requiredReadonlyIntDictionary", "requiredReadonlyIntDictionary", "Required readonly int collection.", new InputDictionaryType("requiredReadonlyIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, true, true, false), - new InputModelProperty("optionalReadonlyStringDictionary", "optionalReadonlyStringDictionary", "Optional readonly string collection.", new InputDictionaryType("optionalReadonlyStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, false, true, false), - new InputModelProperty("optionalReadonlyIntDictionary", "optionalReadonlyIntDictionary", "Optional readonly int collection.", new InputDictionaryType("optionalReadonlyIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, false, true, false), + new InputModelProperty("requiredReadonlyString", "requiredReadonlyString", null, "Required string, illustrating a readonly reference type property.", InputPrimitiveType.String, null, true, true, false), + new InputModelProperty("requiredReadonlyInt", "requiredReadonlyInt", null, "Required int, illustrating a readonly reference type property.", InputPrimitiveType.Int32, null, true, true, false), + new InputModelProperty("optionalReadonlyString", "optionalReadonlyString", null, "Optional string, illustrating a readonly reference type property.", InputPrimitiveType.String, null, false, true, false), + new InputModelProperty("optionalReadonlyInt", "optionalReadonlyInt", null, "Optional int, illustrating a readonly reference type property.", InputPrimitiveType.Int32, null, false, true, false), + new InputModelProperty("requiredReadonlyModel", "requiredReadonlyModel", null, "Required readonly model.", ReadonlyModel, null, true, true, false), + new InputModelProperty("optionalReadonlyModel", "optionalReadonlyModel", null, "Optional readonly model", ReadonlyModel, null, false, true, false), + new InputModelProperty("requiredReadonlyStringList", "requiredReadonlyStringList", null, "Required readonly string collection.", new InputListType("requiredReadonlyStringList", string.Empty, InputPrimitiveType.String), null, true, true, false), + new InputModelProperty("requiredReadonlyIntList", "requiredReadonlyIntList", null, "Required readonly int collection.", new InputListType("requiredReadonlyIntList", string.Empty, InputPrimitiveType.Int32), null, true, true, false), + new InputModelProperty("optionalReadonlyStringList", "optionalReadonlyStringList", null, "Optional readonly string collection.", new InputListType("optionalReadonlyStringList", string.Empty, InputPrimitiveType.String), null, false, true, false), + new InputModelProperty("optionalReadonlyIntList", "optionalReadonlyIntList", null, "Optional readonly int collection.", new InputListType("optionalReadonlyIntList", string.Empty, InputPrimitiveType.Int32), null, false, true, false), + new InputModelProperty("requiredReadonlyStringDictionary", "requiredReadonlyStringDictionary", null, "Required readonly string collection.", new InputDictionaryType("requiredReadonlyStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, true, true, false), + new InputModelProperty("requiredReadonlyIntDictionary", "requiredReadonlyIntDictionary", null, "Required readonly int collection.", new InputDictionaryType("requiredReadonlyIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, true, true, false), + new InputModelProperty("optionalReadonlyStringDictionary", "optionalReadonlyStringDictionary", null, "Optional readonly string collection.", new InputDictionaryType("optionalReadonlyStringDictionary", InputPrimitiveType.String, InputPrimitiveType.String), null, false, true, false), + new InputModelProperty("optionalReadonlyIntDictionary", "optionalReadonlyIntDictionary", null, "Optional readonly int collection.", new InputDictionaryType("optionalReadonlyIntDictionary", InputPrimitiveType.Int32, InputPrimitiveType.Int32), null, false, true, false), }; private static readonly object[] RoundTripModelCase = diff --git a/test/CadlRanchProjects/authentication/api-key/tspCodeModel.json b/test/CadlRanchProjects/authentication/api-key/tspCodeModel.json index fc72c08e84d..f021c5ff051 100644 --- a/test/CadlRanchProjects/authentication/api-key/tspCodeModel.json +++ b/test/CadlRanchProjects/authentication/api-key/tspCodeModel.json @@ -38,13 +38,13 @@ { "$id": "5", "Name": "ApiKeyClient", - "Description": "Illustrates clients generated with ApiKey authentication.", + "Doc": "Illustrates clients generated with ApiKey authentication.", "Operations": [ { "$id": "6", "Name": "valid", "ResourceName": "ApiKey", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -72,7 +72,7 @@ "$id": "8", "Name": "invalid", "ResourceName": "ApiKey", - "Description": "Check whether client is authenticated.", + "Doc": "Check whether client is authenticated.", "Accessibility": "public", "Parameters": [ { @@ -133,7 +133,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjects/authentication/http/custom/tspCodeModel.json b/test/CadlRanchProjects/authentication/http/custom/tspCodeModel.json index 3cb96146845..839735c8460 100644 --- a/test/CadlRanchProjects/authentication/http/custom/tspCodeModel.json +++ b/test/CadlRanchProjects/authentication/http/custom/tspCodeModel.json @@ -38,13 +38,13 @@ { "$id": "5", "Name": "CustomClient", - "Description": "Illustrates clients generated with generic HTTP auth.", + "Doc": "Illustrates clients generated with generic HTTP auth.", "Operations": [ { "$id": "6", "Name": "valid", "ResourceName": "Custom", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -72,7 +72,7 @@ "$id": "8", "Name": "invalid", "ResourceName": "Custom", - "Description": "Check whether client is authenticated.", + "Doc": "Check whether client is authenticated.", "Accessibility": "public", "Parameters": [ { @@ -133,7 +133,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjects/authentication/oauth2/tspCodeModel.json b/test/CadlRanchProjects/authentication/oauth2/tspCodeModel.json index f6950afdf7e..633272e9a99 100644 --- a/test/CadlRanchProjects/authentication/oauth2/tspCodeModel.json +++ b/test/CadlRanchProjects/authentication/oauth2/tspCodeModel.json @@ -38,13 +38,13 @@ { "$id": "5", "Name": "OAuth2Client", - "Description": "Illustrates clients generated with OAuth2 authentication.", + "Doc": "Illustrates clients generated with OAuth2 authentication.", "Operations": [ { "$id": "6", "Name": "valid", "ResourceName": "OAuth2", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -72,7 +72,7 @@ "$id": "8", "Name": "invalid", "ResourceName": "OAuth2", - "Description": "Check whether client is authenticated. Will return an invalid bearer error.", + "Doc": "Check whether client is authenticated. Will return an invalid bearer error.", "Accessibility": "public", "Parameters": [ { @@ -133,7 +133,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjects/authentication/union/tspCodeModel.json b/test/CadlRanchProjects/authentication/union/tspCodeModel.json index 8871b5313bf..a45094e11e4 100644 --- a/test/CadlRanchProjects/authentication/union/tspCodeModel.json +++ b/test/CadlRanchProjects/authentication/union/tspCodeModel.json @@ -8,13 +8,13 @@ { "$id": "2", "Name": "UnionClient", - "Description": "Illustrates clients generated with ApiKey and OAuth2 authentication.", + "Doc": "Illustrates clients generated with ApiKey and OAuth2 authentication.", "Operations": [ { "$id": "3", "Name": "validKey", "ResourceName": "Union", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -42,7 +42,7 @@ "$id": "5", "Name": "validToken", "ResourceName": "Union", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -75,7 +75,7 @@ "$id": "8", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "9", "kind": "url", diff --git a/test/CadlRanchProjects/azure/client-generator-core/access/tspCodeModel.json b/test/CadlRanchProjects/azure/client-generator-core/access/tspCodeModel.json index 9f83d279c64..606b647a56f 100644 --- a/test/CadlRanchProjects/azure/client-generator-core/access/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/client-generator-core/access/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "OuterModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.RelativeModelInOperation.OuterModel", "usage": "Output,Json", - "description": "Used in internal operations, should be generated but not exported.", + "doc": "Used in internal operations, should be generated but not exported.", "decorators": [], "baseModel": { "$id": "3", @@ -18,7 +18,7 @@ "name": "BaseModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.RelativeModelInOperation.BaseModel", "usage": "Output,Json", - "description": "Used in internal operations, should be generated but not exported.", + "doc": "Used in internal operations, should be generated but not exported.", "decorators": [], "properties": [ { @@ -54,7 +54,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.RelativeModelInOperation.InnerModel", "usage": "Output,Json", - "description": "Used in internal operations, should be generated but not exported.", + "doc": "Used in internal operations, should be generated but not exported.", "decorators": [], "properties": [ { @@ -99,14 +99,14 @@ "name": "AbstractModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.RelativeModelInOperation.AbstractModel", "usage": "Output,Json", - "description": "Used in internal operations, should be generated but not exported.", + "doc": "Used in internal operations, should be generated but not exported.", "decorators": [], "discriminatorProperty": { "$id": "11", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "Discriminator property for AbstractModel.", + "doc": "Discriminator property for AbstractModel.", "type": { "$id": "12", "kind": "string", @@ -153,7 +153,7 @@ "name": "RealModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.RelativeModelInOperation.RealModel", "usage": "Output,Json", - "description": "Used in internal operations, should be generated but not exported.", + "doc": "Used in internal operations, should be generated but not exported.", "discriminatorValue": "real", "decorators": [], "baseModel": { @@ -198,7 +198,7 @@ "name": "SharedModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.SharedModelInOperation.SharedModel", "usage": "Output,Json", - "description": "Used by both public and internal operation. It should be generated and exported.", + "doc": "Used by both public and internal operation. It should be generated and exported.", "decorators": [], "properties": [ { @@ -228,7 +228,7 @@ "name": "NoDecoratorModelInInternal", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.InternalOperation.NoDecoratorModelInInternal", "usage": "Output,Json", - "description": "Used in an internal operation, should be generated but not exported.", + "doc": "Used in an internal operation, should be generated but not exported.", "decorators": [], "properties": [ { @@ -259,7 +259,7 @@ "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.InternalOperation.InternalDecoratorModelInInternal", "access": "internal", "usage": "Output,Json", - "description": "Used in an internal operation, should be generated but not exported.", + "doc": "Used in an internal operation, should be generated but not exported.", "decorators": [], "properties": [ { @@ -290,7 +290,7 @@ "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.InternalOperation.PublicDecoratorModelInInternal", "access": "public", "usage": "Output,Json", - "description": "Used in an internal operation but with public decorator, should be generated and exported.", + "doc": "Used in an internal operation but with public decorator, should be generated and exported.", "decorators": [], "properties": [ { @@ -320,7 +320,7 @@ "name": "NoDecoratorModelInPublic", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.PublicOperation.NoDecoratorModelInPublic", "usage": "Output,Json", - "description": "Used in a public operation, should be generated and exported.", + "doc": "Used in a public operation, should be generated and exported.", "decorators": [], "properties": [ { @@ -351,7 +351,7 @@ "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Access.PublicOperation.PublicDecoratorModelInPublic", "access": "public", "usage": "Output,Json", - "description": "Used in a public operation, should be generated and exported.", + "doc": "Used in a public operation, should be generated and exported.", "decorators": [], "properties": [ { @@ -380,7 +380,7 @@ { "$id": "38", "Name": "AccessClient", - "Description": "Test for internal decorator.", + "Doc": "Test for internal decorator.", "Operations": [], "Protocol": { "$id": "39" @@ -390,7 +390,7 @@ "$id": "40", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "41", "kind": "url", @@ -598,7 +598,7 @@ "$id": "60", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "61", "kind": "url", @@ -888,7 +888,7 @@ "$id": "87", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "88", "kind": "url", @@ -1096,7 +1096,7 @@ "$id": "107", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "108", "kind": "url", @@ -1134,7 +1134,7 @@ "$id": "112", "Name": "operation", "ResourceName": "RelativeModelInOperation", - "Description": "Expected query parameter: name=\"Madge\"\nExpected response body:\n```json\n{\n \"name\": \"Madge\",\n \"inner\":\n {\n \"name\": \"Madge\"\n }\n}\n```", + "Doc": "Expected query parameter: name=\"Madge\"\nExpected response body:\n```json\n{\n \"name\": \"Madge\",\n \"inner\":\n {\n \"name\": \"Madge\"\n }\n}\n```", "Accessibility": "internal", "Parameters": [ { @@ -1217,7 +1217,7 @@ "$id": "119", "Name": "discriminator", "ResourceName": "RelativeModelInOperation", - "Description": "Expected query parameter: kind= \"real\"\nExpected response body:\n```json\n{\n \"name\": \"Madge\",\n \"kind\": \"real\"\n}\n```", + "Doc": "Expected query parameter: kind= \"real\"\nExpected response body:\n```json\n{\n \"name\": \"Madge\",\n \"kind\": \"real\"\n}\n```", "Accessibility": "internal", "Parameters": [ { @@ -1306,7 +1306,7 @@ "$id": "127", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "128", "kind": "url", diff --git a/test/CadlRanchProjects/azure/client-generator-core/flatten-property/tspCodeModel.json b/test/CadlRanchProjects/azure/client-generator-core/flatten-property/tspCodeModel.json index e83e0ae4284..8e77dd1bf9e 100644 --- a/test/CadlRanchProjects/azure/client-generator-core/flatten-property/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/client-generator-core/flatten-property/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "FlattenModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.FlattenProperty.FlattenModel", "usage": "Input,Output,Json", - "description": "This is the model with one level of flattening.", + "doc": "This is the model with one level of flattening.", "decorators": [], "properties": [ { @@ -43,7 +43,7 @@ "name": "ChildModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.FlattenProperty.ChildModel", "usage": "Input,Output,Json", - "description": "This is the child model to be flattened.", + "doc": "This is the child model to be flattened.", "decorators": [], "properties": [ { @@ -104,7 +104,7 @@ "name": "NestedFlattenModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.FlattenProperty.NestedFlattenModel", "usage": "Input,Output,Json", - "description": "This is the model with two levels of flattening.", + "doc": "This is the model with two levels of flattening.", "decorators": [], "properties": [ { @@ -137,7 +137,7 @@ "name": "ChildFlattenModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.FlattenProperty.ChildFlattenModel", "usage": "Input,Output,Json", - "description": "This is the child model to be flattened. And it has flattened property as well.", + "doc": "This is the child model to be flattened. And it has flattened property as well.", "decorators": [], "properties": [ { @@ -193,7 +193,7 @@ { "$id": "19", "Name": "FlattenPropertyClient", - "Description": "Illustrates the model flatten cases.", + "Doc": "Illustrates the model flatten cases.", "Operations": [ { "$id": "20", @@ -205,7 +205,7 @@ "$id": "21", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "22", "kind": "constant", @@ -314,7 +314,7 @@ "$id": "30", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "31", "kind": "constant", @@ -422,7 +422,7 @@ "$id": "39", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "40", "kind": "url", diff --git a/test/CadlRanchProjects/azure/client-generator-core/usage/tspCodeModel.json b/test/CadlRanchProjects/azure/client-generator-core/usage/tspCodeModel.json index d8a06282f4a..05a4c82d04b 100644 --- a/test/CadlRanchProjects/azure/client-generator-core/usage/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/client-generator-core/usage/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InputModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Usage.ModelInOperation.InputModel", "usage": "Input,Output,Json", - "description": "Usage override to roundtrip.", + "doc": "Usage override to roundtrip.", "decorators": [], "properties": [ { @@ -40,7 +40,7 @@ "name": "OutputModel", "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Usage.ModelInOperation.OutputModel", "usage": "Input,Output,Json", - "description": "Usage override to roundtrip.", + "doc": "Usage override to roundtrip.", "decorators": [], "properties": [ { @@ -125,7 +125,7 @@ "crossLanguageDefinitionId": "_Specs_.Azure.ClientGenerator.Core.Usage.OrphanModel", "access": "public", "usage": "Input", - "description": "Not used anywhere, but access is override to public so still need to be generated and exported with serialization.", + "doc": "Not used anywhere, but access is override to public so still need to be generated and exported with serialization.", "decorators": [], "properties": [ { @@ -154,7 +154,7 @@ { "$id": "16", "Name": "UsageClient", - "Description": "Test for internal decorator.", + "Doc": "Test for internal decorator.", "Operations": [], "Protocol": { "$id": "17" @@ -164,7 +164,7 @@ "$id": "18", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "19", "kind": "url", @@ -202,14 +202,14 @@ "$id": "23", "Name": "inputToInputOutput", "ResourceName": "ModelInOperation", - "Description": "Expected body parameter: \n```json\n{\n \"name\": \"Madge\"\n}\n```", + "Doc": "Expected body parameter: \n```json\n{\n \"name\": \"Madge\"\n}\n```", "Accessibility": "public", "Parameters": [ { "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -279,7 +279,7 @@ "$id": "29", "Name": "outputToInputOutput", "ResourceName": "ModelInOperation", - "Description": "Expected response body: \n```json\n{\n \"name\": \"Madge\"\n}\n```", + "Doc": "Expected response body: \n```json\n{\n \"name\": \"Madge\"\n}\n```", "Accessibility": "public", "Parameters": [ { @@ -341,14 +341,14 @@ "$id": "34", "Name": "modelInReadOnlyProperty", "ResourceName": "ModelInOperation", - "Description": "\"ResultModel\" should be usage=output, as it is read-only and does not exist in request body.\n\nExpected body parameter: \n```json\n{\n}\n```\n\nExpected response body: \n```json\n{\n \"result\": {\n \"name\": \"Madge\"\n }\n}\n```", + "Doc": "\"ResultModel\" should be usage=output, as it is read-only and does not exist in request body.\n\nExpected body parameter: \n```json\n{\n}\n```\n\nExpected response body: \n```json\n{\n \"result\": {\n \"name\": \"Madge\"\n }\n}\n```", "Accessibility": "public", "Parameters": [ { "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -457,7 +457,7 @@ "$id": "44", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "45", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/basic/tspCodeModel.json b/test/CadlRanchProjects/azure/core/basic/tspCodeModel.json index f38d572d6ee..62951d493b2 100644 --- a/test/CadlRanchProjects/azure/core/basic/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/basic/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -51,7 +51,7 @@ "name": "User", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Basic.User", "usage": "Input,Output,Json", - "description": "Details about a user.", + "doc": "Details about a user.", "decorators": [], "properties": [ { @@ -59,7 +59,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "8", "kind": "int32", @@ -79,7 +79,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The user's name.", + "doc": "The user's name.", "type": { "$id": "10", "kind": "string", @@ -99,7 +99,7 @@ "kind": "property", "name": "orders", "serializedName": "orders", - "description": "The user's order list", + "doc": "The user's order list", "type": { "$id": "12", "kind": "array", @@ -110,7 +110,7 @@ "name": "UserOrder", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Basic.UserOrder", "usage": "Input,Output,Json", - "description": "UserOrder for testing list with expand.", + "doc": "UserOrder for testing list with expand.", "decorators": [], "properties": [ { @@ -118,7 +118,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "15", "kind": "int32", @@ -138,7 +138,7 @@ "kind": "property", "name": "userId", "serializedName": "userId", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "17", "kind": "int32", @@ -158,7 +158,7 @@ "kind": "property", "name": "detail", "serializedName": "detail", - "description": "The user's order detail", + "doc": "The user's order detail", "type": { "$id": "19", "kind": "string", @@ -190,7 +190,7 @@ "kind": "property", "name": "etag", "serializedName": "etag", - "description": "The entity tag for this resource.", + "doc": "The entity tag for this resource.", "type": { "$id": "21", "kind": "string", @@ -255,7 +255,7 @@ "name": "PagedUser", "crossLanguageDefinitionId": "Azure.Core.Foundations.CustomPage", "usage": "Output,Json", - "description": "Paged collection of User items", + "doc": "Paged collection of User items", "decorators": [], "properties": [ { @@ -263,7 +263,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The User items on this page", + "doc": "The User items on this page", "type": { "$id": "28", "kind": "array", @@ -286,7 +286,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "30", "kind": "url", @@ -315,21 +315,21 @@ { "$id": "32", "Name": "BasicClient", - "Description": "Illustrates bodies templated with Azure Core", + "Doc": "Illustrates bodies templated with Azure Core", "Operations": [ { "$id": "33", "Name": "createOrUpdate", "ResourceName": "User", "Summary": "Adds a user or updates a user's fields.", - "Description": "Creates or updates a User", + "Doc": "Creates or updates a User", "Accessibility": "public", "Parameters": [ { "$id": "34", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "35", "kind": "string", @@ -361,7 +361,7 @@ "$id": "38", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "39", "kind": "int32", @@ -383,7 +383,7 @@ "$id": "40", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "This request has a JSON Merge Patch body.", + "Doc": "This request has a JSON Merge Patch body.", "Type": { "$id": "41", "kind": "constant", @@ -438,7 +438,7 @@ "$id": "46", "Name": "resource", "NameInRequest": "resource", - "Description": "The resource instance.", + "Doc": "The resource instance.", "Type": { "$ref": "6" }, @@ -503,14 +503,14 @@ "Name": "createOrReplace", "ResourceName": "User", "Summary": "Adds a user or replaces a user's fields.", - "Description": "Creates or replaces a User", + "Doc": "Creates or replaces a User", "Accessibility": "public", "Parameters": [ { "$id": "50", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "51", "kind": "string", @@ -542,7 +542,7 @@ "$id": "54", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "55", "kind": "int32", @@ -564,7 +564,7 @@ "$id": "56", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "57", "kind": "constant", @@ -619,7 +619,7 @@ "$id": "62", "Name": "resource", "NameInRequest": "resource", - "Description": "The resource instance.", + "Doc": "The resource instance.", "Type": { "$ref": "6" }, @@ -684,14 +684,14 @@ "Name": "get", "ResourceName": "User", "Summary": "Gets a user.", - "Description": "Gets a User", + "Doc": "Gets a User", "Accessibility": "public", "Parameters": [ { "$id": "66", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "67", "kind": "string", @@ -723,7 +723,7 @@ "$id": "70", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "71", "kind": "int32", @@ -801,14 +801,14 @@ "Name": "list", "ResourceName": "User", "Summary": "Lists all users.", - "Description": "Lists all Users", + "Doc": "Lists all Users", "Accessibility": "public", "Parameters": [ { "$id": "77", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "78", "kind": "string", @@ -840,7 +840,7 @@ "$id": "81", "Name": "top", "NameInRequest": "top", - "Description": "The number of result items to return.", + "Doc": "The number of result items to return.", "Type": { "$id": "82", "kind": "int32", @@ -862,7 +862,7 @@ "$id": "83", "Name": "skip", "NameInRequest": "skip", - "Description": "The number of result items to skip.", + "Doc": "The number of result items to skip.", "Type": { "$id": "84", "kind": "int32", @@ -884,7 +884,7 @@ "$id": "85", "Name": "maxpagesize", "NameInRequest": "maxpagesize", - "Description": "The maximum number of result items per page.", + "Doc": "The maximum number of result items per page.", "Type": { "$id": "86", "kind": "int32", @@ -906,7 +906,7 @@ "$id": "87", "Name": "orderby", "NameInRequest": "orderby", - "Description": "Expressions that specify the order of returned results.", + "Doc": "Expressions that specify the order of returned results.", "Type": { "$id": "88", "kind": "array", @@ -935,7 +935,7 @@ "$id": "90", "Name": "filter", "NameInRequest": "filter", - "Description": "Filter the result list using the given expression.", + "Doc": "Filter the result list using the given expression.", "Type": { "$id": "91", "kind": "string", @@ -957,7 +957,7 @@ "$id": "92", "Name": "select", "NameInRequest": "select", - "Description": "Select the specified fields to be included in the response.", + "Doc": "Select the specified fields to be included in the response.", "Type": { "$id": "93", "kind": "array", @@ -986,7 +986,7 @@ "$id": "95", "Name": "expand", "NameInRequest": "expand", - "Description": "Expand the indicated resources into the response.", + "Doc": "Expand the indicated resources into the response.", "Type": { "$id": "96", "kind": "array", @@ -1076,14 +1076,14 @@ "Name": "delete", "ResourceName": "User", "Summary": "Deletes a user.", - "Description": "Deletes a User", + "Doc": "Deletes a User", "Accessibility": "public", "Parameters": [ { "$id": "104", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "105", "kind": "string", @@ -1115,7 +1115,7 @@ "$id": "108", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "109", "kind": "int32", @@ -1187,14 +1187,14 @@ "Name": "export", "ResourceName": "Basic", "Summary": "Exports a user.", - "Description": "Exports a User", + "Doc": "Exports a User", "Accessibility": "public", "Parameters": [ { "$id": "115", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "116", "kind": "string", @@ -1226,7 +1226,7 @@ "$id": "119", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "120", "kind": "int32", @@ -1248,7 +1248,7 @@ "$id": "121", "Name": "format", "NameInRequest": "format", - "Description": "The format of the data.", + "Doc": "The format of the data.", "Type": { "$id": "122", "kind": "string", @@ -1326,14 +1326,14 @@ "Name": "exportAllUsers", "ResourceName": "Basic", "Summary": "Exports all users.", - "Description": "Exports all users", + "Doc": "Exports all users", "Accessibility": "public", "Parameters": [ { "$id": "128", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "129", "kind": "string", @@ -1365,7 +1365,7 @@ "$id": "132", "Name": "format", "NameInRequest": "format", - "Description": "The format of the data.", + "Doc": "The format of the data.", "Type": { "$id": "133", "kind": "string", @@ -1447,7 +1447,7 @@ "$id": "139", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "140", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/lro/rpc/tspCodeModel.json b/test/CadlRanchProjects/azure/core/lro/rpc/tspCodeModel.json index a45cd0bfe56..4a6b185b1f7 100644 --- a/test/CadlRanchProjects/azure/core/lro/rpc/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/lro/rpc/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "The 2022-12-01-preview version.", + "doc": "The 2022-12-01-preview version.", "decorators": [] } ], - "description": "The API version.", + "doc": "The API version.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -71,7 +71,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has not started.", + "doc": "The operation has not started.", "decorators": [] }, { @@ -89,7 +89,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation is in progress.", + "doc": "The operation is in progress.", "decorators": [] }, { @@ -107,7 +107,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has completed successfully.", + "doc": "The operation has completed successfully.", "decorators": [] }, { @@ -125,7 +125,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has failed.", + "doc": "The operation has failed.", "decorators": [] }, { @@ -143,11 +143,11 @@ "enumType": { "$ref": "6" }, - "description": "The operation has been canceled by the user.", + "doc": "The operation has been canceled by the user.", "decorators": [] } ], - "description": "Enum describing allowed operation states.", + "doc": "Enum describing allowed operation states.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -161,7 +161,7 @@ "name": "GenerationOptions", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Lro.Rpc.GenerationOptions", "usage": "Input,Json", - "description": "Options for the generation.", + "doc": "Options for the generation.", "decorators": [], "properties": [ { @@ -169,7 +169,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "Prompt.", + "doc": "Prompt.", "type": { "$id": "20", "kind": "string", @@ -192,7 +192,7 @@ "name": "GenerationResult", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Lro.Rpc.GenerationResult", "usage": "Output,Json", - "description": "Result of the generation.", + "doc": "Result of the generation.", "decorators": [], "properties": [ { @@ -200,7 +200,7 @@ "kind": "property", "name": "data", "serializedName": "data", - "description": "The data.", + "doc": "The data.", "type": { "$id": "23", "kind": "string", @@ -223,7 +223,7 @@ "name": "ResourceOperationStatusGenerationResponseGenerationResultError", "crossLanguageDefinitionId": "Azure.Core.ResourceOperationStatus", "usage": "Output,Json", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -231,7 +231,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "26", "kind": "string", @@ -251,7 +251,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "6" }, @@ -267,14 +267,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$id": "29", "kind": "model", "name": "Error", "crossLanguageDefinitionId": "Azure.Core.Foundations.Error", "usage": "Output,Json", - "description": "The error object.", + "doc": "The error object.", "decorators": [], "properties": [ { @@ -282,7 +282,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "31", "kind": "string", @@ -302,7 +302,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A human-readable representation of the error.", + "doc": "A human-readable representation of the error.", "type": { "$id": "33", "kind": "string", @@ -322,7 +322,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The target of the error.", + "doc": "The target of the error.", "type": { "$id": "35", "kind": "string", @@ -342,7 +342,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "An array of details about specific errors that led to this reported error.", + "doc": "An array of details about specific errors that led to this reported error.", "type": { "$id": "37", "kind": "array", @@ -365,14 +365,14 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "An object containing more specific information than the current object about the error.", + "doc": "An object containing more specific information than the current object about the error.", "type": { "$id": "39", "kind": "model", "name": "InnerError", "crossLanguageDefinitionId": "Azure.Core.Foundations.InnerError", "usage": "Output,Json", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "doc": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "decorators": [], "properties": [ { @@ -380,7 +380,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "41", "kind": "string", @@ -400,7 +400,7 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "Inner error.", + "doc": "Inner error.", "type": { "$ref": "39" }, @@ -434,7 +434,7 @@ "kind": "property", "name": "result", "serializedName": "result", - "description": "The result of the operation.", + "doc": "The result of the operation.", "type": { "$ref": "21" }, @@ -459,7 +459,7 @@ "name": "OperationStatusGenerationResultError", "crossLanguageDefinitionId": "Azure.Core.Foundations.OperationStatus", "usage": "Output", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -467,7 +467,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "46", "kind": "string", @@ -487,7 +487,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "6" }, @@ -503,7 +503,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$ref": "29" }, @@ -519,7 +519,7 @@ "kind": "property", "name": "result", "serializedName": "result", - "description": "The result of the operation.", + "doc": "The result of the operation.", "type": { "$ref": "21" }, @@ -537,21 +537,21 @@ { "$id": "50", "Name": "RpcClient", - "Description": "Illustrates bodies templated with Azure Core with long-running RPC operation", + "Doc": "Illustrates bodies templated with Azure Core with long-running RPC operation", "Operations": [ { "$id": "51", "Name": "longRunningRpc", "ResourceName": "Rpc", "Summary": "Generate data.", - "Description": "Generate data.", + "Doc": "Generate data.", "Accessibility": "public", "Parameters": [ { "$id": "52", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "53", "kind": "string", @@ -583,7 +583,7 @@ "$id": "56", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "57", "kind": "constant", @@ -638,7 +638,7 @@ "$id": "62", "Name": "body", "NameInRequest": "body", - "Description": "The body parameter.", + "Doc": "The body parameter.", "Type": { "$ref": "18" }, @@ -668,7 +668,7 @@ "$id": "64", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "65", "kind": "url", @@ -728,7 +728,7 @@ "$id": "70", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "71", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/lro/standard/tspCodeModel.json b/test/CadlRanchProjects/azure/core/lro/standard/tspCodeModel.json index cf090437d42..90c65dafd82 100644 --- a/test/CadlRanchProjects/azure/core/lro/standard/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/lro/standard/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "The 2022-12-01-preview version.", + "doc": "The 2022-12-01-preview version.", "decorators": [] } ], - "description": "The API version.", + "doc": "The API version.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -71,7 +71,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has not started.", + "doc": "The operation has not started.", "decorators": [] }, { @@ -89,7 +89,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation is in progress.", + "doc": "The operation is in progress.", "decorators": [] }, { @@ -107,7 +107,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has completed successfully.", + "doc": "The operation has completed successfully.", "decorators": [] }, { @@ -125,7 +125,7 @@ "enumType": { "$ref": "6" }, - "description": "The operation has failed.", + "doc": "The operation has failed.", "decorators": [] }, { @@ -143,11 +143,11 @@ "enumType": { "$ref": "6" }, - "description": "The operation has been canceled by the user.", + "doc": "The operation has been canceled by the user.", "decorators": [] } ], - "description": "Enum describing allowed operation states.", + "doc": "Enum describing allowed operation states.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -161,7 +161,7 @@ "name": "User", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Lro.Standard.User", "usage": "Input,Output,Json", - "description": "Details about a user.", + "doc": "Details about a user.", "decorators": [], "properties": [ { @@ -169,7 +169,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of user.", + "doc": "The name of user.", "type": { "$id": "20", "kind": "string", @@ -189,7 +189,7 @@ "kind": "property", "name": "role", "serializedName": "role", - "description": "The role of user", + "doc": "The role of user", "type": { "$id": "22", "kind": "string", @@ -212,7 +212,7 @@ "name": "ExportedUser", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Lro.Standard.ExportedUser", "usage": "Output,Json", - "description": "The exported user data.", + "doc": "The exported user data.", "decorators": [], "properties": [ { @@ -220,7 +220,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of user.", + "doc": "The name of user.", "type": { "$id": "25", "kind": "string", @@ -240,7 +240,7 @@ "kind": "property", "name": "resourceUri", "serializedName": "resourceUri", - "description": "The exported URI.", + "doc": "The exported URI.", "type": { "$id": "27", "kind": "string", @@ -263,7 +263,7 @@ "name": "OperationStatusError", "crossLanguageDefinitionId": "Azure.Core.Foundations.OperationStatus", "usage": "Output,Json", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -271,7 +271,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "30", "kind": "string", @@ -291,7 +291,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "6" }, @@ -307,14 +307,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$id": "33", "kind": "model", "name": "Error", "crossLanguageDefinitionId": "Azure.Core.Foundations.Error", "usage": "Output,Json", - "description": "The error object.", + "doc": "The error object.", "decorators": [], "properties": [ { @@ -322,7 +322,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "35", "kind": "string", @@ -342,7 +342,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A human-readable representation of the error.", + "doc": "A human-readable representation of the error.", "type": { "$id": "37", "kind": "string", @@ -362,7 +362,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The target of the error.", + "doc": "The target of the error.", "type": { "$id": "39", "kind": "string", @@ -382,7 +382,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "An array of details about specific errors that led to this reported error.", + "doc": "An array of details about specific errors that led to this reported error.", "type": { "$id": "41", "kind": "array", @@ -405,14 +405,14 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "An object containing more specific information than the current object about the error.", + "doc": "An object containing more specific information than the current object about the error.", "type": { "$id": "43", "kind": "model", "name": "InnerError", "crossLanguageDefinitionId": "Azure.Core.Foundations.InnerError", "usage": "Output,Json", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "doc": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "decorators": [], "properties": [ { @@ -420,7 +420,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "45", "kind": "string", @@ -440,7 +440,7 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "Inner error.", + "doc": "Inner error.", "type": { "$ref": "43" }, @@ -483,7 +483,7 @@ "name": "ResourceOperationStatusUserExportedUserError", "crossLanguageDefinitionId": "Azure.Core.ResourceOperationStatus", "usage": "Output,Json", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -491,7 +491,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "49", "kind": "string", @@ -511,7 +511,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "6" }, @@ -527,7 +527,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$ref": "33" }, @@ -543,7 +543,7 @@ "kind": "property", "name": "result", "serializedName": "result", - "description": "The result of the operation.", + "doc": "The result of the operation.", "type": { "$ref": "23" }, @@ -562,7 +562,7 @@ "name": "OperationStatusExportedUserError", "crossLanguageDefinitionId": "Azure.Core.Foundations.OperationStatus", "usage": "Output", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -570,7 +570,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "55", "kind": "string", @@ -590,7 +590,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "6" }, @@ -606,7 +606,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$ref": "33" }, @@ -622,7 +622,7 @@ "kind": "property", "name": "result", "serializedName": "result", - "description": "The result of the operation.", + "doc": "The result of the operation.", "type": { "$ref": "23" }, @@ -640,21 +640,21 @@ { "$id": "59", "Name": "StandardClient", - "Description": "Illustrates bodies templated with Azure Core with long-running operation", + "Doc": "Illustrates bodies templated with Azure Core with long-running operation", "Operations": [ { "$id": "60", "Name": "createOrReplace", "ResourceName": "User", "Summary": "Adds a user or replaces a user's fields.", - "Description": "Creates or replaces a User", + "Doc": "Creates or replaces a User", "Accessibility": "public", "Parameters": [ { "$id": "61", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "62", "kind": "string", @@ -686,7 +686,7 @@ "$id": "65", "Name": "name", "NameInRequest": "name", - "Description": "The name of user.", + "Doc": "The name of user.", "Type": { "$id": "66", "kind": "string", @@ -708,7 +708,7 @@ "$id": "67", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "68", "kind": "constant", @@ -763,7 +763,7 @@ "$id": "73", "Name": "resource", "NameInRequest": "resource", - "Description": "The resource instance.", + "Doc": "The resource instance.", "Type": { "$ref": "18" }, @@ -793,7 +793,7 @@ "$id": "75", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "76", "kind": "url", @@ -829,7 +829,7 @@ "$id": "79", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "80", "kind": "url", @@ -884,14 +884,14 @@ "Name": "delete", "ResourceName": "User", "Summary": "Deletes a user.", - "Description": "Deletes a User", + "Doc": "Deletes a User", "Accessibility": "public", "Parameters": [ { "$id": "85", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "86", "kind": "string", @@ -923,7 +923,7 @@ "$id": "89", "Name": "name", "NameInRequest": "name", - "Description": "The name of user.", + "Doc": "The name of user.", "Type": { "$id": "90", "kind": "string", @@ -984,7 +984,7 @@ "$id": "95", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "96", "kind": "url", @@ -1033,14 +1033,14 @@ "Name": "export", "ResourceName": "Standard", "Summary": "Exports a user.", - "Description": "Exports a User", + "Doc": "Exports a User", "Accessibility": "public", "Parameters": [ { "$id": "101", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "102", "kind": "string", @@ -1072,7 +1072,7 @@ "$id": "105", "Name": "name", "NameInRequest": "name", - "Description": "The name of user.", + "Doc": "The name of user.", "Type": { "$id": "106", "kind": "string", @@ -1094,7 +1094,7 @@ "$id": "107", "Name": "format", "NameInRequest": "format", - "Description": "The format of the data.", + "Doc": "The format of the data.", "Type": { "$id": "108", "kind": "string", @@ -1155,7 +1155,7 @@ "$id": "113", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "114", "kind": "url", @@ -1212,7 +1212,7 @@ "$id": "119", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "120", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/model/tspCodeModel.json b/test/CadlRanchProjects/azure/core/model/tspCodeModel.json index e48fa476ece..0e70c741e00 100644 --- a/test/CadlRanchProjects/azure/core/model/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/model/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -95,7 +95,7 @@ "$id": "12", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "13", "kind": "url", @@ -133,7 +133,7 @@ "$id": "17", "Name": "get", "ResourceName": "AzureCoreEmbeddingVector", - "Description": "get an embedding vector", + "Doc": "get an embedding vector", "Accessibility": "public", "Parameters": [ { @@ -206,14 +206,14 @@ "$id": "24", "Name": "put", "ResourceName": "AzureCoreEmbeddingVector", - "Description": "put an embedding vector", + "Doc": "put an embedding vector", "Accessibility": "public", "Parameters": [ { "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -241,7 +241,7 @@ "$id": "28", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "29", "kind": "array", @@ -295,14 +295,14 @@ "$id": "32", "Name": "post", "ResourceName": "AzureCoreEmbeddingVector", - "Description": "post a model which has an embeddingVector property", + "Doc": "post a model which has an embeddingVector property", "Accessibility": "public", "Parameters": [ { "$id": "33", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "34", "kind": "constant", @@ -357,7 +357,7 @@ "$id": "39", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "6" }, @@ -412,7 +412,7 @@ "$id": "42", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "43", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/page/tspCodeModel.json b/test/CadlRanchProjects/azure/core/page/tspCodeModel.json index 785c1d4f92f..dbd871905ba 100644 --- a/test/CadlRanchProjects/azure/core/page/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/page/tspCodeModel.json @@ -33,7 +33,7 @@ "enumType": { "$ref": "2" }, - "description": "The first enum value.", + "doc": "The first enum value.", "decorators": [] }, { @@ -51,11 +51,11 @@ "enumType": { "$ref": "2" }, - "description": "The second enum value.", + "doc": "The second enum value.", "decorators": [] } ], - "description": "An extensible enum input parameter.", + "doc": "An extensible enum input parameter.", "isFixed": true, "isFlags": false, "usage": "Input", @@ -89,11 +89,11 @@ "enumType": { "$ref": "8" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -107,7 +107,7 @@ "name": "User", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Page.User", "usage": "Output,Json", - "description": "Details about a user.", + "doc": "Details about a user.", "decorators": [], "properties": [ { @@ -115,7 +115,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "14", "kind": "int32", @@ -135,7 +135,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The user's name.", + "doc": "The user's name.", "type": { "$id": "16", "kind": "string", @@ -155,7 +155,7 @@ "kind": "property", "name": "orders", "serializedName": "orders", - "description": "The user's order list", + "doc": "The user's order list", "type": { "$id": "18", "kind": "array", @@ -166,7 +166,7 @@ "name": "UserOrder", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Page.UserOrder", "usage": "Output,Json", - "description": "UserOrder for testing list with expand.", + "doc": "UserOrder for testing list with expand.", "decorators": [], "properties": [ { @@ -174,7 +174,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "21", "kind": "int32", @@ -194,7 +194,7 @@ "kind": "property", "name": "userId", "serializedName": "userId", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "23", "kind": "int32", @@ -214,7 +214,7 @@ "kind": "property", "name": "detail", "serializedName": "detail", - "description": "The user's order detail", + "doc": "The user's order detail", "type": { "$id": "25", "kind": "string", @@ -246,7 +246,7 @@ "kind": "property", "name": "etag", "serializedName": "etag", - "description": "The entity tag for this resource.", + "doc": "The entity tag for this resource.", "type": { "$id": "27", "kind": "string", @@ -279,7 +279,7 @@ "name": "ListItemInputBody", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Page.ListItemInputBody", "usage": "Input,Json", - "description": "The body of the input.", + "doc": "The body of the input.", "decorators": [], "properties": [ { @@ -287,7 +287,7 @@ "kind": "property", "name": "inputName", "serializedName": "inputName", - "description": "The name of the input.", + "doc": "The name of the input.", "type": { "$id": "31", "kind": "string", @@ -317,7 +317,7 @@ "kind": "property", "name": "items", "serializedName": "items", - "description": "List of items.", + "doc": "List of items.", "type": { "$id": "34", "kind": "array", @@ -340,7 +340,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "Link to fetch more items.", + "doc": "Link to fetch more items.", "type": { "$id": "36", "kind": "string", @@ -363,7 +363,7 @@ "name": "FirstItem", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Page.FirstItem", "usage": "Output,Json", - "description": "First item.", + "doc": "First item.", "decorators": [], "properties": [ { @@ -371,7 +371,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id of the item.", + "doc": "The id of the item.", "type": { "$id": "39", "kind": "int32", @@ -394,7 +394,7 @@ "name": "SecondItem", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Page.SecondItem", "usage": "Output,Json", - "description": "Second item.", + "doc": "Second item.", "decorators": [], "properties": [ { @@ -402,7 +402,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the item.", + "doc": "The name of the item.", "type": { "$id": "42", "kind": "string", @@ -425,7 +425,7 @@ "name": "PagedUser", "crossLanguageDefinitionId": "Azure.Core.Page", "usage": "Output,Json", - "description": "Paged collection of User items", + "doc": "Paged collection of User items", "decorators": [], "properties": [ { @@ -433,7 +433,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The User items on this page", + "doc": "The User items on this page", "type": { "$id": "45", "kind": "array", @@ -456,7 +456,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "47", "kind": "url", @@ -486,7 +486,7 @@ "name": "PagedFirstItem", "crossLanguageDefinitionId": "Azure.Core.Page", "usage": "Output,Json", - "description": "Paged collection of FirstItem items", + "doc": "Paged collection of FirstItem items", "decorators": [], "properties": [ { @@ -494,7 +494,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The FirstItem items on this page", + "doc": "The FirstItem items on this page", "type": { "$id": "51", "kind": "array", @@ -517,7 +517,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "53", "kind": "url", @@ -547,7 +547,7 @@ "name": "PagedSecondItem", "crossLanguageDefinitionId": "Azure.Core.Page", "usage": "Output,Json", - "description": "Paged collection of SecondItem items", + "doc": "Paged collection of SecondItem items", "decorators": [], "properties": [ { @@ -555,7 +555,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The SecondItem items on this page", + "doc": "The SecondItem items on this page", "type": { "$id": "57", "kind": "array", @@ -578,7 +578,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "59", "kind": "url", @@ -607,20 +607,20 @@ { "$id": "61", "Name": "PageClient", - "Description": "Illustrates bodies templated with Azure Core with paging support", + "Doc": "Illustrates bodies templated with Azure Core with paging support", "Operations": [ { "$id": "62", "Name": "listWithPage", "ResourceName": "Page", - "Description": "List with Azure.Core.Page<>.", + "Doc": "List with Azure.Core.Page<>.", "Accessibility": "public", "Parameters": [ { "$id": "63", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "64", "kind": "string", @@ -712,14 +712,14 @@ "$id": "72", "Name": "listWithParameters", "ResourceName": "Page", - "Description": "List with extensible enum parameter Azure.Core.Page<>.", + "Doc": "List with extensible enum parameter Azure.Core.Page<>.", "Accessibility": "public", "Parameters": [ { "$id": "73", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "74", "kind": "string", @@ -751,7 +751,7 @@ "$id": "77", "Name": "another", "NameInRequest": "another", - "Description": "Another query parameter.", + "Doc": "Another query parameter.", "Type": { "$ref": "2" }, @@ -769,7 +769,7 @@ "$id": "78", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "79", "kind": "constant", @@ -824,7 +824,7 @@ "$id": "84", "Name": "bodyInput", "NameInRequest": "bodyInput", - "Description": "The body of the input.", + "Doc": "The body of the input.", "Type": { "$ref": "29" }, @@ -878,14 +878,14 @@ "$id": "87", "Name": "listWithCustomPageModel", "ResourceName": "Page", - "Description": "List with custom page model.", + "Doc": "List with custom page model.", "Accessibility": "public", "Parameters": [ { "$id": "88", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "89", "kind": "string", @@ -982,7 +982,7 @@ "$id": "98", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "99", "kind": "url", @@ -1020,14 +1020,14 @@ "$id": "103", "Name": "listFirstItem", "ResourceName": "TwoModelsAsPageItem", - "Description": "Two operations with two different page item types should be successfully generated. Should generate model for FirstItem.", + "Doc": "Two operations with two different page item types should be successfully generated. Should generate model for FirstItem.", "Accessibility": "public", "Parameters": [ { "$id": "104", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "105", "kind": "string", @@ -1119,14 +1119,14 @@ "$id": "113", "Name": "listSecondItem", "ResourceName": "TwoModelsAsPageItem", - "Description": "Two operations with two different page item types should be successfully generated. Should generate model for SecondItem.", + "Doc": "Two operations with two different page item types should be successfully generated. Should generate model for SecondItem.", "Accessibility": "public", "Parameters": [ { "$id": "114", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "115", "kind": "string", @@ -1224,7 +1224,7 @@ "$id": "124", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "125", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/scalar/tspCodeModel.json b/test/CadlRanchProjects/azure/core/scalar/tspCodeModel.json index 6eda0080618..ea3f31f8f6e 100644 --- a/test/CadlRanchProjects/azure/core/scalar/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/scalar/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -95,7 +95,7 @@ "$id": "12", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "13", "kind": "url", @@ -133,7 +133,7 @@ "$id": "17", "Name": "get", "ResourceName": "AzureLocationScalar", - "Description": "get azureLocation value", + "Doc": "get azureLocation value", "Accessibility": "public", "Parameters": [ { @@ -206,14 +206,14 @@ "$id": "24", "Name": "put", "ResourceName": "AzureLocationScalar", - "Description": "put azureLocation value", + "Doc": "put azureLocation value", "Accessibility": "public", "Parameters": [ { "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -241,7 +241,7 @@ "$id": "28", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "29", "kind": "string", @@ -295,14 +295,14 @@ "$id": "32", "Name": "post", "ResourceName": "AzureLocationScalar", - "Description": "post a model which has azureLocation property", + "Doc": "post a model which has azureLocation property", "Accessibility": "public", "Parameters": [ { "$id": "33", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "34", "kind": "constant", @@ -357,7 +357,7 @@ "$id": "39", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "6" }, @@ -406,14 +406,14 @@ "$id": "41", "Name": "header", "ResourceName": "AzureLocationScalar", - "Description": "azureLocation value header", + "Doc": "azureLocation value header", "Accessibility": "public", "Parameters": [ { "$id": "42", "Name": "region", "NameInRequest": "region", - "Description": "_", + "Doc": "_", "Type": { "$id": "43", "kind": "string", @@ -464,14 +464,14 @@ "$id": "46", "Name": "query", "ResourceName": "AzureLocationScalar", - "Description": "azureLocation value query", + "Doc": "azureLocation value query", "Accessibility": "public", "Parameters": [ { "$id": "47", "Name": "region", "NameInRequest": "region", - "Description": "_", + "Doc": "_", "Type": { "$id": "48", "kind": "string", @@ -528,7 +528,7 @@ "$id": "52", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "53", "kind": "url", diff --git a/test/CadlRanchProjects/azure/core/traits/tspCodeModel.json b/test/CadlRanchProjects/azure/core/traits/tspCodeModel.json index e94204c2423..c397ec6cee2 100644 --- a/test/CadlRanchProjects/azure/core/traits/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/core/traits/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "2022-12-01-preview", + "doc": "2022-12-01-preview", "decorators": [] } ], - "description": "Service versions", + "doc": "Service versions", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -71,7 +71,7 @@ "enumType": { "$ref": "6" }, - "description": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.", + "doc": "If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.", "decorators": [] }, { @@ -89,11 +89,11 @@ "enumType": { "$ref": "6" }, - "description": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server.", + "doc": "If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid\nor because the Repeatability-First-Sent value was outside the range of values held by the server.", "decorators": [] } ], - "description": "Repeatability Result header options", + "doc": "Repeatability Result header options", "isFixed": true, "isFlags": false, "usage": "Output", @@ -107,7 +107,7 @@ "name": "User", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Traits.User", "usage": "Output,Json", - "description": "Sample Model", + "doc": "Sample Model", "decorators": [], "properties": [ { @@ -115,7 +115,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The user's id.", + "doc": "The user's id.", "type": { "$id": "14", "kind": "int32", @@ -135,7 +135,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The user's name.", + "doc": "The user's name.", "type": { "$id": "16", "kind": "string", @@ -158,7 +158,7 @@ "name": "UserActionParam", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Traits.UserActionParam", "usage": "Input,Json", - "description": "User action param", + "doc": "User action param", "decorators": [], "properties": [ { @@ -166,7 +166,7 @@ "kind": "property", "name": "userActionValue", "serializedName": "userActionValue", - "description": "User action value.", + "doc": "User action value.", "type": { "$id": "19", "kind": "string", @@ -189,7 +189,7 @@ "name": "UserActionResponse", "crossLanguageDefinitionId": "_Specs_.Azure.Core.Traits.UserActionResponse", "usage": "Output,Json", - "description": "User action response", + "doc": "User action response", "decorators": [], "properties": [ { @@ -197,7 +197,7 @@ "kind": "property", "name": "userActionResult", "serializedName": "userActionResult", - "description": "User action result.", + "doc": "User action result.", "type": { "$id": "22", "kind": "string", @@ -219,20 +219,20 @@ { "$id": "23", "Name": "TraitsClient", - "Description": "Illustrates Azure Core operation customizations by traits", + "Doc": "Illustrates Azure Core operation customizations by traits", "Operations": [ { "$id": "24", "Name": "smokeTest", "ResourceName": "User", - "Description": "Get a resource, sending and receiving headers.", + "Doc": "Get a resource, sending and receiving headers.", "Accessibility": "public", "Parameters": [ { "$id": "25", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "26", "kind": "string", @@ -264,7 +264,7 @@ "$id": "29", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "30", "kind": "int32", @@ -286,7 +286,7 @@ "$id": "31", "Name": "foo", "NameInRequest": "foo", - "Description": "header in request", + "Doc": "header in request", "Type": { "$id": "32", "kind": "string", @@ -308,7 +308,7 @@ "$id": "33", "Name": "ifMatch", "NameInRequest": "If-Match", - "Description": "The request should only proceed if an entity matches this string.", + "Doc": "The request should only proceed if an entity matches this string.", "Type": { "$id": "34", "kind": "string", @@ -330,7 +330,7 @@ "$id": "35", "Name": "ifNoneMatch", "NameInRequest": "If-None-Match", - "Description": "The request should only proceed if no entity matches this string.", + "Doc": "The request should only proceed if no entity matches this string.", "Type": { "$id": "36", "kind": "string", @@ -352,7 +352,7 @@ "$id": "37", "Name": "ifUnmodifiedSince", "NameInRequest": "If-Unmodified-Since", - "Description": "The request should only proceed if the entity was not modified after this time.", + "Doc": "The request should only proceed if the entity was not modified after this time.", "Type": { "$id": "38", "kind": "utcDateTime", @@ -382,7 +382,7 @@ "$id": "40", "Name": "ifModifiedSince", "NameInRequest": "If-Modified-Since", - "Description": "The request should only proceed if the entity was modified after this time.", + "Doc": "The request should only proceed if the entity was modified after this time.", "Type": { "$id": "41", "kind": "utcDateTime", @@ -412,7 +412,7 @@ "$id": "43", "Name": "clientRequestId", "NameInRequest": "x-ms-client-request-id", - "Description": "An opaque, globally-unique, client-generated string identifier for the request.", + "Doc": "An opaque, globally-unique, client-generated string identifier for the request.", "Type": { "$id": "44", "kind": "string", @@ -492,7 +492,7 @@ "$id": "52", "Name": "etagHeader", "NameInResponse": "ETag", - "Description": "The entity tag for the response.", + "Doc": "The entity tag for the response.", "Type": { "$id": "53", "kind": "string", @@ -505,7 +505,7 @@ "$id": "54", "Name": "clientRequestId", "NameInResponse": "x-ms-client-request-id", - "Description": "An opaque, globally-unique, client-generated string identifier for the request.", + "Doc": "An opaque, globally-unique, client-generated string identifier for the request.", "Type": { "$id": "55", "kind": "string", @@ -542,14 +542,14 @@ "$id": "57", "Name": "repeatableAction", "ResourceName": "Traits", - "Description": "Test for repeatable requests", + "Doc": "Test for repeatable requests", "Accessibility": "public", "Parameters": [ { "$id": "58", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "59", "kind": "string", @@ -581,7 +581,7 @@ "$id": "62", "Name": "id", "NameInRequest": "id", - "Description": "The user's id.", + "Doc": "The user's id.", "Type": { "$id": "63", "kind": "int32", @@ -603,7 +603,7 @@ "$id": "64", "Name": "repeatabilityRequestId", "NameInRequest": "Repeatability-Request-ID", - "Description": "An opaque, globally-unique, client-generated string identifier for the request.", + "Doc": "An opaque, globally-unique, client-generated string identifier for the request.", "Type": { "$id": "65", "kind": "string", @@ -625,7 +625,7 @@ "$id": "66", "Name": "repeatabilityFirstSent", "NameInRequest": "Repeatability-First-Sent", - "Description": "Specifies the date and time at which the request was first created.", + "Doc": "Specifies the date and time at which the request was first created.", "Type": { "$id": "67", "kind": "utcDateTime", @@ -655,7 +655,7 @@ "$id": "69", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "70", "kind": "constant", @@ -710,7 +710,7 @@ "$id": "75", "Name": "body", "NameInRequest": "body", - "Description": "The body parameter.", + "Doc": "The body parameter.", "Type": { "$ref": "17" }, @@ -740,7 +740,7 @@ "$id": "77", "Name": "repeatabilityResult", "NameInResponse": "Repeatability-Result", - "Description": "Indicates whether the repeatable request was accepted or rejected.", + "Doc": "Indicates whether the repeatable request was accepted or rejected.", "Type": { "$ref": "6" } @@ -774,7 +774,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", diff --git a/test/CadlRanchProjects/azure/example/basic/tspCodeModel.json b/test/CadlRanchProjects/azure/example/basic/tspCodeModel.json index 7b279741c39..8b71478f559 100644 --- a/test/CadlRanchProjects/azure/example/basic/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/example/basic/tspCodeModel.json @@ -360,7 +360,7 @@ "$id": "40", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "41", "kind": "string", @@ -434,7 +434,7 @@ "$id": "48", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "49", "kind": "constant", @@ -697,7 +697,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", diff --git a/test/CadlRanchProjects/azure/resource-manager/common-properties/tspCodeModel.json b/test/CadlRanchProjects/azure/resource-manager/common-properties/tspCodeModel.json index 1b3088f3ae4..48f47c8a9f6 100644 --- a/test/CadlRanchProjects/azure/resource-manager/common-properties/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/resource-manager/common-properties/tspCodeModel.json @@ -33,7 +33,7 @@ "enumType": { "$ref": "2" }, - "description": "No managed identity.", + "doc": "No managed identity.", "decorators": [] }, { @@ -51,7 +51,7 @@ "enumType": { "$ref": "2" }, - "description": "System assigned managed identity.", + "doc": "System assigned managed identity.", "decorators": [] }, { @@ -69,7 +69,7 @@ "enumType": { "$ref": "2" }, - "description": "User assigned managed identity.", + "doc": "User assigned managed identity.", "decorators": [] }, { @@ -87,11 +87,11 @@ "enumType": { "$ref": "2" }, - "description": "System and user assigned managed identity.", + "doc": "System and user assigned managed identity.", "decorators": [] } ], - "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "doc": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -125,7 +125,7 @@ "enumType": { "$ref": "12" }, - "description": "The entity was created by a user.", + "doc": "The entity was created by a user.", "decorators": [] }, { @@ -143,7 +143,7 @@ "enumType": { "$ref": "12" }, - "description": "The entity was created by an application.", + "doc": "The entity was created by an application.", "decorators": [] }, { @@ -161,7 +161,7 @@ "enumType": { "$ref": "12" }, - "description": "The entity was created by a managed identity.", + "doc": "The entity was created by a managed identity.", "decorators": [] }, { @@ -179,11 +179,11 @@ "enumType": { "$ref": "12" }, - "description": "The entity was created by a key.", + "doc": "The entity was created by a key.", "decorators": [] } ], - "description": "The kind of entity that created the resource.", + "doc": "The kind of entity that created the resource.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -217,11 +217,11 @@ "enumType": { "$ref": "22" }, - "description": "Preview API version 2023-12-01-preview.", + "doc": "Preview API version 2023-12-01-preview.", "decorators": [] } ], - "description": "Azure API versions.", + "doc": "Azure API versions.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -235,7 +235,7 @@ "name": "ManagedIdentityTrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonProperties.ManagedIdentityTrackedResource", "usage": "Input,Output,Json", - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "doc": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "decorators": [], "baseModel": { "$id": "27", @@ -243,7 +243,7 @@ "name": "TrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.TrackedResource", "usage": "Input,Output,Json", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "doc": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "decorators": [], "baseModel": { "$id": "28", @@ -251,7 +251,7 @@ "name": "Resource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.Resource", "usage": "Input,Output,Json", - "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "doc": "Common fields that are returned in the response for all Azure Resource Manager resources", "decorators": [], "properties": [ { @@ -259,7 +259,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "doc": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "type": { "$id": "30", "kind": "string", @@ -279,7 +279,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the resource", + "doc": "The name of the resource", "type": { "$id": "32", "kind": "string", @@ -299,7 +299,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "doc": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "type": { "$id": "34", "kind": "string", @@ -319,14 +319,14 @@ "kind": "property", "name": "systemData", "serializedName": "systemData", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "doc": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", "type": { "$id": "36", "kind": "model", "name": "SystemData", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.SystemData", "usage": "Output,Json", - "description": "Metadata pertaining to creation and last modification of the resource.", + "doc": "Metadata pertaining to creation and last modification of the resource.", "decorators": [], "properties": [ { @@ -334,7 +334,7 @@ "kind": "property", "name": "createdBy", "serializedName": "createdBy", - "description": "The identity that created the resource.", + "doc": "The identity that created the resource.", "type": { "$id": "38", "kind": "string", @@ -354,7 +354,7 @@ "kind": "property", "name": "createdByType", "serializedName": "createdByType", - "description": "The type of identity that created the resource.", + "doc": "The type of identity that created the resource.", "type": { "$ref": "12" }, @@ -370,7 +370,7 @@ "kind": "property", "name": "createdAt", "serializedName": "createdAt", - "description": "The timestamp of resource creation (UTC).", + "doc": "The timestamp of resource creation (UTC).", "type": { "$id": "41", "kind": "utcDateTime", @@ -398,7 +398,7 @@ "kind": "property", "name": "lastModifiedBy", "serializedName": "lastModifiedBy", - "description": "The identity that last modified the resource.", + "doc": "The identity that last modified the resource.", "type": { "$id": "44", "kind": "string", @@ -418,7 +418,7 @@ "kind": "property", "name": "lastModifiedByType", "serializedName": "lastModifiedByType", - "description": "The type of identity that last modified the resource.", + "doc": "The type of identity that last modified the resource.", "type": { "$ref": "12" }, @@ -434,7 +434,7 @@ "kind": "property", "name": "lastModifiedAt", "serializedName": "lastModifiedAt", - "description": "The timestamp of resource last modification (UTC)", + "doc": "The timestamp of resource last modification (UTC)", "type": { "$id": "47", "kind": "utcDateTime", @@ -474,7 +474,7 @@ "kind": "property", "name": "tags", "serializedName": "tags", - "description": "Resource tags.", + "doc": "Resource tags.", "type": { "$id": "50", "kind": "dict", @@ -506,7 +506,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The geo-location where the resource lives", + "doc": "The geo-location where the resource lives", "type": { "$id": "54", "kind": "string", @@ -529,14 +529,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "56", "kind": "model", "name": "ManagedIdentityTrackedResourceProperties", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonProperties.ManagedIdentityTrackedResourceProperties", "usage": "Input,Output,Json", - "description": "Managed Identity Arm Resource Properties.", + "doc": "Managed Identity Arm Resource Properties.", "decorators": [], "properties": [ { @@ -544,7 +544,7 @@ "kind": "property", "name": "provisioningState", "serializedName": "provisioningState", - "description": "The status of the last operation.", + "doc": "The status of the last operation.", "type": { "$id": "58", "kind": "string", @@ -573,14 +573,14 @@ "kind": "property", "name": "identity", "serializedName": "identity", - "description": "The managed service identities assigned to this resource.", + "doc": "The managed service identities assigned to this resource.", "type": { "$id": "60", "kind": "model", "name": "ManagedServiceIdentity", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentity", "usage": "Input,Output,Json", - "description": "Managed service identity (system assigned and/or user assigned identities)", + "doc": "Managed service identity (system assigned and/or user assigned identities)", "decorators": [], "properties": [ { @@ -588,7 +588,7 @@ "kind": "property", "name": "principalId", "serializedName": "principalId", - "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.", + "doc": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.", "type": { "$id": "62", "kind": "string", @@ -615,7 +615,7 @@ "kind": "property", "name": "tenantId", "serializedName": "tenantId", - "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.", + "doc": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.", "type": { "$id": "65", "kind": "string", @@ -642,7 +642,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of managed identity assigned to this resource.", + "doc": "The type of managed identity assigned to this resource.", "type": { "$ref": "2" }, @@ -658,7 +658,7 @@ "kind": "property", "name": "userAssignedIdentities", "serializedName": "userAssignedIdentities", - "description": "The identities assigned to this resource by the user.", + "doc": "The identities assigned to this resource by the user.", "type": { "$id": "69", "kind": "dict", @@ -675,7 +675,7 @@ "name": "UserAssignedIdentity", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.UserAssignedIdentity", "usage": "Input,Output,Json", - "description": "User assigned identity properties", + "doc": "User assigned identity properties", "decorators": [], "properties": [ { @@ -683,7 +683,7 @@ "kind": "property", "name": "principalId", "serializedName": "principalId", - "description": "The principal ID of the assigned identity.", + "doc": "The principal ID of the assigned identity.", "type": { "$id": "73", "kind": "string", @@ -710,7 +710,7 @@ "kind": "property", "name": "clientId", "serializedName": "clientId", - "description": "The client ID of the assigned identity.", + "doc": "The client ID of the assigned identity.", "type": { "$id": "76", "kind": "string", @@ -778,7 +778,7 @@ "name": "ErrorResponse", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorResponse", "usage": "Output,Error,Json", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "doc": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "decorators": [], "properties": [ { @@ -786,14 +786,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "The error object.", + "doc": "The error object.", "type": { "$id": "80", "kind": "model", "name": "ErrorDetail", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorDetail", "usage": "Output,Json", - "description": "The error detail.", + "doc": "The error detail.", "decorators": [], "properties": [ { @@ -801,7 +801,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$id": "82", "kind": "string", @@ -821,7 +821,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The error message.", + "doc": "The error message.", "type": { "$id": "84", "kind": "string", @@ -841,7 +841,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The error target.", + "doc": "The error target.", "type": { "$id": "86", "kind": "string", @@ -861,7 +861,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "The error details.", + "doc": "The error details.", "type": { "$id": "88", "kind": "array", @@ -884,7 +884,7 @@ "kind": "property", "name": "additionalInfo", "serializedName": "additionalInfo", - "description": "The error additional info.", + "doc": "The error additional info.", "type": { "$id": "90", "kind": "array", @@ -895,7 +895,7 @@ "name": "ErrorAdditionalInfo", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo", "usage": "Output,Json", - "description": "The resource management error additional info.", + "doc": "The resource management error additional info.", "decorators": [], "properties": [ { @@ -903,7 +903,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The additional info type.", + "doc": "The additional info type.", "type": { "$id": "93", "kind": "string", @@ -923,7 +923,7 @@ "kind": "property", "name": "info", "serializedName": "info", - "description": "The additional info.", + "doc": "The additional info.", "type": { "$id": "95", "kind": "model", @@ -977,7 +977,7 @@ { "$id": "96", "Name": "CommonPropertiesClient", - "Description": "Arm Managed Identity Provider management API.", + "Doc": "Arm Managed Identity Provider management API.", "Operations": [], "Protocol": { "$id": "97" @@ -987,7 +987,7 @@ "$id": "98", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "99", "kind": "url", @@ -1025,14 +1025,14 @@ "$id": "103", "Name": "get", "ResourceName": "ManagedIdentityTrackedResource", - "Description": "Get a ManagedIdentityTrackedResource", + "Doc": "Get a ManagedIdentityTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "104", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "105", "kind": "string", @@ -1064,7 +1064,7 @@ "$id": "108", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "109", "kind": "string", @@ -1086,7 +1086,7 @@ "$id": "110", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "111", "kind": "string", @@ -1108,7 +1108,7 @@ "$id": "112", "Name": "managedIdentityTrackedResourceName", "NameInRequest": "managedIdentityTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "113", "kind": "string", @@ -1185,14 +1185,14 @@ "$id": "118", "Name": "createWithSystemAssigned", "ResourceName": "ManagedIdentityTrackedResource", - "Description": "Create a ManagedIdentityTrackedResource", + "Doc": "Create a ManagedIdentityTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "119", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "120", "kind": "string", @@ -1224,7 +1224,7 @@ "$id": "123", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "124", "kind": "string", @@ -1246,7 +1246,7 @@ "$id": "125", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "126", "kind": "string", @@ -1268,7 +1268,7 @@ "$id": "127", "Name": "managedIdentityTrackedResourceName", "NameInRequest": "managedIdentityTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "128", "kind": "string", @@ -1290,7 +1290,7 @@ "$id": "129", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "130", "kind": "constant", @@ -1345,7 +1345,7 @@ "$id": "135", "Name": "resource", "NameInRequest": "resource", - "Description": "Resource create parameters.", + "Doc": "Resource create parameters.", "Type": { "$ref": "26" }, @@ -1409,14 +1409,14 @@ "$id": "138", "Name": "updateWithUserAssignedAndSystemAssigned", "ResourceName": "ManagedIdentityTrackedResource", - "Description": "Update a ManagedIdentityTrackedResource", + "Doc": "Update a ManagedIdentityTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "139", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "140", "kind": "string", @@ -1448,7 +1448,7 @@ "$id": "143", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "144", "kind": "string", @@ -1470,7 +1470,7 @@ "$id": "145", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "146", "kind": "string", @@ -1492,7 +1492,7 @@ "$id": "147", "Name": "managedIdentityTrackedResourceName", "NameInRequest": "managedIdentityTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "148", "kind": "string", @@ -1514,7 +1514,7 @@ "$id": "149", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "150", "kind": "constant", @@ -1569,7 +1569,7 @@ "$id": "155", "Name": "properties", "NameInRequest": "properties", - "Description": "The resource properties to be updated.", + "Doc": "The resource properties to be updated.", "Type": { "$ref": "26" }, @@ -1624,7 +1624,7 @@ "$id": "158", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "159", "kind": "url", diff --git a/test/CadlRanchProjects/azure/resource-manager/resources/tspCodeModel.json b/test/CadlRanchProjects/azure/resource-manager/resources/tspCodeModel.json index 2416ac51d53..3bdd575fe95 100644 --- a/test/CadlRanchProjects/azure/resource-manager/resources/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/resource-manager/resources/tspCodeModel.json @@ -33,7 +33,7 @@ "enumType": { "$ref": "2" }, - "description": "Resource has been created.", + "doc": "Resource has been created.", "decorators": [] }, { @@ -51,7 +51,7 @@ "enumType": { "$ref": "2" }, - "description": "Resource creation failed.", + "doc": "Resource creation failed.", "decorators": [] }, { @@ -69,7 +69,7 @@ "enumType": { "$ref": "2" }, - "description": "Resource creation was canceled.", + "doc": "Resource creation was canceled.", "decorators": [] }, { @@ -174,7 +174,7 @@ "enumType": { "$ref": "18" }, - "description": "The entity was created by a user.", + "doc": "The entity was created by a user.", "decorators": [] }, { @@ -192,7 +192,7 @@ "enumType": { "$ref": "18" }, - "description": "The entity was created by an application.", + "doc": "The entity was created by an application.", "decorators": [] }, { @@ -210,7 +210,7 @@ "enumType": { "$ref": "18" }, - "description": "The entity was created by a managed identity.", + "doc": "The entity was created by a managed identity.", "decorators": [] }, { @@ -228,11 +228,11 @@ "enumType": { "$ref": "18" }, - "description": "The entity was created by a key.", + "doc": "The entity was created by a key.", "decorators": [] } ], - "description": "The kind of entity that created the resource.", + "doc": "The kind of entity that created the resource.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -266,11 +266,11 @@ "enumType": { "$ref": "28" }, - "description": "Preview API version 2023-12-01-preview.", + "doc": "Preview API version 2023-12-01-preview.", "decorators": [] } ], - "description": "Azure API versions.", + "doc": "Azure API versions.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -284,7 +284,7 @@ "name": "SingletonTrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.SingletonTrackedResource", "usage": "Input,Output,Json", - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "doc": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "decorators": [], "baseModel": { "$id": "33", @@ -292,7 +292,7 @@ "name": "TrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.TrackedResource", "usage": "Input,Output,Json", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "doc": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "decorators": [], "baseModel": { "$id": "34", @@ -300,7 +300,7 @@ "name": "Resource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.Resource", "usage": "Input,Output,Json", - "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "doc": "Common fields that are returned in the response for all Azure Resource Manager resources", "decorators": [], "properties": [ { @@ -308,7 +308,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "doc": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "type": { "$id": "36", "kind": "string", @@ -335,7 +335,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the resource", + "doc": "The name of the resource", "type": { "$id": "39", "kind": "string", @@ -355,7 +355,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "doc": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "type": { "$id": "41", "kind": "string", @@ -375,14 +375,14 @@ "kind": "property", "name": "systemData", "serializedName": "systemData", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "doc": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", "type": { "$id": "43", "kind": "model", "name": "SystemData", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.SystemData", "usage": "Output,Json", - "description": "Metadata pertaining to creation and last modification of the resource.", + "doc": "Metadata pertaining to creation and last modification of the resource.", "decorators": [], "properties": [ { @@ -390,7 +390,7 @@ "kind": "property", "name": "createdBy", "serializedName": "createdBy", - "description": "The identity that created the resource.", + "doc": "The identity that created the resource.", "type": { "$id": "45", "kind": "string", @@ -410,7 +410,7 @@ "kind": "property", "name": "createdByType", "serializedName": "createdByType", - "description": "The type of identity that created the resource.", + "doc": "The type of identity that created the resource.", "type": { "$ref": "18" }, @@ -426,7 +426,7 @@ "kind": "property", "name": "createdAt", "serializedName": "createdAt", - "description": "The timestamp of resource creation (UTC).", + "doc": "The timestamp of resource creation (UTC).", "type": { "$id": "48", "kind": "utcDateTime", @@ -454,7 +454,7 @@ "kind": "property", "name": "lastModifiedBy", "serializedName": "lastModifiedBy", - "description": "The identity that last modified the resource.", + "doc": "The identity that last modified the resource.", "type": { "$id": "51", "kind": "string", @@ -474,7 +474,7 @@ "kind": "property", "name": "lastModifiedByType", "serializedName": "lastModifiedByType", - "description": "The type of identity that last modified the resource.", + "doc": "The type of identity that last modified the resource.", "type": { "$ref": "18" }, @@ -490,7 +490,7 @@ "kind": "property", "name": "lastModifiedAt", "serializedName": "lastModifiedAt", - "description": "The timestamp of resource last modification (UTC)", + "doc": "The timestamp of resource last modification (UTC)", "type": { "$id": "54", "kind": "utcDateTime", @@ -530,7 +530,7 @@ "kind": "property", "name": "tags", "serializedName": "tags", - "description": "Resource tags.", + "doc": "Resource tags.", "type": { "$id": "57", "kind": "dict", @@ -562,7 +562,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The geo-location where the resource lives", + "doc": "The geo-location where the resource lives", "type": { "$id": "61", "kind": "string", @@ -585,14 +585,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "63", "kind": "model", "name": "SingletonTrackedResourceProperties", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.SingletonTrackedResourceProperties", "usage": "Input,Output,Json", - "description": "Singleton Arm Resource Properties.", + "doc": "Singleton Arm Resource Properties.", "decorators": [], "properties": [ { @@ -600,7 +600,7 @@ "kind": "property", "name": "provisioningState", "serializedName": "provisioningState", - "description": "The status of the last operation.", + "doc": "The status of the last operation.", "type": { "$ref": "2" }, @@ -616,7 +616,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "The description of the resource.", + "doc": "The description of the resource.", "type": { "$id": "66", "kind": "string", @@ -660,7 +660,7 @@ "name": "ErrorResponse", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorResponse", "usage": "Output,Error,Json", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "doc": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "decorators": [], "properties": [ { @@ -668,14 +668,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "The error object.", + "doc": "The error object.", "type": { "$id": "69", "kind": "model", "name": "ErrorDetail", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorDetail", "usage": "Output,Json", - "description": "The error detail.", + "doc": "The error detail.", "decorators": [], "properties": [ { @@ -683,7 +683,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$id": "71", "kind": "string", @@ -703,7 +703,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The error message.", + "doc": "The error message.", "type": { "$id": "73", "kind": "string", @@ -723,7 +723,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The error target.", + "doc": "The error target.", "type": { "$id": "75", "kind": "string", @@ -743,7 +743,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "The error details.", + "doc": "The error details.", "type": { "$id": "77", "kind": "array", @@ -766,7 +766,7 @@ "kind": "property", "name": "additionalInfo", "serializedName": "additionalInfo", - "description": "The error additional info.", + "doc": "The error additional info.", "type": { "$id": "79", "kind": "array", @@ -777,7 +777,7 @@ "name": "ErrorAdditionalInfo", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo", "usage": "Output,Json", - "description": "The resource management error additional info.", + "doc": "The resource management error additional info.", "decorators": [], "properties": [ { @@ -785,7 +785,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The additional info type.", + "doc": "The additional info type.", "type": { "$id": "82", "kind": "string", @@ -805,7 +805,7 @@ "kind": "property", "name": "info", "serializedName": "info", - "description": "The additional info.", + "doc": "The additional info.", "type": { "$id": "84", "kind": "model", @@ -860,7 +860,7 @@ "name": "SingletonTrackedResourceListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.ResourceListResult", "usage": "Output,Json", - "description": "The response of a SingletonTrackedResource list operation.", + "doc": "The response of a SingletonTrackedResource list operation.", "decorators": [], "properties": [ { @@ -868,7 +868,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The SingletonTrackedResource items on this page", + "doc": "The SingletonTrackedResource items on this page", "type": { "$id": "87", "kind": "array", @@ -891,7 +891,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "89", "kind": "url", @@ -921,7 +921,7 @@ "name": "NestedProxyResource", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.NestedProxyResource", "usage": "Input,Output,Json", - "description": "Nested child of Top Level Tracked Resource.", + "doc": "Nested child of Top Level Tracked Resource.", "decorators": [], "baseModel": { "$id": "92", @@ -929,7 +929,7 @@ "name": "ProxyResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ProxyResource", "usage": "Input,Output,Json", - "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "doc": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", "decorators": [], "baseModel": { "$ref": "34" @@ -942,14 +942,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "94", "kind": "model", "name": "NestedProxyResourceProperties", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.NestedProxyResourceProperties", "usage": "Input,Output,Json", - "description": "Nested Proxy Resource Properties.", + "doc": "Nested Proxy Resource Properties.", "decorators": [], "properties": [ { @@ -957,7 +957,7 @@ "kind": "property", "name": "provisioningState", "serializedName": "provisioningState", - "description": "Provisioning State of the nested child Resource", + "doc": "Provisioning State of the nested child Resource", "type": { "$ref": "2" }, @@ -973,7 +973,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "Nested resource description.", + "doc": "Nested resource description.", "type": { "$id": "97", "kind": "string", @@ -1011,7 +1011,7 @@ "name": "NestedProxyResourceListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.ResourceListResult", "usage": "Output,Json", - "description": "The response of a NestedProxyResource list operation.", + "doc": "The response of a NestedProxyResource list operation.", "decorators": [], "properties": [ { @@ -1019,7 +1019,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The NestedProxyResource items on this page", + "doc": "The NestedProxyResource items on this page", "type": { "$id": "100", "kind": "array", @@ -1042,7 +1042,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "102", "kind": "url", @@ -1072,7 +1072,7 @@ "name": "TopLevelTrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.TopLevelTrackedResource", "usage": "Input,Output,Json", - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "doc": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "decorators": [], "baseModel": { "$ref": "33" @@ -1083,14 +1083,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "106", "kind": "model", "name": "TopLevelTrackedResourceProperties", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.TopLevelTrackedResourceProperties", "usage": "Input,Output,Json", - "description": "Top Level Arm Resource Properties.", + "doc": "Top Level Arm Resource Properties.", "decorators": [], "properties": [ { @@ -1098,7 +1098,7 @@ "kind": "property", "name": "provisioningState", "serializedName": "provisioningState", - "description": "The status of the last operation.", + "doc": "The status of the last operation.", "type": { "$ref": "2" }, @@ -1114,7 +1114,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "The description of the resource.", + "doc": "The description of the resource.", "type": { "$id": "109", "kind": "string", @@ -1149,7 +1149,7 @@ "name": "TopLevelTrackedResourceListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.ResourceListResult", "usage": "Output,Json", - "description": "The response of a TopLevelTrackedResource list operation.", + "doc": "The response of a TopLevelTrackedResource list operation.", "decorators": [], "properties": [ { @@ -1157,7 +1157,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The TopLevelTrackedResource items on this page", + "doc": "The TopLevelTrackedResource items on this page", "type": { "$id": "112", "kind": "array", @@ -1180,7 +1180,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "114", "kind": "url", @@ -1210,7 +1210,7 @@ "name": "NotificationDetails", "crossLanguageDefinitionId": "Azure.ResourceManager.Resources.NotificationDetails", "usage": "Input,Json", - "description": "The details of a user notification.", + "doc": "The details of a user notification.", "decorators": [], "properties": [ { @@ -1218,7 +1218,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The notification message.", + "doc": "The notification message.", "type": { "$id": "118", "kind": "string", @@ -1238,7 +1238,7 @@ "kind": "property", "name": "urgent", "serializedName": "urgent", - "description": "If true, the notification is urgent.", + "doc": "If true, the notification is urgent.", "type": { "$id": "120", "kind": "boolean", @@ -1260,7 +1260,7 @@ { "$id": "121", "Name": "ResourcesClient", - "Description": "Arm Resource Provider management API.", + "Doc": "Arm Resource Provider management API.", "Operations": [], "Protocol": { "$id": "122" @@ -1270,7 +1270,7 @@ "$id": "123", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "124", "kind": "url", @@ -1308,14 +1308,14 @@ "$id": "128", "Name": "get", "ResourceName": "TopLevelTrackedResource", - "Description": "Get a TopLevelTrackedResource", + "Doc": "Get a TopLevelTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "129", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "130", "kind": "string", @@ -1347,7 +1347,7 @@ "$id": "133", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "134", "kind": "string", @@ -1376,7 +1376,7 @@ "$id": "136", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "137", "kind": "string", @@ -1398,7 +1398,7 @@ "$id": "138", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "139", "kind": "string", @@ -1475,14 +1475,14 @@ "$id": "144", "Name": "createOrReplace", "ResourceName": "TopLevelTrackedResource", - "Description": "Create a TopLevelTrackedResource", + "Doc": "Create a TopLevelTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "145", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "146", "kind": "string", @@ -1514,7 +1514,7 @@ "$id": "149", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "150", "kind": "string", @@ -1543,7 +1543,7 @@ "$id": "152", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "153", "kind": "string", @@ -1565,7 +1565,7 @@ "$id": "154", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "155", "kind": "string", @@ -1587,7 +1587,7 @@ "$id": "156", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "157", "kind": "constant", @@ -1642,7 +1642,7 @@ "$id": "162", "Name": "resource", "NameInRequest": "resource", - "Description": "Resource create parameters.", + "Doc": "Resource create parameters.", "Type": { "$ref": "104" }, @@ -1687,7 +1687,7 @@ "$id": "165", "Name": "azureAsyncOperation", "NameInResponse": "Azure-AsyncOperation", - "Description": "A link to the status monitor", + "Doc": "A link to the status monitor", "Type": { "$id": "166", "kind": "string", @@ -1700,7 +1700,7 @@ "$id": "167", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "168", "kind": "int32", @@ -1747,14 +1747,14 @@ "$id": "171", "Name": "update", "ResourceName": "TopLevelTrackedResource", - "Description": "Update a TopLevelTrackedResource", + "Doc": "Update a TopLevelTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "172", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "173", "kind": "string", @@ -1786,7 +1786,7 @@ "$id": "176", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "177", "kind": "string", @@ -1815,7 +1815,7 @@ "$id": "179", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "180", "kind": "string", @@ -1837,7 +1837,7 @@ "$id": "181", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "182", "kind": "string", @@ -1859,7 +1859,7 @@ "$id": "183", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "184", "kind": "constant", @@ -1914,7 +1914,7 @@ "$id": "189", "Name": "properties", "NameInRequest": "properties", - "Description": "The resource properties to be updated.", + "Doc": "The resource properties to be updated.", "Type": { "$ref": "104" }, @@ -1956,7 +1956,7 @@ "$id": "192", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "193", "kind": "string", @@ -1969,7 +1969,7 @@ "$id": "194", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "195", "kind": "int32", @@ -2013,14 +2013,14 @@ "$id": "198", "Name": "delete", "ResourceName": "TopLevelTrackedResource", - "Description": "Delete a TopLevelTrackedResource", + "Doc": "Delete a TopLevelTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "199", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "200", "kind": "string", @@ -2052,7 +2052,7 @@ "$id": "203", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "204", "kind": "string", @@ -2081,7 +2081,7 @@ "$id": "206", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "207", "kind": "string", @@ -2103,7 +2103,7 @@ "$id": "208", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "209", "kind": "string", @@ -2161,7 +2161,7 @@ "$id": "214", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "215", "kind": "string", @@ -2174,7 +2174,7 @@ "$id": "216", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "217", "kind": "int32", @@ -2221,14 +2221,14 @@ "$id": "221", "Name": "listByResourceGroup", "ResourceName": "TopLevelTrackedResource", - "Description": "List TopLevelTrackedResource resources by resource group", + "Doc": "List TopLevelTrackedResource resources by resource group", "Accessibility": "public", "Parameters": [ { "$id": "222", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "223", "kind": "string", @@ -2260,7 +2260,7 @@ "$id": "226", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "227", "kind": "string", @@ -2289,7 +2289,7 @@ "$id": "229", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "230", "kind": "string", @@ -2371,14 +2371,14 @@ "$id": "236", "Name": "listBySubscription", "ResourceName": "TopLevelTrackedResource", - "Description": "List TopLevelTrackedResource resources by subscription ID", + "Doc": "List TopLevelTrackedResource resources by subscription ID", "Accessibility": "public", "Parameters": [ { "$id": "237", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "238", "kind": "string", @@ -2410,7 +2410,7 @@ "$id": "241", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "242", "kind": "string", @@ -2499,14 +2499,14 @@ "$id": "249", "Name": "actionSync", "ResourceName": "TopLevel", - "Description": "A synchronous resource action that returns no content.", + "Doc": "A synchronous resource action that returns no content.", "Accessibility": "public", "Parameters": [ { "$id": "250", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "251", "kind": "string", @@ -2538,7 +2538,7 @@ "$id": "254", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "255", "kind": "string", @@ -2567,7 +2567,7 @@ "$id": "257", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "258", "kind": "string", @@ -2589,7 +2589,7 @@ "$id": "259", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "260", "kind": "string", @@ -2611,7 +2611,7 @@ "$id": "261", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "262", "kind": "constant", @@ -2666,7 +2666,7 @@ "$id": "267", "Name": "body", "NameInRequest": "body", - "Description": "The content of the action request", + "Doc": "The content of the action request", "Type": { "$ref": "116" }, @@ -2715,7 +2715,7 @@ "$id": "270", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "271", "kind": "url", @@ -2753,14 +2753,14 @@ "$id": "275", "Name": "get", "ResourceName": "NestedProxyResource", - "Description": "Get a NestedProxyResource", + "Doc": "Get a NestedProxyResource", "Accessibility": "public", "Parameters": [ { "$id": "276", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "277", "kind": "string", @@ -2792,7 +2792,7 @@ "$id": "280", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "281", "kind": "string", @@ -2821,7 +2821,7 @@ "$id": "283", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "284", "kind": "string", @@ -2843,7 +2843,7 @@ "$id": "285", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "286", "kind": "string", @@ -2865,7 +2865,7 @@ "$id": "287", "Name": "nextedProxyResourceName", "NameInRequest": "nextedProxyResourceName", - "Description": "Name of the nested resource.", + "Doc": "Name of the nested resource.", "Type": { "$id": "288", "kind": "string", @@ -2942,14 +2942,14 @@ "$id": "293", "Name": "createOrReplace", "ResourceName": "NestedProxyResource", - "Description": "Create a NestedProxyResource", + "Doc": "Create a NestedProxyResource", "Accessibility": "public", "Parameters": [ { "$id": "294", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "295", "kind": "string", @@ -2981,7 +2981,7 @@ "$id": "298", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "299", "kind": "string", @@ -3010,7 +3010,7 @@ "$id": "301", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "302", "kind": "string", @@ -3032,7 +3032,7 @@ "$id": "303", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "304", "kind": "string", @@ -3054,7 +3054,7 @@ "$id": "305", "Name": "nextedProxyResourceName", "NameInRequest": "nextedProxyResourceName", - "Description": "Name of the nested resource.", + "Doc": "Name of the nested resource.", "Type": { "$id": "306", "kind": "string", @@ -3076,7 +3076,7 @@ "$id": "307", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "308", "kind": "constant", @@ -3131,7 +3131,7 @@ "$id": "313", "Name": "resource", "NameInRequest": "resource", - "Description": "Resource create parameters.", + "Doc": "Resource create parameters.", "Type": { "$ref": "91" }, @@ -3176,7 +3176,7 @@ "$id": "316", "Name": "azureAsyncOperation", "NameInResponse": "Azure-AsyncOperation", - "Description": "A link to the status monitor", + "Doc": "A link to the status monitor", "Type": { "$id": "317", "kind": "string", @@ -3189,7 +3189,7 @@ "$id": "318", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "319", "kind": "int32", @@ -3236,14 +3236,14 @@ "$id": "322", "Name": "update", "ResourceName": "NestedProxyResource", - "Description": "Update a NestedProxyResource", + "Doc": "Update a NestedProxyResource", "Accessibility": "public", "Parameters": [ { "$id": "323", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "324", "kind": "string", @@ -3275,7 +3275,7 @@ "$id": "327", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "328", "kind": "string", @@ -3304,7 +3304,7 @@ "$id": "330", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "331", "kind": "string", @@ -3326,7 +3326,7 @@ "$id": "332", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "333", "kind": "string", @@ -3348,7 +3348,7 @@ "$id": "334", "Name": "nextedProxyResourceName", "NameInRequest": "nextedProxyResourceName", - "Description": "Name of the nested resource.", + "Doc": "Name of the nested resource.", "Type": { "$id": "335", "kind": "string", @@ -3370,7 +3370,7 @@ "$id": "336", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "337", "kind": "constant", @@ -3425,7 +3425,7 @@ "$id": "342", "Name": "properties", "NameInRequest": "properties", - "Description": "The resource properties to be updated.", + "Doc": "The resource properties to be updated.", "Type": { "$ref": "91" }, @@ -3467,7 +3467,7 @@ "$id": "345", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "346", "kind": "string", @@ -3480,7 +3480,7 @@ "$id": "347", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "348", "kind": "int32", @@ -3524,14 +3524,14 @@ "$id": "351", "Name": "delete", "ResourceName": "NestedProxyResource", - "Description": "Delete a NestedProxyResource", + "Doc": "Delete a NestedProxyResource", "Accessibility": "public", "Parameters": [ { "$id": "352", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "353", "kind": "string", @@ -3563,7 +3563,7 @@ "$id": "356", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "357", "kind": "string", @@ -3592,7 +3592,7 @@ "$id": "359", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "360", "kind": "string", @@ -3614,7 +3614,7 @@ "$id": "361", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "362", "kind": "string", @@ -3636,7 +3636,7 @@ "$id": "363", "Name": "nextedProxyResourceName", "NameInRequest": "nextedProxyResourceName", - "Description": "Name of the nested resource.", + "Doc": "Name of the nested resource.", "Type": { "$id": "364", "kind": "string", @@ -3694,7 +3694,7 @@ "$id": "369", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "370", "kind": "string", @@ -3707,7 +3707,7 @@ "$id": "371", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "372", "kind": "int32", @@ -3754,14 +3754,14 @@ "$id": "376", "Name": "listByTopLevelTrackedResource", "ResourceName": "NestedProxyResource", - "Description": "List NestedProxyResource resources by TopLevelTrackedResource", + "Doc": "List NestedProxyResource resources by TopLevelTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "377", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "378", "kind": "string", @@ -3793,7 +3793,7 @@ "$id": "381", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "382", "kind": "string", @@ -3822,7 +3822,7 @@ "$id": "384", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "385", "kind": "string", @@ -3844,7 +3844,7 @@ "$id": "386", "Name": "topLevelTrackedResourceName", "NameInRequest": "topLevelTrackedResourceName", - "Description": "arm resource name for path", + "Doc": "arm resource name for path", "Type": { "$id": "387", "kind": "string", @@ -3932,7 +3932,7 @@ "$id": "394", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "395", "kind": "url", @@ -3970,14 +3970,14 @@ "$id": "399", "Name": "getByResourceGroup", "ResourceName": "SingletonTrackedResource", - "Description": "Get a SingletonTrackedResource", + "Doc": "Get a SingletonTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "400", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "401", "kind": "string", @@ -4009,7 +4009,7 @@ "$id": "404", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "405", "kind": "string", @@ -4038,7 +4038,7 @@ "$id": "407", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "408", "kind": "string", @@ -4115,14 +4115,14 @@ "$id": "413", "Name": "createOrUpdate", "ResourceName": "SingletonTrackedResource", - "Description": "Create a SingletonTrackedResource", + "Doc": "Create a SingletonTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "414", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "415", "kind": "string", @@ -4154,7 +4154,7 @@ "$id": "418", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "419", "kind": "string", @@ -4183,7 +4183,7 @@ "$id": "421", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "422", "kind": "string", @@ -4205,7 +4205,7 @@ "$id": "423", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "424", "kind": "constant", @@ -4260,7 +4260,7 @@ "$id": "429", "Name": "resource", "NameInRequest": "resource", - "Description": "Resource create parameters.", + "Doc": "Resource create parameters.", "Type": { "$ref": "32" }, @@ -4305,7 +4305,7 @@ "$id": "432", "Name": "azureAsyncOperation", "NameInResponse": "Azure-AsyncOperation", - "Description": "A link to the status monitor", + "Doc": "A link to the status monitor", "Type": { "$id": "433", "kind": "string", @@ -4318,7 +4318,7 @@ "$id": "434", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "435", "kind": "int32", @@ -4365,14 +4365,14 @@ "$id": "438", "Name": "update", "ResourceName": "SingletonTrackedResource", - "Description": "Update a SingletonTrackedResource", + "Doc": "Update a SingletonTrackedResource", "Accessibility": "public", "Parameters": [ { "$id": "439", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "440", "kind": "string", @@ -4404,7 +4404,7 @@ "$id": "443", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "444", "kind": "string", @@ -4433,7 +4433,7 @@ "$id": "446", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "447", "kind": "string", @@ -4455,7 +4455,7 @@ "$id": "448", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "449", "kind": "constant", @@ -4510,7 +4510,7 @@ "$id": "454", "Name": "properties", "NameInRequest": "properties", - "Description": "The resource properties to be updated.", + "Doc": "The resource properties to be updated.", "Type": { "$ref": "32" }, @@ -4559,14 +4559,14 @@ "$id": "456", "Name": "listByResourceGroup", "ResourceName": "SingletonTrackedResource", - "Description": "List SingletonTrackedResource resources by resource group", + "Doc": "List SingletonTrackedResource resources by resource group", "Accessibility": "public", "Parameters": [ { "$id": "457", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "458", "kind": "string", @@ -4598,7 +4598,7 @@ "$id": "461", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "462", "kind": "string", @@ -4627,7 +4627,7 @@ "$id": "464", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "465", "kind": "string", @@ -4715,7 +4715,7 @@ "$id": "472", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "473", "kind": "url", diff --git a/test/CadlRanchProjects/azure/special-headers/client-request-id/tspCodeModel.json b/test/CadlRanchProjects/azure/special-headers/client-request-id/tspCodeModel.json index 7b02f69407b..526a8dbd4f0 100644 --- a/test/CadlRanchProjects/azure/special-headers/client-request-id/tspCodeModel.json +++ b/test/CadlRanchProjects/azure/special-headers/client-request-id/tspCodeModel.json @@ -8,13 +8,13 @@ { "$id": "2", "Name": "XmsClientRequestIdClient", - "Description": "Azure client request id header configurations.", + "Doc": "Azure client request id header configurations.", "Operations": [ { "$id": "3", "Name": "get", "ResourceName": "XmsClientRequestId", - "Description": "Get operation with azure `x-ms-client-request-id` header.", + "Doc": "Get operation with azure `x-ms-client-request-id` header.", "Accessibility": "public", "Parameters": [ { @@ -69,7 +69,7 @@ "$id": "8", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "9", "kind": "url", diff --git a/test/CadlRanchProjects/client/naming/tspCodeModel.json b/test/CadlRanchProjects/client/naming/tspCodeModel.json index 9dd12ec66cf..b45cd859a46 100644 --- a/test/CadlRanchProjects/client/naming/tspCodeModel.json +++ b/test/CadlRanchProjects/client/naming/tspCodeModel.json @@ -107,7 +107,7 @@ "kind": "property", "name": "clientName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "14", "kind": "boolean", @@ -137,7 +137,7 @@ "kind": "property", "name": "CSName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "17", "kind": "boolean", @@ -167,7 +167,7 @@ "kind": "property", "name": "clientName", "serializedName": "wireName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "20", "kind": "boolean", @@ -197,7 +197,7 @@ "kind": "property", "name": "defaultName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "23", "kind": "boolean", @@ -227,7 +227,7 @@ "kind": "property", "name": "defaultName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "26", "kind": "boolean", @@ -249,7 +249,7 @@ { "$id": "27", "Name": "NamingClient", - "Description": "Describe changing names of types in a client with `@clientName`", + "Doc": "Describe changing names of types in a client with `@clientName`", "Operations": [ { "$id": "28", @@ -337,7 +337,7 @@ "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -413,7 +413,7 @@ "$id": "41", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "42", "kind": "constant", @@ -489,7 +489,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -653,7 +653,7 @@ "$id": "61", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "62", "kind": "url", @@ -697,7 +697,7 @@ "$id": "67", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "68", "kind": "constant", @@ -773,7 +773,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -849,7 +849,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -893,7 +893,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -969,7 +969,7 @@ "$id": "91", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "92", "kind": "constant", @@ -1045,7 +1045,7 @@ "$id": "97", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "98", "kind": "url", diff --git a/test/CadlRanchProjects/client/structure/client-operation-group/tspCodeModel.json b/test/CadlRanchProjects/client/structure/client-operation-group/tspCodeModel.json index b9cf9bc3ed4..84895c53c2e 100644 --- a/test/CadlRanchProjects/client/structure/client-operation-group/tspCodeModel.json +++ b/test/CadlRanchProjects/client/structure/client-operation-group/tspCodeModel.json @@ -150,7 +150,7 @@ "$id": "18", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "19", "kind": "url", @@ -171,7 +171,7 @@ "$id": "20", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -256,7 +256,7 @@ "$id": "27", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "28", "kind": "url", @@ -277,7 +277,7 @@ "$id": "29", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -335,7 +335,7 @@ "$id": "34", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "35", "kind": "url", @@ -356,7 +356,7 @@ "$id": "36", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -413,7 +413,7 @@ "$id": "41", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "42", "kind": "url", @@ -434,7 +434,7 @@ "$id": "43", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -492,7 +492,7 @@ "$id": "48", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "49", "kind": "url", @@ -513,7 +513,7 @@ "$id": "50", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/client/structure/default/tspCodeModel.json b/test/CadlRanchProjects/client/structure/default/tspCodeModel.json index cb970749db7..a96d1861322 100644 --- a/test/CadlRanchProjects/client/structure/default/tspCodeModel.json +++ b/test/CadlRanchProjects/client/structure/default/tspCodeModel.json @@ -113,7 +113,7 @@ { "$id": "14", "Name": "ServiceClient", - "Description": "Test that we can use @client and @operationGroup decorators to customize client side code structure, such as:\n1. have everything as default.\n2. to rename client or operation group\n3. one client can have more than one operations groups\n4. split one interface into two clients\n5. have two clients with operations come from different interfaces\n6. have two clients with a hierarchy relation.", + "Doc": "Test that we can use @client and @operationGroup decorators to customize client side code structure, such as:\n1. have everything as default.\n2. to rename client or operation group\n3. one client can have more than one operations groups\n4. split one interface into two clients\n5. have two clients with operations come from different interfaces\n6. have two clients with a hierarchy relation.", "Operations": [ { "$id": "15", @@ -178,7 +178,7 @@ "$id": "20", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "21", "kind": "url", @@ -199,7 +199,7 @@ "$id": "22", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -229,7 +229,7 @@ "$id": "25", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "26", "kind": "url", @@ -250,7 +250,7 @@ "$id": "27", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -308,7 +308,7 @@ "$id": "32", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "33", "kind": "url", @@ -329,7 +329,7 @@ "$id": "34", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -387,7 +387,7 @@ "$id": "39", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "40", "kind": "url", @@ -408,7 +408,7 @@ "$id": "41", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -466,7 +466,7 @@ "$id": "46", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "47", "kind": "url", @@ -487,7 +487,7 @@ "$id": "48", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -572,7 +572,7 @@ "$id": "55", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "56", "kind": "url", @@ -593,7 +593,7 @@ "$id": "57", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -678,7 +678,7 @@ "$id": "64", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "65", "kind": "url", @@ -699,7 +699,7 @@ "$id": "66", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/client/structure/multi-client/tspCodeModel.json b/test/CadlRanchProjects/client/structure/multi-client/tspCodeModel.json index 1cc4669fc8b..5cf7a1ba219 100644 --- a/test/CadlRanchProjects/client/structure/multi-client/tspCodeModel.json +++ b/test/CadlRanchProjects/client/structure/multi-client/tspCodeModel.json @@ -204,7 +204,7 @@ "$id": "22", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "23", "kind": "url", @@ -225,7 +225,7 @@ "$id": "24", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -336,7 +336,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "34", "kind": "url", @@ -357,7 +357,7 @@ "$id": "35", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/client/structure/renamed-operation/tspCodeModel.json b/test/CadlRanchProjects/client/structure/renamed-operation/tspCodeModel.json index 3a0f6751faf..bf936109539 100644 --- a/test/CadlRanchProjects/client/structure/renamed-operation/tspCodeModel.json +++ b/test/CadlRanchProjects/client/structure/renamed-operation/tspCodeModel.json @@ -204,7 +204,7 @@ "$id": "22", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "23", "kind": "url", @@ -225,7 +225,7 @@ "$id": "24", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -337,7 +337,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "34", "kind": "url", @@ -358,7 +358,7 @@ "$id": "35", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/client/structure/two-operation-group/tspCodeModel.json b/test/CadlRanchProjects/client/structure/two-operation-group/tspCodeModel.json index ac9645a8d87..3d6903520a5 100644 --- a/test/CadlRanchProjects/client/structure/two-operation-group/tspCodeModel.json +++ b/test/CadlRanchProjects/client/structure/two-operation-group/tspCodeModel.json @@ -122,7 +122,7 @@ "$id": "16", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "17", "kind": "url", @@ -143,7 +143,7 @@ "$id": "18", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -255,7 +255,7 @@ "$id": "27", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "28", "kind": "url", @@ -276,7 +276,7 @@ "$id": "29", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, @@ -388,7 +388,7 @@ "$id": "38", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "39", "kind": "url", @@ -409,7 +409,7 @@ "$id": "40", "Name": "client", "NameInRequest": "client", - "Description": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", + "Doc": "Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/encode/bytes/tspCodeModel.json b/test/CadlRanchProjects/encode/bytes/tspCodeModel.json index f872e1854d8..bdd59c6d28b 100644 --- a/test/CadlRanchProjects/encode/bytes/tspCodeModel.json +++ b/test/CadlRanchProjects/encode/bytes/tspCodeModel.json @@ -144,7 +144,7 @@ { "$id": "16", "Name": "BytesClient", - "Description": "Test for encode decorator on bytes.", + "Doc": "Test for encode decorator on bytes.", "Operations": [], "Protocol": { "$id": "17" @@ -154,7 +154,7 @@ "$id": "18", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "19", "kind": "url", @@ -414,7 +414,7 @@ "$id": "42", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "43", "kind": "url", @@ -458,7 +458,7 @@ "$id": "48", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "49", "kind": "constant", @@ -567,7 +567,7 @@ "$id": "57", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "58", "kind": "constant", @@ -676,7 +676,7 @@ "$id": "66", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "67", "kind": "constant", @@ -785,7 +785,7 @@ "$id": "75", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "76", "kind": "constant", @@ -894,7 +894,7 @@ "$id": "84", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "85", "kind": "url", @@ -1154,7 +1154,7 @@ "$id": "108", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "109", "kind": "url", @@ -1198,7 +1198,7 @@ "$id": "114", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "115", "kind": "constant", @@ -1437,7 +1437,7 @@ "$id": "135", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "136", "kind": "constant", @@ -1518,7 +1518,7 @@ "$id": "142", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "143", "kind": "constant", @@ -1599,7 +1599,7 @@ "$id": "149", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "150", "kind": "url", @@ -2017,7 +2017,7 @@ "$id": "192", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "193", "kind": "url", diff --git a/test/CadlRanchProjects/encode/datetime/tspCodeModel.json b/test/CadlRanchProjects/encode/datetime/tspCodeModel.json index 36ee372f315..bc8c2b51a13 100644 --- a/test/CadlRanchProjects/encode/datetime/tspCodeModel.json +++ b/test/CadlRanchProjects/encode/datetime/tspCodeModel.json @@ -216,7 +216,7 @@ { "$id": "25", "Name": "DatetimeClient", - "Description": "Test for encode decorator on datetime.", + "Doc": "Test for encode decorator on datetime.", "Operations": [], "Protocol": { "$id": "26" @@ -226,7 +226,7 @@ "$id": "27", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "28", "kind": "url", @@ -578,7 +578,7 @@ "$id": "61", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "62", "kind": "url", @@ -622,7 +622,7 @@ "$id": "67", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "68", "kind": "constant", @@ -731,7 +731,7 @@ "$id": "76", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "77", "kind": "constant", @@ -840,7 +840,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -949,7 +949,7 @@ "$id": "94", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "95", "kind": "constant", @@ -1058,7 +1058,7 @@ "$id": "103", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "104", "kind": "constant", @@ -1167,7 +1167,7 @@ "$id": "112", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "113", "kind": "url", @@ -1519,7 +1519,7 @@ "$id": "146", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "147", "kind": "url", @@ -1755,7 +1755,7 @@ "$id": "172", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "173", "kind": "url", diff --git a/test/CadlRanchProjects/encode/duration/tspCodeModel.json b/test/CadlRanchProjects/encode/duration/tspCodeModel.json index f260fca7a3b..3d0c5af0ec4 100644 --- a/test/CadlRanchProjects/encode/duration/tspCodeModel.json +++ b/test/CadlRanchProjects/encode/duration/tspCodeModel.json @@ -253,7 +253,7 @@ { "$id": "29", "Name": "DurationClient", - "Description": "Test for encode decorator on duration.", + "Doc": "Test for encode decorator on duration.", "Operations": [], "Protocol": { "$id": "30" @@ -263,7 +263,7 @@ "$id": "31", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "32", "kind": "url", @@ -672,7 +672,7 @@ "$id": "70", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "71", "kind": "url", @@ -716,7 +716,7 @@ "$id": "76", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "77", "kind": "constant", @@ -825,7 +825,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -934,7 +934,7 @@ "$id": "94", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "95", "kind": "constant", @@ -1043,7 +1043,7 @@ "$id": "103", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "104", "kind": "constant", @@ -1152,7 +1152,7 @@ "$id": "112", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "113", "kind": "constant", @@ -1261,7 +1261,7 @@ "$id": "121", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "122", "kind": "constant", @@ -1370,7 +1370,7 @@ "$id": "130", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "131", "kind": "url", @@ -1779,7 +1779,7 @@ "$id": "169", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "170", "kind": "url", diff --git a/test/CadlRanchProjects/encode/numeric/tspCodeModel.json b/test/CadlRanchProjects/encode/numeric/tspCodeModel.json index f22f89ca1a5..332008506df 100644 --- a/test/CadlRanchProjects/encode/numeric/tspCodeModel.json +++ b/test/CadlRanchProjects/encode/numeric/tspCodeModel.json @@ -99,7 +99,7 @@ { "$id": "11", "Name": "NumericClient", - "Description": "Test for encode decorator on integer.", + "Doc": "Test for encode decorator on integer.", "Operations": [], "Protocol": { "$id": "12" @@ -109,7 +109,7 @@ "$id": "13", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "14", "kind": "url", @@ -153,7 +153,7 @@ "$id": "19", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "20", "kind": "constant", @@ -262,7 +262,7 @@ "$id": "28", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "29", "kind": "constant", @@ -371,7 +371,7 @@ "$id": "37", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "38", "kind": "constant", @@ -480,7 +480,7 @@ "$id": "46", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "47", "kind": "url", diff --git a/test/CadlRanchProjects/parameters/basic/tspCodeModel.json b/test/CadlRanchProjects/parameters/basic/tspCodeModel.json index 497d8c7a531..08a2175e235 100644 --- a/test/CadlRanchProjects/parameters/basic/tspCodeModel.json +++ b/test/CadlRanchProjects/parameters/basic/tspCodeModel.json @@ -39,7 +39,7 @@ "name": "User", "crossLanguageDefinitionId": "Parameters.Basic.ExplicitBody.User", "usage": "Input,Json", - "description": "This is a simple model.", + "doc": "This is a simple model.", "decorators": [], "properties": [ { @@ -68,7 +68,7 @@ { "$id": "8", "Name": "BasicClient", - "Description": "Test for basic parameters cases.", + "Doc": "Test for basic parameters cases.", "Operations": [], "Protocol": { "$id": "9" @@ -78,7 +78,7 @@ "$id": "10", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "11", "kind": "url", @@ -122,7 +122,7 @@ "$id": "16", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "17", "kind": "constant", @@ -198,7 +198,7 @@ "$id": "22", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "23", "kind": "url", @@ -242,7 +242,7 @@ "$id": "28", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "29", "kind": "constant", @@ -318,7 +318,7 @@ "$id": "34", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "35", "kind": "url", diff --git a/test/CadlRanchProjects/parameters/body-optionality/tspCodeModel.json b/test/CadlRanchProjects/parameters/body-optionality/tspCodeModel.json index b67afd40a95..8339a4a06c8 100644 --- a/test/CadlRanchProjects/parameters/body-optionality/tspCodeModel.json +++ b/test/CadlRanchProjects/parameters/body-optionality/tspCodeModel.json @@ -38,7 +38,7 @@ { "$id": "5", "Name": "BodyOptionalityClient", - "Description": "Test describing optionality of the request body.", + "Doc": "Test describing optionality of the request body.", "Operations": [ { "$id": "6", @@ -50,7 +50,7 @@ "$id": "7", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "8", "kind": "constant", @@ -126,7 +126,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -201,7 +201,7 @@ "$id": "19", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "20", "kind": "url", @@ -245,7 +245,7 @@ "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -321,7 +321,7 @@ "$id": "31", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "32", "kind": "constant", @@ -397,7 +397,7 @@ "$id": "37", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "38", "kind": "url", diff --git a/test/CadlRanchProjects/parameters/collection-format/tspCodeModel.json b/test/CadlRanchProjects/parameters/collection-format/tspCodeModel.json index 28a3f46e996..f0c002b4d9f 100644 --- a/test/CadlRanchProjects/parameters/collection-format/tspCodeModel.json +++ b/test/CadlRanchProjects/parameters/collection-format/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "CollectionFormatClient", - "Description": "Test for collectionFormat.", + "Doc": "Test for collectionFormat.", "Operations": [], "Protocol": { "$id": "3" @@ -18,7 +18,7 @@ "$id": "4", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "5", "kind": "url", @@ -62,7 +62,7 @@ "$id": "10", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "11", "kind": "array", @@ -119,7 +119,7 @@ "$id": "15", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "16", "kind": "array", @@ -177,7 +177,7 @@ "$id": "20", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "21", "kind": "array", @@ -235,7 +235,7 @@ "$id": "25", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "26", "kind": "array", @@ -293,7 +293,7 @@ "$id": "30", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "31", "kind": "array", @@ -351,7 +351,7 @@ "$id": "35", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "36", "kind": "url", @@ -395,7 +395,7 @@ "$id": "41", "Name": "colors", "NameInRequest": "colors", - "Description": "Possible values for colors are [blue,red,green]", + "Doc": "Possible values for colors are [blue,red,green]", "Type": { "$id": "42", "kind": "array", @@ -453,7 +453,7 @@ "$id": "46", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "47", "kind": "url", diff --git a/test/CadlRanchProjects/parameters/spread/tspCodeModel.json b/test/CadlRanchProjects/parameters/spread/tspCodeModel.json index 3cc532ba734..f750112b2bc 100644 --- a/test/CadlRanchProjects/parameters/spread/tspCodeModel.json +++ b/test/CadlRanchProjects/parameters/spread/tspCodeModel.json @@ -104,7 +104,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "required string", + "doc": "required string", "type": { "$id": "13", "kind": "string", @@ -124,7 +124,7 @@ "kind": "property", "name": "optionalInt", "serializedName": "optionalInt", - "description": "optional int", + "doc": "optional int", "type": { "$id": "15", "kind": "int32", @@ -144,7 +144,7 @@ "kind": "property", "name": "requiredIntList", "serializedName": "requiredIntList", - "description": "required int", + "doc": "required int", "type": { "$id": "17", "kind": "array", @@ -171,7 +171,7 @@ "kind": "property", "name": "optionalStringList", "serializedName": "optionalStringList", - "description": "optional string", + "doc": "optional string", "type": { "$id": "20", "kind": "array", @@ -208,7 +208,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "24", "kind": "string", @@ -228,7 +228,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "age of the Thing", + "doc": "age of the Thing", "type": { "$id": "26", "kind": "int32", @@ -251,7 +251,7 @@ "name": "BodyParameter", "crossLanguageDefinitionId": "Parameters.Spread.Model.BodyParameter", "usage": "Input,Spread,Json", - "description": "This is a simple model.", + "doc": "This is a simple model.", "decorators": [], "properties": [ { @@ -309,7 +309,7 @@ { "$id": "33", "Name": "SpreadClient", - "Description": "Test for the spread operator.", + "Doc": "Test for the spread operator.", "Operations": [], "Protocol": { "$id": "34" @@ -319,7 +319,7 @@ "$id": "35", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "36", "kind": "url", @@ -363,7 +363,7 @@ "$id": "41", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "42", "kind": "constant", @@ -439,7 +439,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -627,7 +627,7 @@ "$id": "63", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "64", "kind": "constant", @@ -745,7 +745,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -821,7 +821,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -865,7 +865,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -983,7 +983,7 @@ "$id": "95", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "96", "kind": "constant", @@ -1101,7 +1101,7 @@ "$id": "105", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "106", "kind": "constant", @@ -1219,7 +1219,7 @@ "$id": "115", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "116", "kind": "constant", @@ -1289,7 +1289,7 @@ "$id": "120", "Name": "spreadParameterWithInnerAlias", "ResourceName": "Alias", - "Description": "spread an alias with contains another alias property as body.", + "Doc": "spread an alias with contains another alias property as body.", "Accessibility": "public", "Parameters": [ { @@ -1338,7 +1338,7 @@ "$id": "125", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "126", "kind": "constant", @@ -1414,7 +1414,7 @@ "$id": "131", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "132", "kind": "url", diff --git a/test/CadlRanchProjects/payload/content-negotiation/tspCodeModel.json b/test/CadlRanchProjects/payload/content-negotiation/tspCodeModel.json index 3e9be3f5305..1f299606a5d 100644 --- a/test/CadlRanchProjects/payload/content-negotiation/tspCodeModel.json +++ b/test/CadlRanchProjects/payload/content-negotiation/tspCodeModel.json @@ -39,7 +39,7 @@ { "$id": "5", "Name": "ContentNegotiationClient", - "Description": "Test describing optionality of the request body.", + "Doc": "Test describing optionality of the request body.", "Operations": [], "Protocol": { "$id": "6" @@ -49,7 +49,7 @@ "$id": "7", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "8", "kind": "url", @@ -261,7 +261,7 @@ "$id": "31", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "32", "kind": "url", @@ -469,7 +469,7 @@ "$id": "54", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "55", "kind": "url", diff --git a/test/CadlRanchProjects/payload/media-type/tspCodeModel.json b/test/CadlRanchProjects/payload/media-type/tspCodeModel.json index 3fb458ca142..9bc86bebe4c 100644 --- a/test/CadlRanchProjects/payload/media-type/tspCodeModel.json +++ b/test/CadlRanchProjects/payload/media-type/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "MediaTypeClient", - "Description": "Test the payload with different media types and different types of the payload itself.", + "Doc": "Test the payload with different media types and different types of the payload itself.", "Operations": [], "Protocol": { "$id": "3" @@ -18,7 +18,7 @@ "$id": "4", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "5", "kind": "url", @@ -388,7 +388,7 @@ "$id": "42", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "43", "kind": "url", diff --git a/test/CadlRanchProjects/payload/multipart/tspCodeModel.json b/test/CadlRanchProjects/payload/multipart/tspCodeModel.json index cfc7d5e279b..f134fc4e364 100644 --- a/test/CadlRanchProjects/payload/multipart/tspCodeModel.json +++ b/test/CadlRanchProjects/payload/multipart/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "image/jpg", "value": "image/jpg", - "description": "image/jpg", + "doc": "image/jpg", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FileSpecificContentType_contentType", + "doc": "The FileSpecificContentType_contentType", "isFixed": false, "isFlags": false, "usage": "Input", @@ -813,7 +813,7 @@ { "$id": "79", "Name": "MultiPartClient", - "Description": "Test for multipart", + "Doc": "Test for multipart", "Operations": [], "Protocol": { "$id": "80" @@ -823,7 +823,7 @@ "$id": "81", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "82", "kind": "url", @@ -861,7 +861,7 @@ "$id": "86", "Name": "basic", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -937,7 +937,7 @@ "$id": "92", "Name": "fileArrayAndBasic", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for mixed scenarios", + "Doc": "Test content-type: multipart/form-data for mixed scenarios", "Accessibility": "public", "Parameters": [ { @@ -1013,7 +1013,7 @@ "$id": "98", "Name": "jsonPart", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains json part and binary part ", + "Doc": "Test content-type: multipart/form-data for scenario contains json part and binary part ", "Accessibility": "public", "Parameters": [ { @@ -1089,7 +1089,7 @@ "$id": "104", "Name": "binaryArrayParts", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains multi binary parts", + "Doc": "Test content-type: multipart/form-data for scenario contains multi binary parts", "Accessibility": "public", "Parameters": [ { @@ -1165,7 +1165,7 @@ "$id": "110", "Name": "multiBinaryParts", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains multi binary parts", + "Doc": "Test content-type: multipart/form-data for scenario contains multi binary parts", "Accessibility": "public", "Parameters": [ { @@ -1241,7 +1241,7 @@ "$id": "116", "Name": "checkFileNameAndContentType", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1317,7 +1317,7 @@ "$id": "122", "Name": "anonymousModel", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1399,7 +1399,7 @@ "$id": "129", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "130", "kind": "url", @@ -1437,7 +1437,7 @@ "$id": "134", "Name": "jsonArrayAndFileArray", "ResourceName": "HttpParts", - "Description": "Test content-type: multipart/form-data for mixed scenarios", + "Doc": "Test content-type: multipart/form-data for mixed scenarios", "Accessibility": "public", "Parameters": [ { @@ -1519,7 +1519,7 @@ "$id": "141", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "142", "kind": "url", @@ -1557,7 +1557,7 @@ "$id": "146", "Name": "imageJpegContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1633,7 +1633,7 @@ "$id": "152", "Name": "requiredContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1709,7 +1709,7 @@ "$id": "158", "Name": "optionalContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data for optional content type", + "Doc": "Test content-type: multipart/form-data for optional content type", "Accessibility": "public", "Parameters": [ { @@ -1791,7 +1791,7 @@ "$id": "165", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "166", "kind": "url", @@ -1829,7 +1829,7 @@ "$id": "170", "Name": "float", "ResourceName": "NonString", - "Description": "Test content-type: multipart/form-data for non string", + "Doc": "Test content-type: multipart/form-data for non string", "Accessibility": "public", "Parameters": [ { @@ -1911,7 +1911,7 @@ "$id": "177", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "178", "kind": "url", diff --git a/test/CadlRanchProjects/payload/pageable/tspCodeModel.json b/test/CadlRanchProjects/payload/pageable/tspCodeModel.json index fac2b6fdf72..b4296dbcd2b 100644 --- a/test/CadlRanchProjects/payload/pageable/tspCodeModel.json +++ b/test/CadlRanchProjects/payload/pageable/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "User", "crossLanguageDefinitionId": "Payload.Pageable.User", "usage": "Output,Json", - "description": "User model", + "doc": "User model", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "User name", + "doc": "User name", "type": { "$id": "4", "kind": "string", @@ -41,7 +41,7 @@ "name": "PagedUser", "crossLanguageDefinitionId": "Azure.Core.Page", "usage": "Output,Json", - "description": "Paged collection of User items", + "doc": "Paged collection of User items", "decorators": [], "properties": [ { @@ -49,7 +49,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The User items on this page", + "doc": "The User items on this page", "type": { "$id": "7", "kind": "array", @@ -72,7 +72,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "9", "kind": "url", @@ -101,20 +101,20 @@ { "$id": "11", "Name": "PageableClient", - "Description": "Test describing pageable.", + "Doc": "Test describing pageable.", "Operations": [ { "$id": "12", "Name": "list", "ResourceName": "Pageable", - "Description": "List users", + "Doc": "List users", "Accessibility": "public", "Parameters": [ { "$id": "13", "Name": "maxpagesize", "NameInRequest": "maxpagesize", - "Description": "The maximum number of result items per page.", + "Doc": "The maximum number of result items per page.", "Type": { "$id": "14", "kind": "int32", @@ -201,7 +201,7 @@ "$id": "21", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "22", "kind": "url", diff --git a/test/CadlRanchProjects/serialization/encoded-name/json/tspCodeModel.json b/test/CadlRanchProjects/serialization/encoded-name/json/tspCodeModel.json index c0c94e895dc..ff49774478e 100644 --- a/test/CadlRanchProjects/serialization/encoded-name/json/tspCodeModel.json +++ b/test/CadlRanchProjects/serialization/encoded-name/json/tspCodeModel.json @@ -17,7 +17,7 @@ "kind": "property", "name": "defaultName", "serializedName": "wireName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "4", "kind": "boolean", @@ -39,7 +39,7 @@ { "$id": "5", "Name": "JsonClient", - "Description": "Projection", + "Doc": "Projection", "Operations": [], "Protocol": { "$id": "6" @@ -49,7 +49,7 @@ "$id": "7", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "8", "kind": "url", @@ -93,7 +93,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -230,7 +230,7 @@ "$id": "24", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "25", "kind": "url", diff --git a/test/CadlRanchProjects/server/endpoint/not-defined/tspCodeModel.json b/test/CadlRanchProjects/server/endpoint/not-defined/tspCodeModel.json index 097d7cba3a8..2ab00f81615 100644 --- a/test/CadlRanchProjects/server/endpoint/not-defined/tspCodeModel.json +++ b/test/CadlRanchProjects/server/endpoint/not-defined/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "NotDefinedClient", - "Description": "Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.", + "Doc": "Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.", "Operations": [ { "$id": "3", @@ -46,7 +46,7 @@ "$id": "6", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "7", "kind": "url", diff --git a/test/CadlRanchProjects/server/path/multiple/tspCodeModel.json b/test/CadlRanchProjects/server/path/multiple/tspCodeModel.json index cd1fef80dc8..198f6ce797b 100644 --- a/test/CadlRanchProjects/server/path/multiple/tspCodeModel.json +++ b/test/CadlRanchProjects/server/path/multiple/tspCodeModel.json @@ -33,11 +33,11 @@ "enumType": { "$ref": "2" }, - "description": "Version 1.0", + "doc": "Version 1.0", "decorators": [] } ], - "description": "Service versions", + "doc": "Service versions", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -135,7 +135,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Pass in http://localhost:3000 for endpoint.", + "Doc": "Pass in http://localhost:3000 for endpoint.", "Type": { "$id": "15", "kind": "url", @@ -156,7 +156,7 @@ "$id": "16", "Name": "apiVersion", "NameInRequest": "apiVersion", - "Description": "Pass in v1.0 for API version.", + "Doc": "Pass in v1.0 for API version.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/server/path/single-headAsBoolean/tspCodeModel.json b/test/CadlRanchProjects/server/path/single-headAsBoolean/tspCodeModel.json index 636acaa93ef..1233ed4a75b 100644 --- a/test/CadlRanchProjects/server/path/single-headAsBoolean/tspCodeModel.json +++ b/test/CadlRanchProjects/server/path/single-headAsBoolean/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "SingleClient", - "Description": "Illustrates server with a single path parameter @server", + "Doc": "Illustrates server with a single path parameter @server", "Operations": [ { "$id": "3", @@ -46,7 +46,7 @@ "$id": "6", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "7", "kind": "url", diff --git a/test/CadlRanchProjects/server/path/single/tspCodeModel.json b/test/CadlRanchProjects/server/path/single/tspCodeModel.json index 636acaa93ef..1233ed4a75b 100644 --- a/test/CadlRanchProjects/server/path/single/tspCodeModel.json +++ b/test/CadlRanchProjects/server/path/single/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "SingleClient", - "Description": "Illustrates server with a single path parameter @server", + "Doc": "Illustrates server with a single path parameter @server", "Operations": [ { "$id": "3", @@ -46,7 +46,7 @@ "$id": "6", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "7", "kind": "url", diff --git a/test/CadlRanchProjects/server/versions/not-versioned/tspCodeModel.json b/test/CadlRanchProjects/server/versions/not-versioned/tspCodeModel.json index d0ce8e8b4ac..c337d4f2e00 100644 --- a/test/CadlRanchProjects/server/versions/not-versioned/tspCodeModel.json +++ b/test/CadlRanchProjects/server/versions/not-versioned/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "NotVersionedClient", - "Description": "Illustrates not-versioned server.", + "Doc": "Illustrates not-versioned server.", "Operations": [ { "$id": "3", @@ -144,7 +144,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjects/server/versions/versioned/tspCodeModel.json b/test/CadlRanchProjects/server/versions/versioned/tspCodeModel.json index 5cdd01c21b6..a9eb23eb2f1 100644 --- a/test/CadlRanchProjects/server/versions/versioned/tspCodeModel.json +++ b/test/CadlRanchProjects/server/versions/versioned/tspCodeModel.json @@ -34,7 +34,7 @@ "enumType": { "$ref": "2" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] }, { @@ -52,11 +52,11 @@ "enumType": { "$ref": "2" }, - "description": "The version 2022-12-01-preview.", + "doc": "The version 2022-12-01-preview.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -68,7 +68,7 @@ { "$id": "8", "Name": "VersionedClient", - "Description": "Illustrates versioned server.", + "Doc": "Illustrates versioned server.", "Operations": [ { "$id": "9", @@ -283,7 +283,7 @@ "$id": "30", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "31", "kind": "url", diff --git a/test/CadlRanchProjects/special-headers/conditional-request/tspCodeModel.json b/test/CadlRanchProjects/special-headers/conditional-request/tspCodeModel.json index 1ee0e40c9e2..4a91ded18f4 100644 --- a/test/CadlRanchProjects/special-headers/conditional-request/tspCodeModel.json +++ b/test/CadlRanchProjects/special-headers/conditional-request/tspCodeModel.json @@ -8,20 +8,20 @@ { "$id": "2", "Name": "ConditionalRequestClient", - "Description": "Illustrates conditional request headers", + "Doc": "Illustrates conditional request headers", "Operations": [ { "$id": "3", "Name": "postIfMatch", "ResourceName": "ConditionalRequest", - "Description": "Check when only If-Match in header is defined.", + "Doc": "Check when only If-Match in header is defined.", "Accessibility": "public", "Parameters": [ { "$id": "4", "Name": "ifMatch", "NameInRequest": "If-Match", - "Description": "The request should only proceed if an entity matches this string.", + "Doc": "The request should only proceed if an entity matches this string.", "Type": { "$id": "5", "kind": "string", @@ -65,14 +65,14 @@ "$id": "7", "Name": "postIfNoneMatch", "ResourceName": "ConditionalRequest", - "Description": "Check when only If-None-Match in header is defined.", + "Doc": "Check when only If-None-Match in header is defined.", "Accessibility": "public", "Parameters": [ { "$id": "8", "Name": "ifNoneMatch", "NameInRequest": "If-None-Match", - "Description": "The request should only proceed if no entity matches this string.", + "Doc": "The request should only proceed if no entity matches this string.", "Type": { "$id": "9", "kind": "string", @@ -116,14 +116,14 @@ "$id": "11", "Name": "headIfModifiedSince", "ResourceName": "ConditionalRequest", - "Description": "Check when only If-Modified-Since in header is defined.", + "Doc": "Check when only If-Modified-Since in header is defined.", "Accessibility": "public", "Parameters": [ { "$id": "12", "Name": "ifModifiedSince", "NameInRequest": "If-Modified-Since", - "Description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "Doc": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", "Type": { "$id": "13", "kind": "utcDateTime", @@ -175,14 +175,14 @@ "$id": "16", "Name": "postIfUnmodifiedSince", "ResourceName": "ConditionalRequest", - "Description": "Check when only If-Unmodified-Since in header is defined.", + "Doc": "Check when only If-Unmodified-Since in header is defined.", "Accessibility": "public", "Parameters": [ { "$id": "17", "Name": "ifUnmodifiedSince", "NameInRequest": "If-Unmodified-Since", - "Description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "Doc": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", "Type": { "$id": "18", "kind": "utcDateTime", @@ -239,7 +239,7 @@ "$id": "22", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "23", "kind": "url", diff --git a/test/CadlRanchProjects/special-headers/repeatability/tspCodeModel.json b/test/CadlRanchProjects/special-headers/repeatability/tspCodeModel.json index 313813feca7..0827f4750ff 100644 --- a/test/CadlRanchProjects/special-headers/repeatability/tspCodeModel.json +++ b/test/CadlRanchProjects/special-headers/repeatability/tspCodeModel.json @@ -62,13 +62,13 @@ { "$id": "8", "Name": "RepeatabilityClient", - "Description": "Illustrates OASIS repeatability headers", + "Doc": "Illustrates OASIS repeatability headers", "Operations": [ { "$id": "9", "Name": "immediateSuccess", "ResourceName": "Repeatability", - "Description": "Check we recognize Repeatability-Request-ID and Repeatability-First-Sent.", + "Doc": "Check we recognize Repeatability-Request-ID and Repeatability-First-Sent.", "Accessibility": "public", "Parameters": [ { @@ -134,7 +134,7 @@ "$id": "16", "Name": "repeatabilityResult", "NameInResponse": "Repeatability-Result", - "Description": "Indicates whether the repeatable request was accepted or rejected.", + "Doc": "Indicates whether the repeatable request was accepted or rejected.", "Type": { "$ref": "2" } @@ -162,7 +162,7 @@ "$id": "18", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "19", "kind": "url", diff --git a/test/CadlRanchProjects/special-words/tspCodeModel.json b/test/CadlRanchProjects/special-words/tspCodeModel.json index 7d34c9f09f2..aa7a904a887 100644 --- a/test/CadlRanchProjects/special-words/tspCodeModel.json +++ b/test/CadlRanchProjects/special-words/tspCodeModel.json @@ -995,7 +995,7 @@ { "$id": "104", "Name": "SpecialWordsClient", - "Description": "Scenarios to verify that reserved words can be used in service and generators will handle it appropriately.\n\nCurrent list of special words\n```txt\nand\nas\nassert\nasync\nawait\nbreak\nclass\nconstructor\ncontinue\ndef\ndel\nelif\nelse\nexcept\nexec\nfinally\nfor\nfrom\nglobal\nif\nimport\nin\nis\nlambda\nnot\nor\npass\nraise\nreturn\ntry\nwhile\nwith\nyield\n```", + "Doc": "Scenarios to verify that reserved words can be used in service and generators will handle it appropriately.\n\nCurrent list of special words\n```txt\nand\nas\nassert\nasync\nawait\nbreak\nclass\nconstructor\ncontinue\ndef\ndel\nelif\nelse\nexcept\nexec\nfinally\nfor\nfrom\nglobal\nif\nimport\nin\nis\nlambda\nnot\nor\npass\nraise\nreturn\ntry\nwhile\nwith\nyield\n```", "Operations": [], "Protocol": { "$id": "105" @@ -1005,7 +1005,7 @@ "$id": "106", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "107", "kind": "url", @@ -1038,7 +1038,7 @@ { "$id": "110", "Name": "Models", - "Description": "Verify model names", + "Doc": "Verify model names", "Operations": [ { "$id": "111", @@ -1050,7 +1050,7 @@ "$id": "112", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "113", "kind": "constant", @@ -1126,7 +1126,7 @@ "$id": "118", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "119", "kind": "constant", @@ -1202,7 +1202,7 @@ "$id": "124", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "125", "kind": "constant", @@ -1278,7 +1278,7 @@ "$id": "130", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "131", "kind": "constant", @@ -1354,7 +1354,7 @@ "$id": "136", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "137", "kind": "constant", @@ -1430,7 +1430,7 @@ "$id": "142", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "143", "kind": "constant", @@ -1506,7 +1506,7 @@ "$id": "148", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "149", "kind": "constant", @@ -1582,7 +1582,7 @@ "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1658,7 +1658,7 @@ "$id": "160", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "161", "kind": "constant", @@ -1734,7 +1734,7 @@ "$id": "166", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "167", "kind": "constant", @@ -1810,7 +1810,7 @@ "$id": "172", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "173", "kind": "constant", @@ -1886,7 +1886,7 @@ "$id": "178", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "179", "kind": "constant", @@ -1962,7 +1962,7 @@ "$id": "184", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "185", "kind": "constant", @@ -2038,7 +2038,7 @@ "$id": "190", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "191", "kind": "constant", @@ -2114,7 +2114,7 @@ "$id": "196", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "197", "kind": "constant", @@ -2190,7 +2190,7 @@ "$id": "202", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "203", "kind": "constant", @@ -2266,7 +2266,7 @@ "$id": "208", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "209", "kind": "constant", @@ -2342,7 +2342,7 @@ "$id": "214", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "215", "kind": "constant", @@ -2418,7 +2418,7 @@ "$id": "220", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "221", "kind": "constant", @@ -2494,7 +2494,7 @@ "$id": "226", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "227", "kind": "constant", @@ -2570,7 +2570,7 @@ "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2646,7 +2646,7 @@ "$id": "238", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "239", "kind": "constant", @@ -2722,7 +2722,7 @@ "$id": "244", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "245", "kind": "constant", @@ -2798,7 +2798,7 @@ "$id": "250", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "251", "kind": "constant", @@ -2874,7 +2874,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2950,7 +2950,7 @@ "$id": "262", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "263", "kind": "constant", @@ -3026,7 +3026,7 @@ "$id": "268", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "269", "kind": "constant", @@ -3102,7 +3102,7 @@ "$id": "274", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "275", "kind": "constant", @@ -3178,7 +3178,7 @@ "$id": "280", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "281", "kind": "constant", @@ -3254,7 +3254,7 @@ "$id": "286", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "287", "kind": "constant", @@ -3330,7 +3330,7 @@ "$id": "292", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "293", "kind": "constant", @@ -3406,7 +3406,7 @@ "$id": "298", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "299", "kind": "constant", @@ -3482,7 +3482,7 @@ "$id": "304", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "305", "kind": "constant", @@ -3558,7 +3558,7 @@ "$id": "310", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "311", "kind": "url", @@ -3591,7 +3591,7 @@ { "$id": "314", "Name": "ModelProperties", - "Description": "Verify model names", + "Doc": "Verify model names", "Operations": [ { "$id": "315", @@ -3603,7 +3603,7 @@ "$id": "316", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "317", "kind": "constant", @@ -3679,7 +3679,7 @@ "$id": "322", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "323", "kind": "url", @@ -3712,7 +3712,7 @@ { "$id": "326", "Name": "Operations", - "Description": "Test reserved words as operation name.", + "Doc": "Test reserved words as operation name.", "Operations": [ { "$id": "327", @@ -4615,7 +4615,7 @@ "$id": "394", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "395", "kind": "url", @@ -4648,7 +4648,7 @@ { "$id": "398", "Name": "Parameters", - "Description": "Verify reserved words as parameter name.", + "Doc": "Verify reserved words as parameter name.", "Operations": [ { "$id": "399", @@ -6326,7 +6326,7 @@ "$id": "536", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "537", "kind": "url", diff --git a/test/CadlRanchProjects/type/array/tspCodeModel.json b/test/CadlRanchProjects/type/array/tspCodeModel.json index 3fecf5468b8..d6e1378995e 100644 --- a/test/CadlRanchProjects/type/array/tspCodeModel.json +++ b/test/CadlRanchProjects/type/array/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Array.InnerModel", "usage": "Input,Output,Json", - "description": "Array inner model", + "doc": "Array inner model", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "4", "kind": "string", @@ -62,7 +62,7 @@ { "$id": "7", "Name": "ArrayClient", - "Description": "Illustrates various types of arrays.", + "Doc": "Illustrates various types of arrays.", "Operations": [], "Protocol": { "$id": "8" @@ -72,7 +72,7 @@ "$id": "9", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "10", "kind": "url", @@ -105,7 +105,7 @@ { "$id": "13", "Name": "Int32Value", - "Description": "Array of int32 values", + "Doc": "Array of int32 values", "Operations": [ { "$id": "14", @@ -189,7 +189,7 @@ "$id": "22", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "23", "kind": "constant", @@ -276,7 +276,7 @@ "$id": "30", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "31", "kind": "url", @@ -309,7 +309,7 @@ { "$id": "34", "Name": "Int64Value", - "Description": "Array of int64 values", + "Doc": "Array of int64 values", "Operations": [ { "$id": "35", @@ -393,7 +393,7 @@ "$id": "43", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "44", "kind": "constant", @@ -480,7 +480,7 @@ "$id": "51", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "52", "kind": "url", @@ -513,7 +513,7 @@ { "$id": "55", "Name": "BooleanValue", - "Description": "Array of boolean values", + "Doc": "Array of boolean values", "Operations": [ { "$id": "56", @@ -597,7 +597,7 @@ "$id": "64", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "65", "kind": "constant", @@ -684,7 +684,7 @@ "$id": "72", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "73", "kind": "url", @@ -717,7 +717,7 @@ { "$id": "76", "Name": "StringValue", - "Description": "Array of string values", + "Doc": "Array of string values", "Operations": [ { "$id": "77", @@ -801,7 +801,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -888,7 +888,7 @@ "$id": "93", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "94", "kind": "url", @@ -921,7 +921,7 @@ { "$id": "97", "Name": "Float32Value", - "Description": "Array of float values", + "Doc": "Array of float values", "Operations": [ { "$id": "98", @@ -1005,7 +1005,7 @@ "$id": "106", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "107", "kind": "constant", @@ -1092,7 +1092,7 @@ "$id": "114", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "115", "kind": "url", @@ -1125,7 +1125,7 @@ { "$id": "118", "Name": "DatetimeValue", - "Description": "Array of datetime values", + "Doc": "Array of datetime values", "Operations": [ { "$id": "119", @@ -1217,7 +1217,7 @@ "$id": "128", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "129", "kind": "constant", @@ -1312,7 +1312,7 @@ "$id": "137", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "138", "kind": "url", @@ -1345,7 +1345,7 @@ { "$id": "141", "Name": "DurationValue", - "Description": "Array of duration values", + "Doc": "Array of duration values", "Operations": [ { "$id": "142", @@ -1437,7 +1437,7 @@ "$id": "151", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "152", "kind": "constant", @@ -1532,7 +1532,7 @@ "$id": "160", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "161", "kind": "url", @@ -1565,7 +1565,7 @@ { "$id": "164", "Name": "UnknownValue", - "Description": "Array of unknown values", + "Doc": "Array of unknown values", "Operations": [ { "$id": "165", @@ -1649,7 +1649,7 @@ "$id": "173", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "174", "kind": "constant", @@ -1736,7 +1736,7 @@ "$id": "181", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "182", "kind": "url", @@ -1769,7 +1769,7 @@ { "$id": "185", "Name": "ModelValue", - "Description": "Array of model values", + "Doc": "Array of model values", "Operations": [ { "$id": "186", @@ -1849,7 +1849,7 @@ "$id": "193", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "194", "kind": "constant", @@ -1932,7 +1932,7 @@ "$id": "200", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "201", "kind": "url", @@ -1965,7 +1965,7 @@ { "$id": "204", "Name": "NullableFloatValue", - "Description": "Array of nullable float values", + "Doc": "Array of nullable float values", "Operations": [ { "$id": "205", @@ -2053,7 +2053,7 @@ "$id": "214", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "215", "kind": "constant", @@ -2136,7 +2136,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2169,7 +2169,7 @@ { "$id": "225", "Name": "NullableInt32Value", - "Description": "Array of nullable int32 values", + "Doc": "Array of nullable int32 values", "Operations": [ { "$id": "226", @@ -2257,7 +2257,7 @@ "$id": "235", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "236", "kind": "constant", @@ -2340,7 +2340,7 @@ "$id": "242", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "243", "kind": "url", @@ -2373,7 +2373,7 @@ { "$id": "246", "Name": "NullableBooleanValue", - "Description": "Array of nullable boolean values", + "Doc": "Array of nullable boolean values", "Operations": [ { "$id": "247", @@ -2461,7 +2461,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2544,7 +2544,7 @@ "$id": "263", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "264", "kind": "url", @@ -2577,7 +2577,7 @@ { "$id": "267", "Name": "NullableStringValue", - "Description": "Array of nullable string values", + "Doc": "Array of nullable string values", "Operations": [ { "$id": "268", @@ -2665,7 +2665,7 @@ "$id": "277", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "278", "kind": "constant", @@ -2748,7 +2748,7 @@ "$id": "284", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "285", "kind": "url", @@ -2781,7 +2781,7 @@ { "$id": "288", "Name": "NullableModelValue", - "Description": "Array of nullable model values", + "Doc": "Array of nullable model values", "Operations": [ { "$id": "289", @@ -2865,7 +2865,7 @@ "$id": "297", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "298", "kind": "constant", @@ -2948,7 +2948,7 @@ "$id": "304", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "305", "kind": "url", diff --git a/test/CadlRanchProjects/type/dictionary/tspCodeModel.json b/test/CadlRanchProjects/type/dictionary/tspCodeModel.json index 870aab372bd..66058bb59cb 100644 --- a/test/CadlRanchProjects/type/dictionary/tspCodeModel.json +++ b/test/CadlRanchProjects/type/dictionary/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Dictionary.InnerModel", "usage": "Input,Output,Json", - "description": "Dictionary inner model", + "doc": "Dictionary inner model", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "4", "kind": "string", @@ -67,7 +67,7 @@ { "$id": "8", "Name": "DictionaryClient", - "Description": "Illustrates various of dictionaries.", + "Doc": "Illustrates various of dictionaries.", "Operations": [], "Protocol": { "$id": "9" @@ -77,7 +77,7 @@ "$id": "10", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "11", "kind": "url", @@ -110,7 +110,7 @@ { "$id": "14", "Name": "Int32Value", - "Description": "Dictionary of int32 values", + "Doc": "Dictionary of int32 values", "Operations": [ { "$id": "15", @@ -199,7 +199,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -291,7 +291,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", @@ -324,7 +324,7 @@ { "$id": "37", "Name": "Int64Value", - "Description": "Dictionary of int64 values", + "Doc": "Dictionary of int64 values", "Operations": [ { "$id": "38", @@ -413,7 +413,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -505,7 +505,7 @@ "$id": "56", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "57", "kind": "url", @@ -538,7 +538,7 @@ { "$id": "60", "Name": "BooleanValue", - "Description": "Dictionary of boolean values", + "Doc": "Dictionary of boolean values", "Operations": [ { "$id": "61", @@ -627,7 +627,7 @@ "$id": "70", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "71", "kind": "constant", @@ -719,7 +719,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -752,7 +752,7 @@ { "$id": "83", "Name": "StringValue", - "Description": "Dictionary of string values", + "Doc": "Dictionary of string values", "Operations": [ { "$id": "84", @@ -841,7 +841,7 @@ "$id": "93", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "94", "kind": "constant", @@ -933,7 +933,7 @@ "$id": "102", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "103", "kind": "url", @@ -966,7 +966,7 @@ { "$id": "106", "Name": "Float32Value", - "Description": "Dictionary of float values", + "Doc": "Dictionary of float values", "Operations": [ { "$id": "107", @@ -1055,7 +1055,7 @@ "$id": "116", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "117", "kind": "constant", @@ -1147,7 +1147,7 @@ "$id": "125", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "126", "kind": "url", @@ -1180,7 +1180,7 @@ { "$id": "129", "Name": "DatetimeValue", - "Description": "Dictionary of datetime values", + "Doc": "Dictionary of datetime values", "Operations": [ { "$id": "130", @@ -1277,7 +1277,7 @@ "$id": "140", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "141", "kind": "constant", @@ -1377,7 +1377,7 @@ "$id": "150", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "151", "kind": "url", @@ -1410,7 +1410,7 @@ { "$id": "154", "Name": "DurationValue", - "Description": "Dictionary of duration values", + "Doc": "Dictionary of duration values", "Operations": [ { "$id": "155", @@ -1507,7 +1507,7 @@ "$id": "165", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "166", "kind": "constant", @@ -1607,7 +1607,7 @@ "$id": "175", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "176", "kind": "url", @@ -1640,7 +1640,7 @@ { "$id": "179", "Name": "UnknownValue", - "Description": "Dictionary of unknown values", + "Doc": "Dictionary of unknown values", "Operations": [ { "$id": "180", @@ -1729,7 +1729,7 @@ "$id": "189", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "190", "kind": "constant", @@ -1821,7 +1821,7 @@ "$id": "198", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "199", "kind": "url", @@ -1854,7 +1854,7 @@ { "$id": "202", "Name": "ModelValue", - "Description": "Dictionary of model values", + "Doc": "Dictionary of model values", "Operations": [ { "$id": "203", @@ -1939,7 +1939,7 @@ "$id": "211", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "212", "kind": "constant", @@ -2027,7 +2027,7 @@ "$id": "219", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "220", "kind": "url", @@ -2060,7 +2060,7 @@ { "$id": "223", "Name": "RecursiveModelValue", - "Description": "Dictionary of model values", + "Doc": "Dictionary of model values", "Operations": [ { "$id": "224", @@ -2145,7 +2145,7 @@ "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2233,7 +2233,7 @@ "$id": "240", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "241", "kind": "url", @@ -2266,7 +2266,7 @@ { "$id": "244", "Name": "NullableFloatValue", - "Description": "Dictionary of nullable float values", + "Doc": "Dictionary of nullable float values", "Operations": [ { "$id": "245", @@ -2359,7 +2359,7 @@ "$id": "255", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "256", "kind": "constant", @@ -2447,7 +2447,7 @@ "$id": "263", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "264", "kind": "url", diff --git a/test/CadlRanchProjects/type/enum/extensible/tspCodeModel.json b/test/CadlRanchProjects/type/enum/extensible/tspCodeModel.json index e1a58db7dd6..8cc09068b11 100644 --- a/test/CadlRanchProjects/type/enum/extensible/tspCodeModel.json +++ b/test/CadlRanchProjects/type/enum/extensible/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "Monday.", + "doc": "Monday.", "decorators": [] }, { @@ -49,7 +49,7 @@ "enumType": { "$ref": "2" }, - "description": "Tuesday.", + "doc": "Tuesday.", "decorators": [] }, { @@ -67,7 +67,7 @@ "enumType": { "$ref": "2" }, - "description": "Wednesday.", + "doc": "Wednesday.", "decorators": [] }, { @@ -85,7 +85,7 @@ "enumType": { "$ref": "2" }, - "description": "Thursday.", + "doc": "Thursday.", "decorators": [] }, { @@ -103,7 +103,7 @@ "enumType": { "$ref": "2" }, - "description": "Friday.", + "doc": "Friday.", "decorators": [] }, { @@ -121,7 +121,7 @@ "enumType": { "$ref": "2" }, - "description": "Saturday.", + "doc": "Saturday.", "decorators": [] }, { @@ -139,11 +139,11 @@ "enumType": { "$ref": "2" }, - "description": "Sunday.", + "doc": "Sunday.", "decorators": [] } ], - "description": "Days of the week", + "doc": "Days of the week", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -164,7 +164,7 @@ "$id": "20", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "21", "kind": "url", @@ -330,7 +330,7 @@ "$id": "36", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "37", "kind": "constant", @@ -406,7 +406,7 @@ "$id": "42", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "43", "kind": "constant", @@ -482,7 +482,7 @@ "$id": "48", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "49", "kind": "url", diff --git a/test/CadlRanchProjects/type/enum/fixed/tspCodeModel.json b/test/CadlRanchProjects/type/enum/fixed/tspCodeModel.json index 619ff5a0c5e..3487706435a 100644 --- a/test/CadlRanchProjects/type/enum/fixed/tspCodeModel.json +++ b/test/CadlRanchProjects/type/enum/fixed/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "Monday.", + "doc": "Monday.", "decorators": [] }, { @@ -49,7 +49,7 @@ "enumType": { "$ref": "2" }, - "description": "Tuesday.", + "doc": "Tuesday.", "decorators": [] }, { @@ -67,7 +67,7 @@ "enumType": { "$ref": "2" }, - "description": "Wednesday.", + "doc": "Wednesday.", "decorators": [] }, { @@ -85,7 +85,7 @@ "enumType": { "$ref": "2" }, - "description": "Thursday.", + "doc": "Thursday.", "decorators": [] }, { @@ -103,7 +103,7 @@ "enumType": { "$ref": "2" }, - "description": "Friday.", + "doc": "Friday.", "decorators": [] }, { @@ -121,7 +121,7 @@ "enumType": { "$ref": "2" }, - "description": "Saturday.", + "doc": "Saturday.", "decorators": [] }, { @@ -139,11 +139,11 @@ "enumType": { "$ref": "2" }, - "description": "Sunday.", + "doc": "Sunday.", "decorators": [] } ], - "description": "Days of the week", + "doc": "Days of the week", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -164,7 +164,7 @@ "$id": "20", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "21", "kind": "url", @@ -202,7 +202,7 @@ "$id": "25", "Name": "getKnownValue", "ResourceName": "String", - "Description": "getKnownValue", + "Doc": "getKnownValue", "Accessibility": "public", "Parameters": [ { @@ -264,14 +264,14 @@ "$id": "30", "Name": "putKnownValue", "ResourceName": "String", - "Description": "putKnownValue", + "Doc": "putKnownValue", "Accessibility": "public", "Parameters": [ { "$id": "31", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "32", "kind": "constant", @@ -299,7 +299,7 @@ "$id": "34", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "2" }, @@ -342,14 +342,14 @@ "$id": "36", "Name": "putUnknownValue", "ResourceName": "String", - "Description": "putUnknownValue", + "Doc": "putUnknownValue", "Accessibility": "public", "Parameters": [ { "$id": "37", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "38", "kind": "constant", @@ -377,7 +377,7 @@ "$id": "40", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "2" }, @@ -426,7 +426,7 @@ "$id": "43", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "44", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/empty/tspCodeModel.json b/test/CadlRanchProjects/type/model/empty/tspCodeModel.json index e645bf40273..293823d38fd 100644 --- a/test/CadlRanchProjects/type/model/empty/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/empty/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "EmptyInput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyInput", "usage": "Input,Json", - "description": "Empty model used in operation parameters", + "doc": "Empty model used in operation parameters", "decorators": [], "properties": [] }, @@ -20,7 +20,7 @@ "name": "EmptyOutput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyOutput", "usage": "Output,Json", - "description": "Empty model used in operation return type", + "doc": "Empty model used in operation return type", "decorators": [], "properties": [] }, @@ -30,7 +30,7 @@ "name": "EmptyInputOutput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyInputOutput", "usage": "Input,Output,Json", - "description": "Empty model used in both parameter and return type", + "doc": "Empty model used in both parameter and return type", "decorators": [], "properties": [] } @@ -39,7 +39,7 @@ { "$id": "5", "Name": "EmptyClient", - "Description": "Illustrates usage of empty model used in operation's parameters and responses.", + "Doc": "Illustrates usage of empty model used in operation's parameters and responses.", "Operations": [ { "$id": "6", @@ -51,7 +51,7 @@ "$id": "7", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "8", "kind": "constant", @@ -188,7 +188,7 @@ "$id": "18", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "19", "kind": "constant", @@ -296,7 +296,7 @@ "$id": "27", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "28", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/inheritance/enum-discriminator/tspCodeModel.json b/test/CadlRanchProjects/type/model/inheritance/enum-discriminator/tspCodeModel.json index 3c94a1dd972..ffb18ff3534 100644 --- a/test/CadlRanchProjects/type/model/inheritance/enum-discriminator/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/inheritance/enum-discriminator/tspCodeModel.json @@ -31,11 +31,11 @@ "enumType": { "$ref": "2" }, - "description": "Species golden", + "doc": "Species golden", "decorators": [] } ], - "description": "extensible enum type for discriminator", + "doc": "extensible enum type for discriminator", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -69,11 +69,11 @@ "enumType": { "$ref": "6" }, - "description": "Species cobra", + "doc": "Species cobra", "decorators": [] } ], - "description": "fixed enum type for discriminator", + "doc": "fixed enum type for discriminator", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -87,14 +87,14 @@ "name": "Dog", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Dog", "usage": "Input,Output,Json", - "description": "Test extensible enum type for discriminator", + "doc": "Test extensible enum type for discriminator", "decorators": [], "discriminatorProperty": { "$id": "11", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$ref": "2" }, @@ -114,7 +114,7 @@ "kind": "property", "name": "weight", "serializedName": "weight", - "description": "Weight of the dog", + "doc": "Weight of the dog", "type": { "$id": "13", "kind": "int32", @@ -138,7 +138,7 @@ "name": "Golden", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Golden", "usage": "Input,Output,Json", - "description": "Golden dog model", + "doc": "Golden dog model", "discriminatorValue": "golden", "decorators": [], "baseModel": { @@ -150,7 +150,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$id": "17", "kind": "constant", @@ -184,14 +184,14 @@ "name": "Snake", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Snake", "usage": "Input,Output,Json", - "description": "Test fixed enum type for discriminator", + "doc": "Test fixed enum type for discriminator", "decorators": [], "discriminatorProperty": { "$id": "20", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$ref": "6" }, @@ -211,7 +211,7 @@ "kind": "property", "name": "length", "serializedName": "length", - "description": "Length of the snake", + "doc": "Length of the snake", "type": { "$id": "22", "kind": "int32", @@ -235,7 +235,7 @@ "name": "Cobra", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Cobra", "usage": "Input,Output,Json", - "description": "Cobra model", + "doc": "Cobra model", "discriminatorValue": "cobra", "decorators": [], "baseModel": { @@ -247,7 +247,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$id": "26", "kind": "constant", @@ -280,13 +280,13 @@ { "$id": "28", "Name": "EnumDiscriminatorClient", - "Description": "Illustrates inheritance with enum discriminator.", + "Doc": "Illustrates inheritance with enum discriminator.", "Operations": [ { "$id": "29", "Name": "getExtensibleModel", "ResourceName": "EnumDiscriminator", - "Description": "Receive model with extensible enum discriminator type.", + "Doc": "Receive model with extensible enum discriminator type.", "Accessibility": "public", "Parameters": [ { @@ -348,14 +348,14 @@ "$id": "34", "Name": "putExtensibleModel", "ResourceName": "EnumDiscriminator", - "Description": "Send model with extensible enum discriminator type.", + "Doc": "Send model with extensible enum discriminator type.", "Accessibility": "public", "Parameters": [ { "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -383,7 +383,7 @@ "$id": "38", "Name": "input", "NameInRequest": "input", - "Description": "Dog to create", + "Doc": "Dog to create", "Type": { "$ref": "10" }, @@ -426,7 +426,7 @@ "$id": "40", "Name": "getExtensibleModelMissingDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model omitting the discriminator.", + "Doc": "Get a model omitting the discriminator.", "Accessibility": "public", "Parameters": [ { @@ -488,7 +488,7 @@ "$id": "45", "Name": "getExtensibleModelWrongDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model containing discriminator value never defined.", + "Doc": "Get a model containing discriminator value never defined.", "Accessibility": "public", "Parameters": [ { @@ -550,7 +550,7 @@ "$id": "50", "Name": "getFixedModel", "ResourceName": "EnumDiscriminator", - "Description": "Receive model with fixed enum discriminator type.", + "Doc": "Receive model with fixed enum discriminator type.", "Accessibility": "public", "Parameters": [ { @@ -612,14 +612,14 @@ "$id": "55", "Name": "putFixedModel", "ResourceName": "EnumDiscriminator", - "Description": "Send model with fixed enum discriminator type.", + "Doc": "Send model with fixed enum discriminator type.", "Accessibility": "public", "Parameters": [ { "$id": "56", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "57", "kind": "constant", @@ -647,7 +647,7 @@ "$id": "59", "Name": "input", "NameInRequest": "input", - "Description": "Snake to create", + "Doc": "Snake to create", "Type": { "$ref": "19" }, @@ -690,7 +690,7 @@ "$id": "61", "Name": "getFixedModelMissingDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model omitting the discriminator.", + "Doc": "Get a model omitting the discriminator.", "Accessibility": "public", "Parameters": [ { @@ -752,7 +752,7 @@ "$id": "66", "Name": "getFixedModelWrongDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model containing discriminator value never defined.", + "Doc": "Get a model containing discriminator value never defined.", "Accessibility": "public", "Parameters": [ { @@ -819,7 +819,7 @@ "$id": "72", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "73", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/inheritance/not-discriminated/tspCodeModel.json b/test/CadlRanchProjects/type/model/inheritance/not-discriminated/tspCodeModel.json index abe203cb12c..a29b2e35669 100644 --- a/test/CadlRanchProjects/type/model/inheritance/not-discriminated/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/inheritance/not-discriminated/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Siamese", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Siamese", "usage": "Input,Output,Json", - "description": "The third level model in the normal multiple levels inheritance.", + "doc": "The third level model in the normal multiple levels inheritance.", "decorators": [], "baseModel": { "$id": "3", @@ -18,7 +18,7 @@ "name": "Cat", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Cat", "usage": "Input,Output,Json", - "description": "The second level model in the normal multiple levels inheritance.", + "doc": "The second level model in the normal multiple levels inheritance.", "decorators": [], "baseModel": { "$id": "4", @@ -26,7 +26,7 @@ "name": "Pet", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Pet", "usage": "Input,Output,Json", - "description": "This is base model for not-discriminated normal multiple levels inheritance.", + "doc": "This is base model for not-discriminated normal multiple levels inheritance.", "decorators": [], "properties": [ { @@ -105,7 +105,7 @@ { "$id": "11", "Name": "NotDiscriminatedClient", - "Description": "Illustrates not-discriminated inheritance model.", + "Doc": "Illustrates not-discriminated inheritance model.", "Operations": [ { "$id": "12", @@ -117,7 +117,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -254,7 +254,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -362,7 +362,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/inheritance/recursive/tspCodeModel.json b/test/CadlRanchProjects/type/model/inheritance/recursive/tspCodeModel.json index 209ea500b16..a6125807007 100644 --- a/test/CadlRanchProjects/type/model/inheritance/recursive/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/inheritance/recursive/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Extension", "crossLanguageDefinitionId": "Type.Model.Inheritance.Recursive.Extension", "usage": "Input,Output,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "3", @@ -18,7 +18,7 @@ "name": "Element", "crossLanguageDefinitionId": "Type.Model.Inheritance.Recursive.Element", "usage": "Input,Output,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -75,7 +75,7 @@ { "$id": "8", "Name": "RecursiveClient", - "Description": "Illustrates inheritance recursion", + "Doc": "Illustrates inheritance recursion", "Operations": [ { "$id": "9", @@ -87,7 +87,7 @@ "$id": "10", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "11", "kind": "constant", @@ -223,7 +223,7 @@ "$id": "21", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "22", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/inheritance/single-discriminator/tspCodeModel.json b/test/CadlRanchProjects/type/model/inheritance/single-discriminator/tspCodeModel.json index 0075459cad1..61d5c2e68ca 100644 --- a/test/CadlRanchProjects/type/model/inheritance/single-discriminator/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/inheritance/single-discriminator/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Bird", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Bird", "usage": "Input,Output,Json", - "description": "This is base model for polymorphic single level inheritance with a discriminator.", + "doc": "This is base model for polymorphic single level inheritance with a discriminator.", "decorators": [], "discriminatorProperty": { "$id": "3", @@ -63,7 +63,7 @@ "name": "SeaGull", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.SeaGull", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "seagull", "decorators": [], "baseModel": { @@ -103,7 +103,7 @@ "name": "Sparrow", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Sparrow", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "sparrow", "decorators": [], "baseModel": { @@ -143,7 +143,7 @@ "name": "Goose", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Goose", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "goose", "decorators": [], "baseModel": { @@ -183,7 +183,7 @@ "name": "Eagle", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Eagle", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single levels inheritance which contains references to other polymorphic instances.", + "doc": "The second level model in polymorphic single levels inheritance which contains references to other polymorphic instances.", "discriminatorValue": "eagle", "decorators": [], "baseModel": { @@ -301,14 +301,14 @@ "name": "Dinosaur", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Dinosaur", "usage": "Output,Json", - "description": "Define a base class in the legacy way. Discriminator property is not explicitly defined in the model.", + "doc": "Define a base class in the legacy way. Discriminator property is not explicitly defined in the model.", "decorators": [], "discriminatorProperty": { "$id": "31", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "Discriminator property for Dinosaur.", + "doc": "Discriminator property for Dinosaur.", "type": { "$id": "32", "kind": "string", @@ -355,7 +355,7 @@ "name": "TRex", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.TRex", "usage": "Output,Json", - "description": "The second level legacy model in polymorphic single level inheritance.", + "doc": "The second level legacy model in polymorphic single level inheritance.", "discriminatorValue": "t-rex", "decorators": [], "baseModel": { @@ -399,7 +399,7 @@ { "$id": "40", "Name": "SingleDiscriminatorClient", - "Description": "Illustrates inheritance with single discriminator.", + "Doc": "Illustrates inheritance with single discriminator.", "Operations": [ { "$id": "41", @@ -472,7 +472,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -609,7 +609,7 @@ "$id": "58", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "59", "kind": "constant", @@ -867,7 +867,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/usage/tspCodeModel.json b/test/CadlRanchProjects/type/model/usage/tspCodeModel.json index e73fd5363ed..88e7279715e 100644 --- a/test/CadlRanchProjects/type/model/usage/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/usage/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.InputRecord", "usage": "Input,Json", - "description": "Record used in operation parameters", + "doc": "Record used in operation parameters", "decorators": [], "properties": [ { @@ -40,7 +40,7 @@ "name": "OutputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.OutputRecord", "usage": "Output,Json", - "description": "Record used in operation return type", + "doc": "Record used in operation return type", "decorators": [], "properties": [ { @@ -70,7 +70,7 @@ "name": "InputOutputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.InputOutputRecord", "usage": "Input,Output,Json", - "description": "Record used both as operation parameter and return type", + "doc": "Record used both as operation parameter and return type", "decorators": [], "properties": [ { @@ -99,7 +99,7 @@ { "$id": "11", "Name": "UsageClient", - "Description": "Illustrates usage of Record in different places(Operation parameters, return type or both).", + "Doc": "Illustrates usage of Record in different places(Operation parameters, return type or both).", "Operations": [ { "$id": "12", @@ -111,7 +111,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -248,7 +248,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -356,7 +356,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", diff --git a/test/CadlRanchProjects/type/model/visibility/tspCodeModel.json b/test/CadlRanchProjects/type/model/visibility/tspCodeModel.json index 54b8391348a..5f3b9906f0a 100644 --- a/test/CadlRanchProjects/type/model/visibility/tspCodeModel.json +++ b/test/CadlRanchProjects/type/model/visibility/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "VisibilityModel", "crossLanguageDefinitionId": "Type.Model.Visibility.VisibilityModel", "usage": "Input,Output,Json", - "description": "Output model with visibility properties.", + "doc": "Output model with visibility properties.", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "readProp", "serializedName": "readProp", - "description": "Required string, illustrating a readonly property.", + "doc": "Required string, illustrating a readonly property.", "type": { "$id": "4", "kind": "string", @@ -38,7 +38,7 @@ "kind": "property", "name": "queryProp", "serializedName": "queryProp", - "description": "Required int32, illustrating a query property.", + "doc": "Required int32, illustrating a query property.", "type": { "$id": "6", "kind": "int32", @@ -58,7 +58,7 @@ "kind": "property", "name": "createProp", "serializedName": "createProp", - "description": "Required string[], illustrating a create property.", + "doc": "Required string[], illustrating a create property.", "type": { "$id": "8", "kind": "array", @@ -85,7 +85,7 @@ "kind": "property", "name": "updateProp", "serializedName": "updateProp", - "description": "Required int32[], illustrating a update property.", + "doc": "Required int32[], illustrating a update property.", "type": { "$id": "11", "kind": "array", @@ -112,7 +112,7 @@ "kind": "property", "name": "deleteProp", "serializedName": "deleteProp", - "description": "Required bool, illustrating a delete property.", + "doc": "Required bool, illustrating a delete property.", "type": { "$id": "14", "kind": "boolean", @@ -135,7 +135,7 @@ "name": "ReadOnlyModel", "crossLanguageDefinitionId": "Type.Model.Visibility.ReadOnlyModel", "usage": "Input,Output,Json", - "description": "RoundTrip model with readonly optional properties.", + "doc": "RoundTrip model with readonly optional properties.", "decorators": [], "properties": [ { @@ -143,7 +143,7 @@ "kind": "property", "name": "optionalNullableIntList", "serializedName": "optionalNullableIntList", - "description": "Optional readonly nullable int list.", + "doc": "Optional readonly nullable int list.", "type": { "$id": "17", "kind": "nullable", @@ -174,7 +174,7 @@ "kind": "property", "name": "optionalStringRecord", "serializedName": "optionalStringRecord", - "description": "Optional readonly string dictionary.", + "doc": "Optional readonly string dictionary.", "type": { "$id": "21", "kind": "dict", @@ -208,7 +208,7 @@ { "$id": "24", "Name": "VisibilityClient", - "Description": "Illustrates models with visibility properties.", + "Doc": "Illustrates models with visibility properties.", "Operations": [ { "$id": "25", @@ -220,7 +220,7 @@ "$id": "26", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "27", "kind": "constant", @@ -329,7 +329,7 @@ "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -405,7 +405,7 @@ "$id": "41", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "42", "kind": "constant", @@ -481,7 +481,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -557,7 +557,7 @@ "$id": "53", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "54", "kind": "constant", @@ -633,7 +633,7 @@ "$id": "59", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "60", "kind": "constant", @@ -709,7 +709,7 @@ "$id": "65", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "66", "kind": "constant", @@ -817,7 +817,7 @@ "$id": "74", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "75", "kind": "url", diff --git a/test/CadlRanchProjects/type/property/additional-properties/tspCodeModel.json b/test/CadlRanchProjects/type/property/additional-properties/tspCodeModel.json index 878f1b8ac6f..ada137f848a 100644 --- a/test/CadlRanchProjects/type/property/additional-properties/tspCodeModel.json +++ b/test/CadlRanchProjects/type/property/additional-properties/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "kind1", "value": "kind1", - "description": "kind1", + "doc": "kind1", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData2_kind", + "doc": "The WidgetData2_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "kind1", "value": "kind1", - "description": "kind1", + "doc": "kind1", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData1_kind", + "doc": "The WidgetData1_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "kind0", "value": "kind0", - "description": "kind0", + "doc": "kind0", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData0_kind", + "doc": "The WidgetData0_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -110,7 +110,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion3", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion3", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "12", @@ -268,7 +268,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "29", "kind": "string", @@ -297,7 +297,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion2", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion2", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "31", @@ -319,7 +319,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "33", "kind": "string", @@ -342,7 +342,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "35", @@ -411,7 +411,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "42", "kind": "string", @@ -437,7 +437,7 @@ "name": "SpreadRecordForDiscriminatedUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForDiscriminatedUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "44", @@ -459,7 +459,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "46", "kind": "string", @@ -482,7 +482,7 @@ "name": "SpreadRecordForUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "48", @@ -512,7 +512,7 @@ "kind": "property", "name": "flag", "serializedName": "flag", - "description": "The name property", + "doc": "The name property", "type": { "$id": "52", "kind": "boolean", @@ -535,7 +535,7 @@ "name": "MultipleSpreadRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.MultipleSpreadRecord", "usage": "Input,Output,Json", - "description": "The model spread Record and Record", + "doc": "The model spread Record and Record", "decorators": [], "additionalProperties": { "$id": "54", @@ -565,7 +565,7 @@ "kind": "property", "name": "flag", "serializedName": "flag", - "description": "The name property", + "doc": "The name property", "type": { "$id": "58", "kind": "boolean", @@ -588,7 +588,7 @@ "name": "DifferentSpreadModelArrayDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelArrayDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "60", @@ -596,7 +596,7 @@ "name": "DifferentSpreadModelArrayRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelArrayRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "61", @@ -608,7 +608,7 @@ "name": "ModelForRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ModelForRecord", "usage": "Input,Output,Json", - "description": "model for record", + "doc": "model for record", "decorators": [], "properties": [ { @@ -616,7 +616,7 @@ "kind": "property", "name": "state", "serializedName": "state", - "description": "The state property", + "doc": "The state property", "type": { "$id": "64", "kind": "string", @@ -664,7 +664,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "68", "kind": "array", @@ -696,7 +696,7 @@ "name": "DifferentSpreadModelDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "70", @@ -704,7 +704,7 @@ "name": "DifferentSpreadModelRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$ref": "62" @@ -737,7 +737,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$ref": "62" }, @@ -759,7 +759,7 @@ "name": "DifferentSpreadFloatDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadFloatDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "75", @@ -767,7 +767,7 @@ "name": "DifferentSpreadFloatRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadFloatRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "76", @@ -782,7 +782,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The id property", + "doc": "The id property", "type": { "$id": "78", "kind": "string", @@ -805,7 +805,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "80", "kind": "float32", @@ -831,7 +831,7 @@ "name": "DifferentSpreadStringDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadStringDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "82", @@ -839,7 +839,7 @@ "name": "DifferentSpreadStringRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadStringRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "83", @@ -854,7 +854,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The name property", + "doc": "The name property", "type": { "$id": "85", "kind": "float32", @@ -877,7 +877,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "87", "kind": "string", @@ -945,7 +945,7 @@ "name": "IsModelArrayAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsModelArrayAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "93", @@ -988,7 +988,7 @@ "name": "ExtendsModelArrayAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsModelArrayAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "97", @@ -1031,7 +1031,7 @@ "name": "SpreadModelRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadModelRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1060,7 +1060,7 @@ "name": "IsModelAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsModelAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1089,7 +1089,7 @@ "name": "ExtendsModelAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsModelAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1118,7 +1118,7 @@ "name": "SpreadFloatRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadFloatRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$id": "107", @@ -1133,7 +1133,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "109", "kind": "float32", @@ -1156,7 +1156,7 @@ "name": "IsFloatAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsFloatAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "111", @@ -1171,7 +1171,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "113", "kind": "float32", @@ -1194,7 +1194,7 @@ "name": "ExtendsFloatAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsFloatAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "115", @@ -1209,7 +1209,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "117", "kind": "float32", @@ -1232,7 +1232,7 @@ "name": "SpreadStringRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadStringRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$id": "119", @@ -1247,7 +1247,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "121", "kind": "string", @@ -1270,7 +1270,7 @@ "name": "IsStringAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsStringAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "123", @@ -1285,7 +1285,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "125", "kind": "string", @@ -1308,7 +1308,7 @@ "name": "ExtendsStringAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsStringAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "127", @@ -1323,7 +1323,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "129", "kind": "string", @@ -1346,7 +1346,7 @@ "name": "IsUnknownAdditionalPropertiesDiscriminated", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDiscriminated", "usage": "Input,Output,Json", - "description": "The model is Record with a discriminator.", + "doc": "The model is Record with a discriminator.", "decorators": [], "additionalProperties": { "$id": "131", @@ -1360,7 +1360,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "The discriminator", + "doc": "The discriminator", "type": { "$id": "133", "kind": "string", @@ -1381,7 +1381,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "135", "kind": "string", @@ -1408,7 +1408,7 @@ "name": "IsUnknownAdditionalPropertiesDiscriminatedDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDiscriminatedDerived", "usage": "Input,Output,Json", - "description": "The derived discriminated type", + "doc": "The derived discriminated type", "discriminatorValue": "derived", "decorators": [], "baseModel": { @@ -1445,7 +1445,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "142", "kind": "int32", @@ -1465,7 +1465,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "144", "kind": "float32", @@ -1493,7 +1493,7 @@ "name": "IsUnknownAdditionalPropertiesDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDerived", "usage": "Input,Output,Json", - "description": "The model extends from a type that is Record type", + "doc": "The model extends from a type that is Record type", "decorators": [], "baseModel": { "$id": "146", @@ -1501,7 +1501,7 @@ "name": "IsUnknownAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "147", @@ -1516,7 +1516,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "149", "kind": "string", @@ -1539,7 +1539,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "151", "kind": "int32", @@ -1559,7 +1559,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "153", "kind": "float32", @@ -1585,7 +1585,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDiscriminated", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDiscriminated", "usage": "Input,Output,Json", - "description": "The model extends from Record with a discriminator.", + "doc": "The model extends from Record with a discriminator.", "decorators": [], "additionalProperties": { "$id": "155", @@ -1599,7 +1599,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "The discriminator", + "doc": "The discriminator", "type": { "$id": "157", "kind": "string", @@ -1620,7 +1620,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "159", "kind": "string", @@ -1647,7 +1647,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDiscriminatedDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDiscriminatedDerived", "usage": "Input,Output,Json", - "description": "The derived discriminated type", + "doc": "The derived discriminated type", "discriminatorValue": "derived", "decorators": [], "baseModel": { @@ -1684,7 +1684,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "166", "kind": "int32", @@ -1704,7 +1704,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "168", "kind": "float32", @@ -1732,7 +1732,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDerived", "usage": "Input,Output,Json", - "description": "The model extends from a type that extends from Record.", + "doc": "The model extends from a type that extends from Record.", "decorators": [], "baseModel": { "$id": "170", @@ -1740,7 +1740,7 @@ "name": "ExtendsUnknownAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "171", @@ -1755,7 +1755,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "173", "kind": "string", @@ -1778,7 +1778,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "175", "kind": "int32", @@ -1798,7 +1798,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "177", "kind": "float32", @@ -1823,7 +1823,7 @@ { "$id": "178", "Name": "AdditionalPropertiesClient", - "Description": "Tests for additional properties of models", + "Doc": "Tests for additional properties of models", "Operations": [], "Protocol": { "$id": "179" @@ -1833,7 +1833,7 @@ "$id": "180", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "181", "kind": "url", @@ -1871,7 +1871,7 @@ "$id": "185", "Name": "get", "ResourceName": "ExtendsUnknown", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1933,14 +1933,14 @@ "$id": "190", "Name": "put", "ResourceName": "ExtendsUnknown", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "191", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "192", "kind": "constant", @@ -1968,7 +1968,7 @@ "$id": "194", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "170" }, @@ -2017,7 +2017,7 @@ "$id": "197", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "198", "kind": "url", @@ -2055,7 +2055,7 @@ "$id": "202", "Name": "get", "ResourceName": "ExtendsUnknownDerived", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2117,14 +2117,14 @@ "$id": "207", "Name": "put", "ResourceName": "ExtendsUnknownDerived", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "208", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "209", "kind": "constant", @@ -2152,7 +2152,7 @@ "$id": "211", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "169" }, @@ -2201,7 +2201,7 @@ "$id": "214", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "215", "kind": "url", @@ -2239,7 +2239,7 @@ "$id": "219", "Name": "get", "ResourceName": "ExtendsUnknownDiscriminated", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2301,14 +2301,14 @@ "$id": "224", "Name": "put", "ResourceName": "ExtendsUnknownDiscriminated", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "225", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "226", "kind": "constant", @@ -2336,7 +2336,7 @@ "$id": "228", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "154" }, @@ -2385,7 +2385,7 @@ "$id": "231", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "232", "kind": "url", @@ -2423,7 +2423,7 @@ "$id": "236", "Name": "get", "ResourceName": "IsUnknown", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2485,14 +2485,14 @@ "$id": "241", "Name": "put", "ResourceName": "IsUnknown", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "242", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "243", "kind": "constant", @@ -2520,7 +2520,7 @@ "$id": "245", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "146" }, @@ -2569,7 +2569,7 @@ "$id": "248", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "249", "kind": "url", @@ -2607,7 +2607,7 @@ "$id": "253", "Name": "get", "ResourceName": "IsUnknownDerived", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2669,14 +2669,14 @@ "$id": "258", "Name": "put", "ResourceName": "IsUnknownDerived", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "259", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "260", "kind": "constant", @@ -2704,7 +2704,7 @@ "$id": "262", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "145" }, @@ -2753,7 +2753,7 @@ "$id": "265", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "266", "kind": "url", @@ -2791,7 +2791,7 @@ "$id": "270", "Name": "get", "ResourceName": "IsUnknownDiscriminated", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2853,14 +2853,14 @@ "$id": "275", "Name": "put", "ResourceName": "IsUnknownDiscriminated", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "276", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "277", "kind": "constant", @@ -2888,7 +2888,7 @@ "$id": "279", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "130" }, @@ -2937,7 +2937,7 @@ "$id": "282", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "283", "kind": "url", @@ -2975,7 +2975,7 @@ "$id": "287", "Name": "get", "ResourceName": "ExtendsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3037,14 +3037,14 @@ "$id": "292", "Name": "put", "ResourceName": "ExtendsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "293", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "294", "kind": "constant", @@ -3072,7 +3072,7 @@ "$id": "296", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "126" }, @@ -3121,7 +3121,7 @@ "$id": "299", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "300", "kind": "url", @@ -3159,7 +3159,7 @@ "$id": "304", "Name": "get", "ResourceName": "IsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3221,14 +3221,14 @@ "$id": "309", "Name": "put", "ResourceName": "IsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "310", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "311", "kind": "constant", @@ -3256,7 +3256,7 @@ "$id": "313", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "122" }, @@ -3305,7 +3305,7 @@ "$id": "316", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "317", "kind": "url", @@ -3343,7 +3343,7 @@ "$id": "321", "Name": "get", "ResourceName": "SpreadString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3405,14 +3405,14 @@ "$id": "326", "Name": "put", "ResourceName": "SpreadString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "327", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "328", "kind": "constant", @@ -3440,7 +3440,7 @@ "$id": "330", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "118" }, @@ -3489,7 +3489,7 @@ "$id": "333", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "334", "kind": "url", @@ -3527,7 +3527,7 @@ "$id": "338", "Name": "get", "ResourceName": "ExtendsFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3589,14 +3589,14 @@ "$id": "343", "Name": "put", "ResourceName": "ExtendsFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "344", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "345", "kind": "constant", @@ -3624,7 +3624,7 @@ "$id": "347", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "114" }, @@ -3673,7 +3673,7 @@ "$id": "350", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "351", "kind": "url", @@ -3711,7 +3711,7 @@ "$id": "355", "Name": "get", "ResourceName": "IsFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3773,14 +3773,14 @@ "$id": "360", "Name": "put", "ResourceName": "IsFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "361", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "362", "kind": "constant", @@ -3808,7 +3808,7 @@ "$id": "364", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "110" }, @@ -3857,7 +3857,7 @@ "$id": "367", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "368", "kind": "url", @@ -3895,7 +3895,7 @@ "$id": "372", "Name": "get", "ResourceName": "SpreadFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3957,14 +3957,14 @@ "$id": "377", "Name": "put", "ResourceName": "SpreadFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "378", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "379", "kind": "constant", @@ -3992,7 +3992,7 @@ "$id": "381", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "106" }, @@ -4041,7 +4041,7 @@ "$id": "384", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "385", "kind": "url", @@ -4079,7 +4079,7 @@ "$id": "389", "Name": "get", "ResourceName": "ExtendsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4141,14 +4141,14 @@ "$id": "394", "Name": "put", "ResourceName": "ExtendsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "395", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "396", "kind": "constant", @@ -4176,7 +4176,7 @@ "$id": "398", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "104" }, @@ -4225,7 +4225,7 @@ "$id": "401", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "402", "kind": "url", @@ -4263,7 +4263,7 @@ "$id": "406", "Name": "get", "ResourceName": "IsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4325,14 +4325,14 @@ "$id": "411", "Name": "put", "ResourceName": "IsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "412", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "413", "kind": "constant", @@ -4360,7 +4360,7 @@ "$id": "415", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "102" }, @@ -4409,7 +4409,7 @@ "$id": "418", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "419", "kind": "url", @@ -4447,7 +4447,7 @@ "$id": "423", "Name": "get", "ResourceName": "SpreadModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4509,14 +4509,14 @@ "$id": "428", "Name": "put", "ResourceName": "SpreadModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "429", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "430", "kind": "constant", @@ -4544,7 +4544,7 @@ "$id": "432", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "100" }, @@ -4593,7 +4593,7 @@ "$id": "435", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "436", "kind": "url", @@ -4631,7 +4631,7 @@ "$id": "440", "Name": "get", "ResourceName": "ExtendsModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4693,14 +4693,14 @@ "$id": "445", "Name": "put", "ResourceName": "ExtendsModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "446", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "447", "kind": "constant", @@ -4728,7 +4728,7 @@ "$id": "449", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "96" }, @@ -4777,7 +4777,7 @@ "$id": "452", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "453", "kind": "url", @@ -4815,7 +4815,7 @@ "$id": "457", "Name": "get", "ResourceName": "IsModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4877,14 +4877,14 @@ "$id": "462", "Name": "put", "ResourceName": "IsModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "463", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "464", "kind": "constant", @@ -4912,7 +4912,7 @@ "$id": "466", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "92" }, @@ -4961,7 +4961,7 @@ "$id": "469", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "470", "kind": "url", @@ -4999,7 +4999,7 @@ "$id": "474", "Name": "get", "ResourceName": "SpreadModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5061,14 +5061,14 @@ "$id": "479", "Name": "put", "ResourceName": "SpreadModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "480", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "481", "kind": "constant", @@ -5096,7 +5096,7 @@ "$id": "483", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "88" }, @@ -5145,7 +5145,7 @@ "$id": "486", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "487", "kind": "url", @@ -5183,7 +5183,7 @@ "$id": "491", "Name": "get", "ResourceName": "SpreadDifferentString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5245,14 +5245,14 @@ "$id": "496", "Name": "put", "ResourceName": "SpreadDifferentString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "497", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "498", "kind": "constant", @@ -5280,7 +5280,7 @@ "$id": "500", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "82" }, @@ -5329,7 +5329,7 @@ "$id": "503", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "504", "kind": "url", @@ -5367,7 +5367,7 @@ "$id": "508", "Name": "get", "ResourceName": "SpreadDifferentFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5429,14 +5429,14 @@ "$id": "513", "Name": "put", "ResourceName": "SpreadDifferentFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "514", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "515", "kind": "constant", @@ -5464,7 +5464,7 @@ "$id": "517", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "75" }, @@ -5513,7 +5513,7 @@ "$id": "520", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "521", "kind": "url", @@ -5551,7 +5551,7 @@ "$id": "525", "Name": "get", "ResourceName": "SpreadDifferentModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5613,14 +5613,14 @@ "$id": "530", "Name": "put", "ResourceName": "SpreadDifferentModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "531", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "532", "kind": "constant", @@ -5648,7 +5648,7 @@ "$id": "534", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "70" }, @@ -5697,7 +5697,7 @@ "$id": "537", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "538", "kind": "url", @@ -5735,7 +5735,7 @@ "$id": "542", "Name": "get", "ResourceName": "SpreadDifferentModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5797,14 +5797,14 @@ "$id": "547", "Name": "put", "ResourceName": "SpreadDifferentModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "548", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "549", "kind": "constant", @@ -5832,7 +5832,7 @@ "$id": "551", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "60" }, @@ -5881,7 +5881,7 @@ "$id": "554", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "555", "kind": "url", @@ -5919,7 +5919,7 @@ "$id": "559", "Name": "get", "ResourceName": "ExtendsDifferentSpreadString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5981,14 +5981,14 @@ "$id": "564", "Name": "put", "ResourceName": "ExtendsDifferentSpreadString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "565", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "566", "kind": "constant", @@ -6016,7 +6016,7 @@ "$id": "568", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "81" }, @@ -6065,7 +6065,7 @@ "$id": "571", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "572", "kind": "url", @@ -6103,7 +6103,7 @@ "$id": "576", "Name": "get", "ResourceName": "ExtendsDifferentSpreadFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6165,14 +6165,14 @@ "$id": "581", "Name": "put", "ResourceName": "ExtendsDifferentSpreadFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "582", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "583", "kind": "constant", @@ -6200,7 +6200,7 @@ "$id": "585", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "74" }, @@ -6249,7 +6249,7 @@ "$id": "588", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "589", "kind": "url", @@ -6287,7 +6287,7 @@ "$id": "593", "Name": "get", "ResourceName": "ExtendsDifferentSpreadModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6349,14 +6349,14 @@ "$id": "598", "Name": "put", "ResourceName": "ExtendsDifferentSpreadModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "599", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "600", "kind": "constant", @@ -6384,7 +6384,7 @@ "$id": "602", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "69" }, @@ -6433,7 +6433,7 @@ "$id": "605", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "606", "kind": "url", @@ -6471,7 +6471,7 @@ "$id": "610", "Name": "get", "ResourceName": "ExtendsDifferentSpreadModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6533,14 +6533,14 @@ "$id": "615", "Name": "put", "ResourceName": "ExtendsDifferentSpreadModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "616", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "617", "kind": "constant", @@ -6568,7 +6568,7 @@ "$id": "619", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "59" }, @@ -6617,7 +6617,7 @@ "$id": "622", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "623", "kind": "url", @@ -6655,7 +6655,7 @@ "$id": "627", "Name": "get", "ResourceName": "MultipleSpread", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6717,14 +6717,14 @@ "$id": "632", "Name": "put", "ResourceName": "MultipleSpread", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "633", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "634", "kind": "constant", @@ -6752,7 +6752,7 @@ "$id": "636", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "53" }, @@ -6801,7 +6801,7 @@ "$id": "639", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "640", "kind": "url", @@ -6839,7 +6839,7 @@ "$id": "644", "Name": "get", "ResourceName": "SpreadRecordUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6901,14 +6901,14 @@ "$id": "649", "Name": "put", "ResourceName": "SpreadRecordUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "650", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "651", "kind": "constant", @@ -6936,7 +6936,7 @@ "$id": "653", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "47" }, @@ -6985,7 +6985,7 @@ "$id": "656", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "657", "kind": "url", @@ -7023,7 +7023,7 @@ "$id": "661", "Name": "get", "ResourceName": "SpreadRecordDiscriminatedUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7085,14 +7085,14 @@ "$id": "666", "Name": "put", "ResourceName": "SpreadRecordDiscriminatedUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "667", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "668", "kind": "constant", @@ -7120,7 +7120,7 @@ "$id": "670", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "43" }, @@ -7169,7 +7169,7 @@ "$id": "673", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "674", "kind": "url", @@ -7207,7 +7207,7 @@ "$id": "678", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7269,14 +7269,14 @@ "$id": "683", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "684", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "685", "kind": "constant", @@ -7304,7 +7304,7 @@ "$id": "687", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "34" }, @@ -7353,7 +7353,7 @@ "$id": "690", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "691", "kind": "url", @@ -7391,7 +7391,7 @@ "$id": "695", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion2", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7453,14 +7453,14 @@ "$id": "700", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion2", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "701", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "702", "kind": "constant", @@ -7488,7 +7488,7 @@ "$id": "704", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "30" }, @@ -7537,7 +7537,7 @@ "$id": "707", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "708", "kind": "url", @@ -7575,7 +7575,7 @@ "$id": "712", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion3", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7637,14 +7637,14 @@ "$id": "717", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion3", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "718", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "719", "kind": "constant", @@ -7672,7 +7672,7 @@ "$id": "721", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "11" }, @@ -7721,7 +7721,7 @@ "$id": "724", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "725", "kind": "url", diff --git a/test/CadlRanchProjects/type/property/nullable/tspCodeModel.json b/test/CadlRanchProjects/type/property/nullable/tspCodeModel.json index a5874cb31ec..14e97db8871 100644 --- a/test/CadlRanchProjects/type/property/nullable/tspCodeModel.json +++ b/test/CadlRanchProjects/type/property/nullable/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "CollectionsStringProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsStringProperty", "usage": "Input,Output,JsonMergePatch,Json", - "description": "Model with collection string properties", + "doc": "Model with collection string properties", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "4", "kind": "string", @@ -38,7 +38,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "6", "kind": "nullable", @@ -72,7 +72,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsModelProperty", "usage": "Output,Json", - "description": "Model with collection models properties", + "doc": "Model with collection models properties", "decorators": [], "properties": [ { @@ -80,7 +80,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "11", "kind": "string", @@ -100,7 +100,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "13", "kind": "nullable", @@ -114,7 +114,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Property.Nullable.InnerModel", "usage": "Output,Json", - "description": "Inner model used in collections model property", + "doc": "Inner model used in collections model property", "decorators": [], "properties": [ { @@ -122,7 +122,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Inner model property", + "doc": "Inner model property", "type": { "$id": "17", "kind": "string", @@ -161,7 +161,7 @@ "name": "CollectionsByteProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsByteProperty", "usage": "Output,Json", - "description": "Model with collection bytes properties", + "doc": "Model with collection bytes properties", "decorators": [], "properties": [ { @@ -169,7 +169,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "20", "kind": "string", @@ -189,7 +189,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "22", "kind": "nullable", @@ -224,7 +224,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.DurationProperty", "usage": "Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -232,7 +232,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "27", "kind": "string", @@ -252,7 +252,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "29", "kind": "nullable", @@ -287,7 +287,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.DatetimeProperty", "usage": "Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -295,7 +295,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "34", "kind": "string", @@ -315,7 +315,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "36", "kind": "nullable", @@ -350,7 +350,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.BytesProperty", "usage": "Output,Json", - "description": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -358,7 +358,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "41", "kind": "string", @@ -378,7 +378,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "43", "kind": "nullable", @@ -406,7 +406,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.StringProperty", "usage": "Output,Json", - "description": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -414,7 +414,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "47", "kind": "string", @@ -434,7 +434,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "49", "kind": "nullable", @@ -460,7 +460,7 @@ { "$id": "51", "Name": "NullableClient", - "Description": "Illustrates models with nullable properties.", + "Doc": "Illustrates models with nullable properties.", "Operations": [], "Protocol": { "$id": "52" @@ -470,7 +470,7 @@ "$id": "53", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "54", "kind": "url", @@ -508,7 +508,7 @@ "$id": "58", "Name": "getNonNull", "ResourceName": "String", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -570,7 +570,7 @@ "$id": "63", "Name": "getNull", "ResourceName": "String", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -632,14 +632,14 @@ "$id": "68", "Name": "patchNonNull", "ResourceName": "String", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "69", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "70", "kind": "constant", @@ -709,14 +709,14 @@ "$id": "74", "Name": "patchNull", "ResourceName": "String", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "75", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "76", "kind": "constant", @@ -792,7 +792,7 @@ "$id": "81", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "82", "kind": "url", @@ -830,7 +830,7 @@ "$id": "86", "Name": "getNonNull", "ResourceName": "Bytes", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -892,7 +892,7 @@ "$id": "91", "Name": "getNull", "ResourceName": "Bytes", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -954,14 +954,14 @@ "$id": "96", "Name": "patchNonNull", "ResourceName": "Bytes", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "97", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "98", "kind": "constant", @@ -1031,14 +1031,14 @@ "$id": "102", "Name": "patchNull", "ResourceName": "Bytes", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "103", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "104", "kind": "constant", @@ -1114,7 +1114,7 @@ "$id": "109", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "110", "kind": "url", @@ -1152,7 +1152,7 @@ "$id": "114", "Name": "getNonNull", "ResourceName": "Datetime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1214,7 +1214,7 @@ "$id": "119", "Name": "getNull", "ResourceName": "Datetime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1276,14 +1276,14 @@ "$id": "124", "Name": "patchNonNull", "ResourceName": "Datetime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "125", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "126", "kind": "constant", @@ -1353,14 +1353,14 @@ "$id": "130", "Name": "patchNull", "ResourceName": "Datetime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "131", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "132", "kind": "constant", @@ -1436,7 +1436,7 @@ "$id": "137", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "138", "kind": "url", @@ -1474,7 +1474,7 @@ "$id": "142", "Name": "getNonNull", "ResourceName": "Duration", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1536,7 +1536,7 @@ "$id": "147", "Name": "getNull", "ResourceName": "Duration", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1598,14 +1598,14 @@ "$id": "152", "Name": "patchNonNull", "ResourceName": "Duration", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "153", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "154", "kind": "constant", @@ -1675,14 +1675,14 @@ "$id": "158", "Name": "patchNull", "ResourceName": "Duration", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "159", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "160", "kind": "constant", @@ -1758,7 +1758,7 @@ "$id": "165", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "166", "kind": "url", @@ -1796,7 +1796,7 @@ "$id": "170", "Name": "getNonNull", "ResourceName": "CollectionsByte", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1858,7 +1858,7 @@ "$id": "175", "Name": "getNull", "ResourceName": "CollectionsByte", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1920,14 +1920,14 @@ "$id": "180", "Name": "patchNonNull", "ResourceName": "CollectionsByte", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "181", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "182", "kind": "constant", @@ -1997,14 +1997,14 @@ "$id": "186", "Name": "patchNull", "ResourceName": "CollectionsByte", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "187", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "188", "kind": "constant", @@ -2080,7 +2080,7 @@ "$id": "193", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "194", "kind": "url", @@ -2118,7 +2118,7 @@ "$id": "198", "Name": "getNonNull", "ResourceName": "CollectionsModel", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2180,7 +2180,7 @@ "$id": "203", "Name": "getNull", "ResourceName": "CollectionsModel", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2242,14 +2242,14 @@ "$id": "208", "Name": "patchNonNull", "ResourceName": "CollectionsModel", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "209", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "210", "kind": "constant", @@ -2319,14 +2319,14 @@ "$id": "214", "Name": "patchNull", "ResourceName": "CollectionsModel", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "215", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "216", "kind": "constant", @@ -2402,7 +2402,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2440,7 +2440,7 @@ "$id": "226", "Name": "getNonNull", "ResourceName": "CollectionsString", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2502,7 +2502,7 @@ "$id": "231", "Name": "getNull", "ResourceName": "CollectionsString", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2564,14 +2564,14 @@ "$id": "236", "Name": "patchNonNull", "ResourceName": "CollectionsString", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "237", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "238", "kind": "constant", @@ -2641,14 +2641,14 @@ "$id": "242", "Name": "patchNull", "ResourceName": "CollectionsString", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "243", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "244", "kind": "constant", @@ -2724,7 +2724,7 @@ "$id": "249", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "250", "kind": "url", diff --git a/test/CadlRanchProjects/type/property/optionality/tspCodeModel.json b/test/CadlRanchProjects/type/property/optionality/tspCodeModel.json index b19bdfff08b..7b966d8806a 100644 --- a/test/CadlRanchProjects/type/property/optionality/tspCodeModel.json +++ b/test/CadlRanchProjects/type/property/optionality/tspCodeModel.json @@ -179,7 +179,7 @@ "kind": "enumvalue", "name": "1.25", "value": 1.25, - "description": "1.25", + "doc": "1.25", "valueType": { "$ref": "21" }, @@ -189,7 +189,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FloatLiteralProperty_property", + "doc": "The FloatLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -212,7 +212,7 @@ "kind": "enumvalue", "name": "1", "value": 1, - "description": "1", + "doc": "1", "valueType": { "$ref": "24" }, @@ -222,7 +222,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The IntLiteralProperty_property", + "doc": "The IntLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -245,7 +245,7 @@ "kind": "enumvalue", "name": "hello", "value": "hello", - "description": "hello", + "doc": "hello", "valueType": { "$ref": "27" }, @@ -255,7 +255,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The StringLiteralProperty_property", + "doc": "The StringLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -269,7 +269,7 @@ "name": "RequiredAndOptionalProperty", "crossLanguageDefinitionId": "Type.Property.Optional.RequiredAndOptionalProperty", "usage": "Input,Output,Json", - "description": "Model with required and optional properties", + "doc": "Model with required and optional properties", "decorators": [], "properties": [ { @@ -277,7 +277,7 @@ "kind": "property", "name": "optionalProperty", "serializedName": "optionalProperty", - "description": "optional string property", + "doc": "optional string property", "type": { "$id": "31", "kind": "string", @@ -297,7 +297,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "required int property", + "doc": "required int property", "type": { "$id": "33", "kind": "int32", @@ -320,7 +320,7 @@ "name": "UnionFloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionFloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of float literal property", + "doc": "Model with union of float literal property", "decorators": [], "properties": [ { @@ -328,7 +328,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "2" }, @@ -347,7 +347,7 @@ "name": "UnionIntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionIntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of int literal property", + "doc": "Model with union of int literal property", "decorators": [], "properties": [ { @@ -355,7 +355,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "8" }, @@ -374,7 +374,7 @@ "name": "UnionStringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionStringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of string literal property", + "doc": "Model with union of string literal property", "decorators": [], "properties": [ { @@ -382,7 +382,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "14" }, @@ -401,7 +401,7 @@ "name": "BooleanLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.BooleanLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with boolean literal property", + "doc": "Model with boolean literal property", "decorators": [], "properties": [ { @@ -409,7 +409,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "42", "kind": "constant", @@ -438,7 +438,7 @@ "name": "FloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.FloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with float literal property", + "doc": "Model with float literal property", "decorators": [], "properties": [ { @@ -446,7 +446,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "46", "kind": "constant", @@ -471,7 +471,7 @@ "name": "IntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.IntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with int literal property", + "doc": "Model with int literal property", "decorators": [], "properties": [ { @@ -479,7 +479,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "49", "kind": "constant", @@ -504,7 +504,7 @@ "name": "StringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.StringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with string literal property", + "doc": "Model with string literal property", "decorators": [], "properties": [ { @@ -512,7 +512,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "52", "kind": "constant", @@ -537,7 +537,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.Optional.CollectionsModelProperty", "usage": "Input,Output,Json", - "description": "Model with collection models properties", + "doc": "Model with collection models properties", "decorators": [], "properties": [ { @@ -545,7 +545,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "55", "kind": "array", @@ -556,7 +556,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.Optional.StringProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with optional property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with optional property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -564,7 +564,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "58", "kind": "string", @@ -602,7 +602,7 @@ "name": "CollectionsByteProperty", "crossLanguageDefinitionId": "Type.Property.Optional.CollectionsByteProperty", "usage": "Input,Output,Json", - "description": "Model with collection bytes properties", + "doc": "Model with collection bytes properties", "decorators": [], "properties": [ { @@ -610,7 +610,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "61", "kind": "array", @@ -641,7 +641,7 @@ "name": "PlainTimeProperty", "crossLanguageDefinitionId": "Type.Property.Optional.PlainTimeProperty", "usage": "Input,Output,Json", - "description": "Model with a plainTime property", + "doc": "Model with a plainTime property", "decorators": [], "properties": [ { @@ -649,7 +649,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "65", "kind": "plainTime", @@ -672,7 +672,7 @@ "name": "PlainDateProperty", "crossLanguageDefinitionId": "Type.Property.Optional.PlainDateProperty", "usage": "Input,Output,Json", - "description": "Model with a plainDate property", + "doc": "Model with a plainDate property", "decorators": [], "properties": [ { @@ -680,7 +680,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "68", "kind": "plainDate", @@ -703,7 +703,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.Optional.DurationProperty", "usage": "Input,Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -711,7 +711,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "71", "kind": "duration", @@ -742,7 +742,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.Optional.DatetimeProperty", "usage": "Input,Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -750,7 +750,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "75", "kind": "utcDateTime", @@ -781,7 +781,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.Optional.BytesProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with optional property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with optional property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -789,7 +789,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "79", "kind": "bytes", @@ -812,7 +812,7 @@ { "$id": "80", "Name": "OptionalClient", - "Description": "Illustrates models with optional properties.", + "Doc": "Illustrates models with optional properties.", "Operations": [], "Protocol": { "$id": "81" @@ -822,7 +822,7 @@ "$id": "82", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "83", "kind": "url", @@ -860,7 +860,7 @@ "$id": "87", "Name": "getAll", "ResourceName": "String", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -922,7 +922,7 @@ "$id": "92", "Name": "getDefault", "ResourceName": "String", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -984,14 +984,14 @@ "$id": "97", "Name": "putAll", "ResourceName": "String", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "98", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "99", "kind": "constant", @@ -1061,14 +1061,14 @@ "$id": "103", "Name": "putDefault", "ResourceName": "String", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "104", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "105", "kind": "constant", @@ -1144,7 +1144,7 @@ "$id": "110", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "111", "kind": "url", @@ -1182,7 +1182,7 @@ "$id": "115", "Name": "getAll", "ResourceName": "Bytes", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1244,7 +1244,7 @@ "$id": "120", "Name": "getDefault", "ResourceName": "Bytes", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1306,14 +1306,14 @@ "$id": "125", "Name": "putAll", "ResourceName": "Bytes", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "126", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "127", "kind": "constant", @@ -1383,14 +1383,14 @@ "$id": "131", "Name": "putDefault", "ResourceName": "Bytes", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "132", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "133", "kind": "constant", @@ -1466,7 +1466,7 @@ "$id": "138", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "139", "kind": "url", @@ -1504,7 +1504,7 @@ "$id": "143", "Name": "getAll", "ResourceName": "Datetime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1566,7 +1566,7 @@ "$id": "148", "Name": "getDefault", "ResourceName": "Datetime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1628,14 +1628,14 @@ "$id": "153", "Name": "putAll", "ResourceName": "Datetime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1705,14 +1705,14 @@ "$id": "159", "Name": "putDefault", "ResourceName": "Datetime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "160", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "161", "kind": "constant", @@ -1788,7 +1788,7 @@ "$id": "166", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "167", "kind": "url", @@ -1826,7 +1826,7 @@ "$id": "171", "Name": "getAll", "ResourceName": "Duration", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1888,7 +1888,7 @@ "$id": "176", "Name": "getDefault", "ResourceName": "Duration", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1950,14 +1950,14 @@ "$id": "181", "Name": "putAll", "ResourceName": "Duration", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "182", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "183", "kind": "constant", @@ -2027,14 +2027,14 @@ "$id": "187", "Name": "putDefault", "ResourceName": "Duration", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "188", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "189", "kind": "constant", @@ -2110,7 +2110,7 @@ "$id": "194", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "195", "kind": "url", @@ -2148,7 +2148,7 @@ "$id": "199", "Name": "getAll", "ResourceName": "PlainDate", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2210,7 +2210,7 @@ "$id": "204", "Name": "getDefault", "ResourceName": "PlainDate", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2272,14 +2272,14 @@ "$id": "209", "Name": "putAll", "ResourceName": "PlainDate", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "210", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "211", "kind": "constant", @@ -2349,14 +2349,14 @@ "$id": "215", "Name": "putDefault", "ResourceName": "PlainDate", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "216", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "217", "kind": "constant", @@ -2432,7 +2432,7 @@ "$id": "222", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "223", "kind": "url", @@ -2470,7 +2470,7 @@ "$id": "227", "Name": "getAll", "ResourceName": "PlainTime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2532,7 +2532,7 @@ "$id": "232", "Name": "getDefault", "ResourceName": "PlainTime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2594,14 +2594,14 @@ "$id": "237", "Name": "putAll", "ResourceName": "PlainTime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "238", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "239", "kind": "constant", @@ -2671,14 +2671,14 @@ "$id": "243", "Name": "putDefault", "ResourceName": "PlainTime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "244", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "245", "kind": "constant", @@ -2754,7 +2754,7 @@ "$id": "250", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "251", "kind": "url", @@ -2792,7 +2792,7 @@ "$id": "255", "Name": "getAll", "ResourceName": "CollectionsByte", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2854,7 +2854,7 @@ "$id": "260", "Name": "getDefault", "ResourceName": "CollectionsByte", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2916,14 +2916,14 @@ "$id": "265", "Name": "putAll", "ResourceName": "CollectionsByte", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "266", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "267", "kind": "constant", @@ -2993,14 +2993,14 @@ "$id": "271", "Name": "putDefault", "ResourceName": "CollectionsByte", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "272", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "273", "kind": "constant", @@ -3076,7 +3076,7 @@ "$id": "278", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "279", "kind": "url", @@ -3114,7 +3114,7 @@ "$id": "283", "Name": "getAll", "ResourceName": "CollectionsModel", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3176,7 +3176,7 @@ "$id": "288", "Name": "getDefault", "ResourceName": "CollectionsModel", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3238,14 +3238,14 @@ "$id": "293", "Name": "putAll", "ResourceName": "CollectionsModel", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "294", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "295", "kind": "constant", @@ -3315,14 +3315,14 @@ "$id": "299", "Name": "putDefault", "ResourceName": "CollectionsModel", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "300", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "301", "kind": "constant", @@ -3398,7 +3398,7 @@ "$id": "306", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "307", "kind": "url", @@ -3436,7 +3436,7 @@ "$id": "311", "Name": "getAll", "ResourceName": "StringLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3498,7 +3498,7 @@ "$id": "316", "Name": "getDefault", "ResourceName": "StringLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3560,14 +3560,14 @@ "$id": "321", "Name": "putAll", "ResourceName": "StringLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "322", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "323", "kind": "constant", @@ -3637,14 +3637,14 @@ "$id": "327", "Name": "putDefault", "ResourceName": "StringLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "328", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "329", "kind": "constant", @@ -3720,7 +3720,7 @@ "$id": "334", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "335", "kind": "url", @@ -3758,7 +3758,7 @@ "$id": "339", "Name": "getAll", "ResourceName": "IntLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3820,7 +3820,7 @@ "$id": "344", "Name": "getDefault", "ResourceName": "IntLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3882,14 +3882,14 @@ "$id": "349", "Name": "putAll", "ResourceName": "IntLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "350", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "351", "kind": "constant", @@ -3959,14 +3959,14 @@ "$id": "355", "Name": "putDefault", "ResourceName": "IntLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "356", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "357", "kind": "constant", @@ -4042,7 +4042,7 @@ "$id": "362", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "363", "kind": "url", @@ -4080,7 +4080,7 @@ "$id": "367", "Name": "getAll", "ResourceName": "FloatLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4142,7 +4142,7 @@ "$id": "372", "Name": "getDefault", "ResourceName": "FloatLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4204,14 +4204,14 @@ "$id": "377", "Name": "putAll", "ResourceName": "FloatLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "378", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "379", "kind": "constant", @@ -4281,14 +4281,14 @@ "$id": "383", "Name": "putDefault", "ResourceName": "FloatLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "384", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "385", "kind": "constant", @@ -4364,7 +4364,7 @@ "$id": "390", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "391", "kind": "url", @@ -4402,7 +4402,7 @@ "$id": "395", "Name": "getAll", "ResourceName": "BooleanLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4464,7 +4464,7 @@ "$id": "400", "Name": "getDefault", "ResourceName": "BooleanLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4526,14 +4526,14 @@ "$id": "405", "Name": "putAll", "ResourceName": "BooleanLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "406", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "407", "kind": "constant", @@ -4603,14 +4603,14 @@ "$id": "411", "Name": "putDefault", "ResourceName": "BooleanLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "412", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "413", "kind": "constant", @@ -4686,7 +4686,7 @@ "$id": "418", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "419", "kind": "url", @@ -4724,7 +4724,7 @@ "$id": "423", "Name": "getAll", "ResourceName": "UnionStringLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4786,7 +4786,7 @@ "$id": "428", "Name": "getDefault", "ResourceName": "UnionStringLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4848,14 +4848,14 @@ "$id": "433", "Name": "putAll", "ResourceName": "UnionStringLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "434", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "435", "kind": "constant", @@ -4925,14 +4925,14 @@ "$id": "439", "Name": "putDefault", "ResourceName": "UnionStringLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "440", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "441", "kind": "constant", @@ -5008,7 +5008,7 @@ "$id": "446", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "447", "kind": "url", @@ -5046,7 +5046,7 @@ "$id": "451", "Name": "getAll", "ResourceName": "UnionIntLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5108,7 +5108,7 @@ "$id": "456", "Name": "getDefault", "ResourceName": "UnionIntLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -5170,14 +5170,14 @@ "$id": "461", "Name": "putAll", "ResourceName": "UnionIntLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "462", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "463", "kind": "constant", @@ -5247,14 +5247,14 @@ "$id": "467", "Name": "putDefault", "ResourceName": "UnionIntLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "468", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "469", "kind": "constant", @@ -5330,7 +5330,7 @@ "$id": "474", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "475", "kind": "url", @@ -5368,7 +5368,7 @@ "$id": "479", "Name": "getAll", "ResourceName": "UnionFloatLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5430,7 +5430,7 @@ "$id": "484", "Name": "getDefault", "ResourceName": "UnionFloatLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -5492,14 +5492,14 @@ "$id": "489", "Name": "putAll", "ResourceName": "UnionFloatLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "490", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "491", "kind": "constant", @@ -5569,14 +5569,14 @@ "$id": "495", "Name": "putDefault", "ResourceName": "UnionFloatLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "496", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "497", "kind": "constant", @@ -5652,7 +5652,7 @@ "$id": "502", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "503", "kind": "url", @@ -5685,13 +5685,13 @@ { "$id": "506", "Name": "RequiredAndOptional", - "Description": "Test optional and required properties", + "Doc": "Test optional and required properties", "Operations": [ { "$id": "507", "Name": "getAll", "ResourceName": "RequiredAndOptional", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5753,7 +5753,7 @@ "$id": "512", "Name": "getRequiredOnly", "ResourceName": "RequiredAndOptional", - "Description": "Get models that will return only the required properties", + "Doc": "Get models that will return only the required properties", "Accessibility": "public", "Parameters": [ { @@ -5815,14 +5815,14 @@ "$id": "517", "Name": "putAll", "ResourceName": "RequiredAndOptional", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "518", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "519", "kind": "constant", @@ -5892,14 +5892,14 @@ "$id": "523", "Name": "putRequiredOnly", "ResourceName": "RequiredAndOptional", - "Description": "Put a body with only required properties.", + "Doc": "Put a body with only required properties.", "Accessibility": "public", "Parameters": [ { "$id": "524", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "525", "kind": "constant", @@ -5975,7 +5975,7 @@ "$id": "530", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "531", "kind": "url", diff --git a/test/CadlRanchProjects/type/property/value-types/tspCodeModel.json b/test/CadlRanchProjects/type/property/value-types/tspCodeModel.json index cd41538a220..f8b7d62a328 100644 --- a/test/CadlRanchProjects/type/property/value-types/tspCodeModel.json +++ b/test/CadlRanchProjects/type/property/value-types/tspCodeModel.json @@ -215,7 +215,7 @@ "kind": "enumvalue", "name": "43.125", "value": 43.125, - "description": "43.125", + "doc": "43.125", "valueType": { "$ref": "25" }, @@ -225,7 +225,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FloatLiteralProperty_property", + "doc": "The FloatLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -248,7 +248,7 @@ "kind": "enumvalue", "name": "42", "value": 42, - "description": "42", + "doc": "42", "valueType": { "$ref": "28" }, @@ -258,7 +258,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The IntLiteralProperty_property", + "doc": "The IntLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -281,7 +281,7 @@ "kind": "enumvalue", "name": "hello", "value": "hello", - "description": "hello", + "doc": "hello", "valueType": { "$ref": "31" }, @@ -291,7 +291,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The StringLiteralProperty_property", + "doc": "The StringLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -325,7 +325,7 @@ "enumType": { "$ref": "33" }, - "description": "First value.", + "doc": "First value.", "decorators": [] }, { @@ -343,11 +343,11 @@ "enumType": { "$ref": "33" }, - "description": "Second value.", + "doc": "Second value.", "decorators": [] } ], - "description": "Enum that will be used as a property for model EnumProperty. Extensible.", + "doc": "Enum that will be used as a property for model EnumProperty. Extensible.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -381,7 +381,7 @@ "enumType": { "$ref": "39" }, - "description": "First value.", + "doc": "First value.", "decorators": [] }, { @@ -399,11 +399,11 @@ "enumType": { "$ref": "39" }, - "description": "Second value.", + "doc": "Second value.", "decorators": [] } ], - "description": "Enum that will be used as a property for model EnumProperty. Non-extensible.", + "doc": "Enum that will be used as a property for model EnumProperty. Non-extensible.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -417,7 +417,7 @@ "name": "UnionEnumValueProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionEnumValueProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with specific properties. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with specific properties. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -425,7 +425,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "47", "kind": "constant", @@ -450,7 +450,7 @@ "name": "UnionFloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionFloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of float literal as property.", + "doc": "Model with a union of float literal as property.", "decorators": [], "properties": [ { @@ -458,7 +458,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "6" }, @@ -477,7 +477,7 @@ "name": "UnionIntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionIntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of int literal as property.", + "doc": "Model with a union of int literal as property.", "decorators": [], "properties": [ { @@ -485,7 +485,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "12" }, @@ -504,7 +504,7 @@ "name": "UnionStringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionStringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of string literal as property.", + "doc": "Model with a union of string literal as property.", "decorators": [], "properties": [ { @@ -512,7 +512,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "18" }, @@ -531,7 +531,7 @@ "name": "BooleanLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BooleanLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a boolean literal property.", + "doc": "Model with a boolean literal property.", "decorators": [], "properties": [ { @@ -539,7 +539,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "56", "kind": "constant", @@ -568,7 +568,7 @@ "name": "FloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.FloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a float literal property.", + "doc": "Model with a float literal property.", "decorators": [], "properties": [ { @@ -576,7 +576,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "60", "kind": "constant", @@ -601,7 +601,7 @@ "name": "IntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.IntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a int literal property.", + "doc": "Model with a int literal property.", "decorators": [], "properties": [ { @@ -609,7 +609,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "63", "kind": "constant", @@ -634,7 +634,7 @@ "name": "StringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.StringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a string literal property.", + "doc": "Model with a string literal property.", "decorators": [], "properties": [ { @@ -642,7 +642,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "66", "kind": "constant", @@ -667,7 +667,7 @@ "name": "UnknownArrayProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownArrayProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is an array.", + "doc": "Model with a property unknown, and the data is an array.", "decorators": [], "properties": [ { @@ -675,7 +675,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "69", "kind": "unknown", @@ -698,7 +698,7 @@ "name": "UnknownDictProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownDictProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a dictionnary.", + "doc": "Model with a property unknown, and the data is a dictionnary.", "decorators": [], "properties": [ { @@ -706,7 +706,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "72", "kind": "unknown", @@ -729,7 +729,7 @@ "name": "UnknownIntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownIntProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a int32.", + "doc": "Model with a property unknown, and the data is a int32.", "decorators": [], "properties": [ { @@ -737,7 +737,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "75", "kind": "unknown", @@ -760,7 +760,7 @@ "name": "UnknownStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownStringProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a string.", + "doc": "Model with a property unknown, and the data is a string.", "decorators": [], "properties": [ { @@ -768,7 +768,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "78", "kind": "unknown", @@ -791,7 +791,7 @@ "name": "NeverProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.NeverProperty", "usage": "Input,Output,Json", - "description": "Model with a property never. (This property should not be included).", + "doc": "Model with a property never. (This property should not be included).", "decorators": [], "properties": [] }, @@ -801,7 +801,7 @@ "name": "DictionaryStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DictionaryStringProperty", "usage": "Input,Output,Json", - "description": "Model with dictionary string properties", + "doc": "Model with dictionary string properties", "decorators": [], "properties": [ { @@ -809,7 +809,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "82", "kind": "dict", @@ -844,7 +844,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsModelProperty", "usage": "Input,Output,Json", - "description": "Model with collection model properties", + "doc": "Model with collection model properties", "decorators": [], "properties": [ { @@ -852,7 +852,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "87", "kind": "array", @@ -863,7 +863,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Property.ValueTypes.InnerModel", "usage": "Input,Output,Json", - "description": "Inner model. Will be a property type for ModelWithModelProperties", + "doc": "Inner model. Will be a property type for ModelWithModelProperties", "decorators": [], "properties": [ { @@ -871,7 +871,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "90", "kind": "string", @@ -909,7 +909,7 @@ "name": "CollectionsIntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsIntProperty", "usage": "Input,Output,Json", - "description": "Model with collection int properties", + "doc": "Model with collection int properties", "decorators": [], "properties": [ { @@ -917,7 +917,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "93", "kind": "array", @@ -947,7 +947,7 @@ "name": "CollectionsStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsStringProperty", "usage": "Input,Output,Json", - "description": "Model with collection string properties", + "doc": "Model with collection string properties", "decorators": [], "properties": [ { @@ -955,7 +955,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "97", "kind": "array", @@ -985,7 +985,7 @@ "name": "ModelProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.ModelProperty", "usage": "Input,Output,Json", - "description": "Model with model properties", + "doc": "Model with model properties", "decorators": [], "properties": [ { @@ -993,7 +993,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "88" }, @@ -1012,7 +1012,7 @@ "name": "ExtensibleEnumProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.ExtensibleEnumProperty", "usage": "Input,Output,Json", - "description": "Model with extensible enum properties", + "doc": "Model with extensible enum properties", "decorators": [], "properties": [ { @@ -1020,7 +1020,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "33" }, @@ -1039,7 +1039,7 @@ "name": "EnumProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.EnumProperty", "usage": "Input,Output,Json", - "description": "Model with enum properties", + "doc": "Model with enum properties", "decorators": [], "properties": [ { @@ -1047,7 +1047,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "39" }, @@ -1066,7 +1066,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DurationProperty", "usage": "Input,Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -1074,7 +1074,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "107", "kind": "duration", @@ -1105,7 +1105,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DatetimeProperty", "usage": "Input,Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -1113,7 +1113,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "111", "kind": "utcDateTime", @@ -1144,7 +1144,7 @@ "name": "Decimal128Property", "crossLanguageDefinitionId": "Type.Property.ValueTypes.Decimal128Property", "usage": "Input,Output,Json", - "description": "Model with a decimal128 property", + "doc": "Model with a decimal128 property", "decorators": [], "properties": [ { @@ -1152,7 +1152,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "115", "kind": "decimal128", @@ -1175,7 +1175,7 @@ "name": "DecimalProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DecimalProperty", "usage": "Input,Output,Json", - "description": "Model with a decimal property", + "doc": "Model with a decimal property", "decorators": [], "properties": [ { @@ -1183,7 +1183,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "118", "kind": "decimal", @@ -1206,7 +1206,7 @@ "name": "FloatProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.FloatProperty", "usage": "Input,Output,Json", - "description": "Model with a float property", + "doc": "Model with a float property", "decorators": [], "properties": [ { @@ -1214,7 +1214,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "121", "kind": "float32", @@ -1237,7 +1237,7 @@ "name": "IntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.IntProperty", "usage": "Input,Output,Json", - "description": "Model with a int property", + "doc": "Model with a int property", "decorators": [], "properties": [ { @@ -1245,7 +1245,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "124", "kind": "int32", @@ -1268,7 +1268,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BytesProperty", "usage": "Input,Output,Json", - "description": "Model with a bytes property", + "doc": "Model with a bytes property", "decorators": [], "properties": [ { @@ -1276,7 +1276,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "127", "kind": "bytes", @@ -1300,7 +1300,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.StringProperty", "usage": "Input,Output,Json", - "description": "Model with a string property", + "doc": "Model with a string property", "decorators": [], "properties": [ { @@ -1308,7 +1308,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "130", "kind": "string", @@ -1331,7 +1331,7 @@ "name": "BooleanProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BooleanProperty", "usage": "Input,Output,Json", - "description": "Model with a boolean property", + "doc": "Model with a boolean property", "decorators": [], "properties": [ { @@ -1339,7 +1339,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "133", "kind": "boolean", @@ -1361,7 +1361,7 @@ { "$id": "134", "Name": "ValueTypesClient", - "Description": "Illustrates various property types for models", + "Doc": "Illustrates various property types for models", "Operations": [], "Protocol": { "$id": "135" @@ -1371,7 +1371,7 @@ "$id": "136", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "137", "kind": "url", @@ -1409,7 +1409,7 @@ "$id": "141", "Name": "get", "ResourceName": "Boolean", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1471,14 +1471,14 @@ "$id": "146", "Name": "put", "ResourceName": "Boolean", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "147", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "148", "kind": "constant", @@ -1506,7 +1506,7 @@ "$id": "150", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "131" }, @@ -1555,7 +1555,7 @@ "$id": "153", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "154", "kind": "url", @@ -1593,7 +1593,7 @@ "$id": "158", "Name": "get", "ResourceName": "String", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1655,14 +1655,14 @@ "$id": "163", "Name": "put", "ResourceName": "String", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "164", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "165", "kind": "constant", @@ -1690,7 +1690,7 @@ "$id": "167", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "128" }, @@ -1739,7 +1739,7 @@ "$id": "170", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "171", "kind": "url", @@ -1777,7 +1777,7 @@ "$id": "175", "Name": "get", "ResourceName": "Bytes", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1839,14 +1839,14 @@ "$id": "180", "Name": "put", "ResourceName": "Bytes", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "181", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "182", "kind": "constant", @@ -1874,7 +1874,7 @@ "$id": "184", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "125" }, @@ -1923,7 +1923,7 @@ "$id": "187", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "188", "kind": "url", @@ -1961,7 +1961,7 @@ "$id": "192", "Name": "get", "ResourceName": "Int", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2023,14 +2023,14 @@ "$id": "197", "Name": "put", "ResourceName": "Int", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "198", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "199", "kind": "constant", @@ -2058,7 +2058,7 @@ "$id": "201", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "122" }, @@ -2107,7 +2107,7 @@ "$id": "204", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "205", "kind": "url", @@ -2145,7 +2145,7 @@ "$id": "209", "Name": "get", "ResourceName": "Float", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2207,14 +2207,14 @@ "$id": "214", "Name": "put", "ResourceName": "Float", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "215", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "216", "kind": "constant", @@ -2242,7 +2242,7 @@ "$id": "218", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "119" }, @@ -2291,7 +2291,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2329,7 +2329,7 @@ "$id": "226", "Name": "get", "ResourceName": "Decimal", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2391,14 +2391,14 @@ "$id": "231", "Name": "put", "ResourceName": "Decimal", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2426,7 +2426,7 @@ "$id": "235", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "116" }, @@ -2475,7 +2475,7 @@ "$id": "238", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "239", "kind": "url", @@ -2513,7 +2513,7 @@ "$id": "243", "Name": "get", "ResourceName": "Decimal128", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2575,14 +2575,14 @@ "$id": "248", "Name": "put", "ResourceName": "Decimal128", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "249", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "250", "kind": "constant", @@ -2610,7 +2610,7 @@ "$id": "252", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "113" }, @@ -2659,7 +2659,7 @@ "$id": "255", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "256", "kind": "url", @@ -2697,7 +2697,7 @@ "$id": "260", "Name": "get", "ResourceName": "Datetime", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2759,14 +2759,14 @@ "$id": "265", "Name": "put", "ResourceName": "Datetime", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "266", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "267", "kind": "constant", @@ -2794,7 +2794,7 @@ "$id": "269", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "109" }, @@ -2843,7 +2843,7 @@ "$id": "272", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "273", "kind": "url", @@ -2881,7 +2881,7 @@ "$id": "277", "Name": "get", "ResourceName": "Duration", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2943,14 +2943,14 @@ "$id": "282", "Name": "put", "ResourceName": "Duration", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "283", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "284", "kind": "constant", @@ -2978,7 +2978,7 @@ "$id": "286", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "105" }, @@ -3027,7 +3027,7 @@ "$id": "289", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "290", "kind": "url", @@ -3065,7 +3065,7 @@ "$id": "294", "Name": "get", "ResourceName": "Enum", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3127,14 +3127,14 @@ "$id": "299", "Name": "put", "ResourceName": "Enum", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "300", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "301", "kind": "constant", @@ -3162,7 +3162,7 @@ "$id": "303", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "103" }, @@ -3211,7 +3211,7 @@ "$id": "306", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "307", "kind": "url", @@ -3249,7 +3249,7 @@ "$id": "311", "Name": "get", "ResourceName": "ExtensibleEnum", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3311,14 +3311,14 @@ "$id": "316", "Name": "put", "ResourceName": "ExtensibleEnum", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "317", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "318", "kind": "constant", @@ -3346,7 +3346,7 @@ "$id": "320", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "101" }, @@ -3395,7 +3395,7 @@ "$id": "323", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "324", "kind": "url", @@ -3433,7 +3433,7 @@ "$id": "328", "Name": "get", "ResourceName": "Model", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3495,14 +3495,14 @@ "$id": "333", "Name": "put", "ResourceName": "Model", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "334", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "335", "kind": "constant", @@ -3530,7 +3530,7 @@ "$id": "337", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "99" }, @@ -3579,7 +3579,7 @@ "$id": "340", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "341", "kind": "url", @@ -3617,7 +3617,7 @@ "$id": "345", "Name": "get", "ResourceName": "CollectionsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3679,14 +3679,14 @@ "$id": "350", "Name": "put", "ResourceName": "CollectionsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "351", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "352", "kind": "constant", @@ -3714,7 +3714,7 @@ "$id": "354", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "95" }, @@ -3763,7 +3763,7 @@ "$id": "357", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "358", "kind": "url", @@ -3801,7 +3801,7 @@ "$id": "362", "Name": "get", "ResourceName": "CollectionsInt", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3863,14 +3863,14 @@ "$id": "367", "Name": "put", "ResourceName": "CollectionsInt", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "368", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "369", "kind": "constant", @@ -3898,7 +3898,7 @@ "$id": "371", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "91" }, @@ -3947,7 +3947,7 @@ "$id": "374", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "375", "kind": "url", @@ -3985,7 +3985,7 @@ "$id": "379", "Name": "get", "ResourceName": "CollectionsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4047,14 +4047,14 @@ "$id": "384", "Name": "put", "ResourceName": "CollectionsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "385", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "386", "kind": "constant", @@ -4082,7 +4082,7 @@ "$id": "388", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "85" }, @@ -4131,7 +4131,7 @@ "$id": "391", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "392", "kind": "url", @@ -4169,7 +4169,7 @@ "$id": "396", "Name": "get", "ResourceName": "DictionaryString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4231,14 +4231,14 @@ "$id": "401", "Name": "put", "ResourceName": "DictionaryString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "402", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "403", "kind": "constant", @@ -4266,7 +4266,7 @@ "$id": "405", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "80" }, @@ -4315,7 +4315,7 @@ "$id": "408", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "409", "kind": "url", @@ -4353,7 +4353,7 @@ "$id": "413", "Name": "get", "ResourceName": "Never", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4415,14 +4415,14 @@ "$id": "418", "Name": "put", "ResourceName": "Never", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "419", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "420", "kind": "constant", @@ -4450,7 +4450,7 @@ "$id": "422", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "79" }, @@ -4499,7 +4499,7 @@ "$id": "425", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "426", "kind": "url", @@ -4537,7 +4537,7 @@ "$id": "430", "Name": "get", "ResourceName": "UnknownString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4599,14 +4599,14 @@ "$id": "435", "Name": "put", "ResourceName": "UnknownString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "436", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "437", "kind": "constant", @@ -4634,7 +4634,7 @@ "$id": "439", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "76" }, @@ -4683,7 +4683,7 @@ "$id": "442", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "443", "kind": "url", @@ -4721,7 +4721,7 @@ "$id": "447", "Name": "get", "ResourceName": "UnknownInt", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4783,14 +4783,14 @@ "$id": "452", "Name": "put", "ResourceName": "UnknownInt", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "453", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "454", "kind": "constant", @@ -4818,7 +4818,7 @@ "$id": "456", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "73" }, @@ -4867,7 +4867,7 @@ "$id": "459", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "460", "kind": "url", @@ -4905,7 +4905,7 @@ "$id": "464", "Name": "get", "ResourceName": "UnknownDict", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4967,14 +4967,14 @@ "$id": "469", "Name": "put", "ResourceName": "UnknownDict", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "470", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "471", "kind": "constant", @@ -5002,7 +5002,7 @@ "$id": "473", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "70" }, @@ -5051,7 +5051,7 @@ "$id": "476", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "477", "kind": "url", @@ -5089,7 +5089,7 @@ "$id": "481", "Name": "get", "ResourceName": "UnknownArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5151,14 +5151,14 @@ "$id": "486", "Name": "put", "ResourceName": "UnknownArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "487", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "488", "kind": "constant", @@ -5186,7 +5186,7 @@ "$id": "490", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "67" }, @@ -5235,7 +5235,7 @@ "$id": "493", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "494", "kind": "url", @@ -5273,7 +5273,7 @@ "$id": "498", "Name": "get", "ResourceName": "StringLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5335,14 +5335,14 @@ "$id": "503", "Name": "put", "ResourceName": "StringLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "504", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "505", "kind": "constant", @@ -5370,7 +5370,7 @@ "$id": "507", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "64" }, @@ -5419,7 +5419,7 @@ "$id": "510", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "511", "kind": "url", @@ -5457,7 +5457,7 @@ "$id": "515", "Name": "get", "ResourceName": "IntLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5519,14 +5519,14 @@ "$id": "520", "Name": "put", "ResourceName": "IntLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "521", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "522", "kind": "constant", @@ -5554,7 +5554,7 @@ "$id": "524", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "61" }, @@ -5603,7 +5603,7 @@ "$id": "527", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "528", "kind": "url", @@ -5641,7 +5641,7 @@ "$id": "532", "Name": "get", "ResourceName": "FloatLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5703,14 +5703,14 @@ "$id": "537", "Name": "put", "ResourceName": "FloatLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "538", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "539", "kind": "constant", @@ -5738,7 +5738,7 @@ "$id": "541", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "58" }, @@ -5787,7 +5787,7 @@ "$id": "544", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "545", "kind": "url", @@ -5825,7 +5825,7 @@ "$id": "549", "Name": "get", "ResourceName": "BooleanLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5887,14 +5887,14 @@ "$id": "554", "Name": "put", "ResourceName": "BooleanLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "555", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "556", "kind": "constant", @@ -5922,7 +5922,7 @@ "$id": "558", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "54" }, @@ -5971,7 +5971,7 @@ "$id": "561", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "562", "kind": "url", @@ -6009,7 +6009,7 @@ "$id": "566", "Name": "get", "ResourceName": "UnionStringLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6071,14 +6071,14 @@ "$id": "571", "Name": "put", "ResourceName": "UnionStringLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "572", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "573", "kind": "constant", @@ -6106,7 +6106,7 @@ "$id": "575", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "52" }, @@ -6155,7 +6155,7 @@ "$id": "578", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "579", "kind": "url", @@ -6193,7 +6193,7 @@ "$id": "583", "Name": "get", "ResourceName": "UnionIntLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6255,14 +6255,14 @@ "$id": "588", "Name": "put", "ResourceName": "UnionIntLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "589", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "590", "kind": "constant", @@ -6290,7 +6290,7 @@ "$id": "592", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "50" }, @@ -6339,7 +6339,7 @@ "$id": "595", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "596", "kind": "url", @@ -6377,7 +6377,7 @@ "$id": "600", "Name": "get", "ResourceName": "UnionFloatLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6439,14 +6439,14 @@ "$id": "605", "Name": "put", "ResourceName": "UnionFloatLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "606", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "607", "kind": "constant", @@ -6474,7 +6474,7 @@ "$id": "609", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "48" }, @@ -6523,7 +6523,7 @@ "$id": "612", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "613", "kind": "url", @@ -6561,7 +6561,7 @@ "$id": "617", "Name": "get", "ResourceName": "UnionEnumValue", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6623,14 +6623,14 @@ "$id": "622", "Name": "put", "ResourceName": "UnionEnumValue", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "623", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "624", "kind": "constant", @@ -6658,7 +6658,7 @@ "$id": "626", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "45" }, @@ -6707,7 +6707,7 @@ "$id": "629", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "630", "kind": "url", diff --git a/test/CadlRanchProjects/type/scalar/tspCodeModel.json b/test/CadlRanchProjects/type/scalar/tspCodeModel.json index 84a443b23d6..9672651fbc6 100644 --- a/test/CadlRanchProjects/type/scalar/tspCodeModel.json +++ b/test/CadlRanchProjects/type/scalar/tspCodeModel.json @@ -17,7 +17,7 @@ "$id": "4", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "5", "kind": "url", @@ -55,7 +55,7 @@ "$id": "9", "Name": "get", "ResourceName": "String", - "Description": "get string value", + "Doc": "get string value", "Accessibility": "public", "Parameters": [ { @@ -121,14 +121,14 @@ "$id": "15", "Name": "put", "ResourceName": "String", - "Description": "put string value", + "Doc": "put string value", "Accessibility": "public", "Parameters": [ { "$id": "16", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "17", "kind": "constant", @@ -156,7 +156,7 @@ "$id": "19", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "20", "kind": "string", @@ -209,7 +209,7 @@ "$id": "23", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "24", "kind": "url", @@ -247,7 +247,7 @@ "$id": "28", "Name": "get", "ResourceName": "Boolean", - "Description": "get boolean value", + "Doc": "get boolean value", "Accessibility": "public", "Parameters": [ { @@ -313,14 +313,14 @@ "$id": "34", "Name": "put", "ResourceName": "Boolean", - "Description": "put boolean value", + "Doc": "put boolean value", "Accessibility": "public", "Parameters": [ { "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -348,7 +348,7 @@ "$id": "38", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "39", "kind": "boolean", @@ -401,7 +401,7 @@ "$id": "42", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "43", "kind": "url", @@ -439,7 +439,7 @@ "$id": "47", "Name": "get", "ResourceName": "Unknown", - "Description": "get unknown value", + "Doc": "get unknown value", "Accessibility": "public", "Parameters": [ { @@ -505,14 +505,14 @@ "$id": "53", "Name": "put", "ResourceName": "Unknown", - "Description": "put unknown value", + "Doc": "put unknown value", "Accessibility": "public", "Parameters": [ { "$id": "54", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "55", "kind": "constant", @@ -540,7 +540,7 @@ "$id": "57", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "58", "kind": "unknown", @@ -593,7 +593,7 @@ "$id": "61", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "62", "kind": "url", @@ -626,7 +626,7 @@ { "$id": "65", "Name": "DecimalType", - "Description": "Decimal type", + "Doc": "Decimal type", "Operations": [ { "$id": "66", @@ -703,7 +703,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -832,7 +832,7 @@ "$id": "84", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "85", "kind": "url", @@ -865,7 +865,7 @@ { "$id": "88", "Name": "Decimal128Type", - "Description": "Decimal128 type", + "Doc": "Decimal128 type", "Operations": [ { "$id": "89", @@ -942,7 +942,7 @@ "$id": "96", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "97", "kind": "constant", @@ -1071,7 +1071,7 @@ "$id": "107", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "108", "kind": "url", @@ -1104,7 +1104,7 @@ { "$id": "111", "Name": "DecimalVerify", - "Description": "Decimal type verification", + "Doc": "Decimal type verification", "Operations": [ { "$id": "112", @@ -1188,7 +1188,7 @@ "$id": "120", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "121", "kind": "constant", @@ -1268,7 +1268,7 @@ "$id": "127", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "128", "kind": "url", @@ -1301,7 +1301,7 @@ { "$id": "131", "Name": "Decimal128Verify", - "Description": "Decimal128 type verification", + "Doc": "Decimal128 type verification", "Operations": [ { "$id": "132", @@ -1385,7 +1385,7 @@ "$id": "140", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "141", "kind": "constant", @@ -1465,7 +1465,7 @@ "$id": "147", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "148", "kind": "url", diff --git a/test/CadlRanchProjects/type/union/tspCodeModel.json b/test/CadlRanchProjects/type/union/tspCodeModel.json index d2537a386a6..00194b00247 100644 --- a/test/CadlRanchProjects/type/union/tspCodeModel.json +++ b/test/CadlRanchProjects/type/union/tspCodeModel.json @@ -487,7 +487,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "This should be receive/send the Cat variant", + "doc": "This should be receive/send the Cat variant", "type": { "$id": "58", "kind": "union", @@ -564,7 +564,7 @@ "kind": "property", "name": "literal", "serializedName": "literal", - "description": "This should be receive/send the \"a\" variant", + "doc": "This should be receive/send the \"a\" variant", "type": { "$ref": "58" }, @@ -580,7 +580,7 @@ "kind": "property", "name": "int", "serializedName": "int", - "description": "This should be receive/send the int variant", + "doc": "This should be receive/send the int variant", "type": { "$ref": "58" }, @@ -596,7 +596,7 @@ "kind": "property", "name": "boolean", "serializedName": "boolean", - "description": "This should be receive/send the boolean variant", + "doc": "This should be receive/send the boolean variant", "type": { "$ref": "58" }, @@ -612,7 +612,7 @@ "kind": "property", "name": "array", "serializedName": "array", - "description": "This should be receive/send 4 element with Cat, \"a\", int, and boolean", + "doc": "This should be receive/send 4 element with Cat, \"a\", int, and boolean", "type": { "$id": "70", "kind": "array", @@ -698,7 +698,7 @@ "kind": "property", "name": "stringLiteral", "serializedName": "stringLiteral", - "description": "This should be receive/send the \"a\" variant", + "doc": "This should be receive/send the \"a\" variant", "type": { "$id": "77", "kind": "union", @@ -771,7 +771,7 @@ "kind": "property", "name": "intLiteral", "serializedName": "intLiteral", - "description": "This should be receive/send the 2 variant", + "doc": "This should be receive/send the 2 variant", "type": { "$ref": "77" }, @@ -787,7 +787,7 @@ "kind": "property", "name": "floatLiteral", "serializedName": "floatLiteral", - "description": "This should be receive/send the 3.3 variant", + "doc": "This should be receive/send the 3.3 variant", "type": { "$ref": "77" }, @@ -803,7 +803,7 @@ "kind": "property", "name": "booleanLiteral", "serializedName": "booleanLiteral", - "description": "This should be receive/send the true variant", + "doc": "This should be receive/send the true variant", "type": { "$ref": "77" }, @@ -879,7 +879,7 @@ "kind": "property", "name": "string", "serializedName": "string", - "description": "This should be receive/send the string variant", + "doc": "This should be receive/send the string variant", "type": { "$id": "95", "kind": "union", @@ -921,7 +921,7 @@ "kind": "property", "name": "array", "serializedName": "array", - "description": "This should be receive/send the array variant", + "doc": "This should be receive/send the array variant", "type": { "$id": "100", "kind": "union", @@ -1023,7 +1023,7 @@ "kind": "property", "name": "lr", "serializedName": "lr", - "description": "This should be receive/send the left variant", + "doc": "This should be receive/send the left variant", "type": { "$ref": "2" }, @@ -1039,7 +1039,7 @@ "kind": "property", "name": "ud", "serializedName": "ud", - "description": "This should be receive/send the up variant", + "doc": "This should be receive/send the up variant", "type": { "$ref": "12" }, @@ -1434,7 +1434,7 @@ { "$id": "141", "Name": "UnionClient", - "Description": "Describe scenarios for various combinations of unions.", + "Doc": "Describe scenarios for various combinations of unions.", "Operations": [], "Protocol": { "$id": "142" @@ -1444,7 +1444,7 @@ "$id": "143", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "144", "kind": "url", @@ -1477,7 +1477,7 @@ { "$id": "147", "Name": "StringsOnly", - "Description": "Describe union of string \"a\" | \"b\" | \"c\"", + "Doc": "Describe union of string \"a\" | \"b\" | \"c\"", "Operations": [ { "$id": "148", @@ -1550,7 +1550,7 @@ "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1626,7 +1626,7 @@ "$id": "160", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "161", "kind": "url", @@ -1659,7 +1659,7 @@ { "$id": "164", "Name": "StringExtensible", - "Description": "Describe union of string string | \"b\" | \"c\"", + "Doc": "Describe union of string string | \"b\" | \"c\"", "Operations": [ { "$id": "165", @@ -1732,7 +1732,7 @@ "$id": "171", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "172", "kind": "constant", @@ -1808,7 +1808,7 @@ "$id": "177", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "178", "kind": "url", @@ -1841,7 +1841,7 @@ { "$id": "181", "Name": "StringExtensibleNamed", - "Description": "Describe union of string string | \"b\" | \"c\" but where the union is named and some of the variants are named", + "Doc": "Describe union of string string | \"b\" | \"c\" but where the union is named and some of the variants are named", "Operations": [ { "$id": "182", @@ -1914,7 +1914,7 @@ "$id": "188", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "189", "kind": "constant", @@ -1990,7 +1990,7 @@ "$id": "194", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "195", "kind": "url", @@ -2023,7 +2023,7 @@ { "$id": "198", "Name": "IntsOnly", - "Description": "Describe union of integer 1 | 2 | 3", + "Doc": "Describe union of integer 1 | 2 | 3", "Operations": [ { "$id": "199", @@ -2096,7 +2096,7 @@ "$id": "205", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "206", "kind": "constant", @@ -2172,7 +2172,7 @@ "$id": "211", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "212", "kind": "url", @@ -2205,7 +2205,7 @@ { "$id": "215", "Name": "FloatsOnly", - "Description": "Describe union of floats 1.1 | 2.2 | 3.3", + "Doc": "Describe union of floats 1.1 | 2.2 | 3.3", "Operations": [ { "$id": "216", @@ -2278,7 +2278,7 @@ "$id": "222", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "223", "kind": "constant", @@ -2354,7 +2354,7 @@ "$id": "228", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "229", "kind": "url", @@ -2387,7 +2387,7 @@ { "$id": "232", "Name": "ModelsOnly", - "Description": "Describe union of models", + "Doc": "Describe union of models", "Operations": [ { "$id": "233", @@ -2460,7 +2460,7 @@ "$id": "239", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "240", "kind": "constant", @@ -2536,7 +2536,7 @@ "$id": "245", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "246", "kind": "url", @@ -2569,7 +2569,7 @@ { "$id": "249", "Name": "EnumsOnly", - "Description": "Describe union of 2 different enums", + "Doc": "Describe union of 2 different enums", "Operations": [ { "$id": "250", @@ -2642,7 +2642,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2718,7 +2718,7 @@ "$id": "262", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "263", "kind": "url", @@ -2751,7 +2751,7 @@ { "$id": "266", "Name": "StringAndArray", - "Description": "Describe union of a string and an array of strings", + "Doc": "Describe union of a string and an array of strings", "Operations": [ { "$id": "267", @@ -2824,7 +2824,7 @@ "$id": "273", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "274", "kind": "constant", @@ -2900,7 +2900,7 @@ "$id": "279", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "280", "kind": "url", @@ -2933,7 +2933,7 @@ { "$id": "283", "Name": "MixedLiterals", - "Description": "Describe union of floats \"a\" | 2 | 3.3", + "Doc": "Describe union of floats \"a\" | 2 | 3.3", "Operations": [ { "$id": "284", @@ -3006,7 +3006,7 @@ "$id": "290", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "291", "kind": "constant", @@ -3082,7 +3082,7 @@ "$id": "296", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "297", "kind": "url", @@ -3115,7 +3115,7 @@ { "$id": "300", "Name": "MixedTypes", - "Description": "Describe union of floats \"a\" | 2 | 3.3", + "Doc": "Describe union of floats \"a\" | 2 | 3.3", "Operations": [ { "$id": "301", @@ -3188,7 +3188,7 @@ "$id": "307", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "308", "kind": "constant", @@ -3264,7 +3264,7 @@ "$id": "313", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "314", "kind": "url", diff --git a/test/CadlRanchProjects/versioning/added/tspCodeModel.json b/test/CadlRanchProjects/versioning/added/tspCodeModel.json index b97fdf50a09..ba760d0ccff 100644 --- a/test/CadlRanchProjects/versioning/added/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/added/tspCodeModel.json @@ -123,7 +123,7 @@ "enumType": { "$ref": "12" }, - "description": "The version v1.", + "doc": "The version v1.", "decorators": [] }, { @@ -141,11 +141,11 @@ "enumType": { "$ref": "12" }, - "description": "The version v2.", + "doc": "The version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -321,7 +321,7 @@ { "$id": "35", "Name": "AddedClient", - "Description": "Test for the `@added` decorator.", + "Doc": "Test for the `@added` decorator.", "Operations": [ { "$id": "36", @@ -354,7 +354,7 @@ "$id": "39", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "40", "kind": "constant", @@ -463,7 +463,7 @@ "$id": "48", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "49", "kind": "constant", @@ -571,7 +571,7 @@ "$id": "57", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "58", "kind": "url", @@ -592,7 +592,7 @@ "$id": "59", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "12" }, @@ -623,7 +623,7 @@ "$id": "62", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "63", "kind": "constant", @@ -732,7 +732,7 @@ "$id": "71", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "72", "kind": "url", @@ -753,7 +753,7 @@ "$id": "73", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "12" }, diff --git a/test/CadlRanchProjects/versioning/madeOptional/tspCodeModel.json b/test/CadlRanchProjects/versioning/madeOptional/tspCodeModel.json index 90207ea9588..507d20ed59d 100644 --- a/test/CadlRanchProjects/versioning/madeOptional/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/madeOptional/tspCodeModel.json @@ -34,7 +34,7 @@ "enumType": { "$ref": "2" }, - "description": "The version v1.", + "doc": "The version v1.", "decorators": [] }, { @@ -52,11 +52,11 @@ "enumType": { "$ref": "2" }, - "description": "The version v2.", + "doc": "The version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -117,7 +117,7 @@ { "$id": "13", "Name": "MadeOptionalClient", - "Description": "Test for the `@madeOptional` decorator.", + "Doc": "Test for the `@madeOptional` decorator.", "Operations": [ { "$id": "14", @@ -150,7 +150,7 @@ "$id": "17", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "18", "kind": "constant", @@ -258,7 +258,7 @@ "$id": "26", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "27", "kind": "url", @@ -279,7 +279,7 @@ "$id": "28", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/versioning/removed-betaversion/tspCodeModel.json b/test/CadlRanchProjects/versioning/removed-betaversion/tspCodeModel.json index 2a9efd0fd9b..94c33a8b937 100644 --- a/test/CadlRanchProjects/versioning/removed-betaversion/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/removed-betaversion/tspCodeModel.json @@ -123,7 +123,7 @@ "enumType": { "$ref": "12" }, - "description": "The original version v1.", + "doc": "The original version v1.", "decorators": [] }, { @@ -141,11 +141,11 @@ "enumType": { "$ref": "12" }, - "description": "The V2 Preview version.", + "doc": "The V2 Preview version.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -376,20 +376,20 @@ { "$id": "41", "Name": "RemovedClient", - "Description": "Test for the `@removed` decorator.", + "Doc": "Test for the `@removed` decorator.", "Operations": [ { "$id": "42", "Name": "v1", "ResourceName": "Removed", - "Description": "This operation should not be generated with latest version's signature.", + "Doc": "This operation should not be generated with latest version's signature.", "Accessibility": "public", "Parameters": [ { "$id": "43", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "44", "kind": "constant", @@ -519,7 +519,7 @@ "$id": "54", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "55", "kind": "constant", @@ -622,14 +622,14 @@ "$id": "62", "Name": "modelV3", "ResourceName": "Removed", - "Description": "This operation will pass different paths and different request bodies based on different versions.", + "Doc": "This operation will pass different paths and different request bodies based on different versions.", "Accessibility": "public", "Parameters": [ { "$id": "63", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "64", "kind": "constant", @@ -737,7 +737,7 @@ "$id": "72", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "73", "kind": "url", @@ -758,7 +758,7 @@ "$id": "74", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", + "Doc": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", "Type": { "$ref": "12" }, @@ -778,7 +778,7 @@ { "$id": "75", "Name": "InterfaceV1", - "Description": "This operation group should not be generated with latest version.", + "Doc": "This operation group should not be generated with latest version.", "Operations": [ { "$id": "76", @@ -790,7 +790,7 @@ "$id": "77", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "78", "kind": "constant", @@ -899,7 +899,7 @@ "$id": "86", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "87", "kind": "url", @@ -920,7 +920,7 @@ "$id": "88", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", + "Doc": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", "Type": { "$ref": "12" }, diff --git a/test/CadlRanchProjects/versioning/removed-oldversion/tspCodeModel.json b/test/CadlRanchProjects/versioning/removed-oldversion/tspCodeModel.json index 3f046e33d46..0ed88aa761a 100644 --- a/test/CadlRanchProjects/versioning/removed-oldversion/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/removed-oldversion/tspCodeModel.json @@ -175,11 +175,11 @@ "enumType": { "$ref": "18" }, - "description": "The original version v1.", + "doc": "The original version v1.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -425,20 +425,20 @@ { "$id": "46", "Name": "RemovedClient", - "Description": "Test for the `@removed` decorator.", + "Doc": "Test for the `@removed` decorator.", "Operations": [ { "$id": "47", "Name": "v1", "ResourceName": "Removed", - "Description": "This operation should not be generated with latest version's signature.", + "Doc": "This operation should not be generated with latest version's signature.", "Accessibility": "public", "Parameters": [ { "$id": "48", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "49", "kind": "constant", @@ -568,7 +568,7 @@ "$id": "59", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "60", "kind": "constant", @@ -671,14 +671,14 @@ "$id": "67", "Name": "modelV3", "ResourceName": "Removed", - "Description": "This operation will pass different paths and different request bodies based on different versions.", + "Doc": "This operation will pass different paths and different request bodies based on different versions.", "Accessibility": "public", "Parameters": [ { "$id": "68", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "69", "kind": "constant", @@ -786,7 +786,7 @@ "$id": "77", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "78", "kind": "url", @@ -807,7 +807,7 @@ "$id": "79", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", + "Doc": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", "Type": { "$ref": "18" }, @@ -827,7 +827,7 @@ { "$id": "80", "Name": "InterfaceV1", - "Description": "This operation group should not be generated with latest version.", + "Doc": "This operation group should not be generated with latest version.", "Operations": [ { "$id": "81", @@ -839,7 +839,7 @@ "$id": "82", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "83", "kind": "constant", @@ -948,7 +948,7 @@ "$id": "91", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "92", "kind": "url", @@ -969,7 +969,7 @@ "$id": "93", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", + "Doc": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", "Type": { "$ref": "18" }, diff --git a/test/CadlRanchProjects/versioning/removed/tspCodeModel.json b/test/CadlRanchProjects/versioning/removed/tspCodeModel.json index bd20f18e41a..b2c5f773396 100644 --- a/test/CadlRanchProjects/versioning/removed/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/removed/tspCodeModel.json @@ -124,7 +124,7 @@ "enumType": { "$ref": "12" }, - "description": "The original version v1.", + "doc": "The original version v1.", "decorators": [] }, { @@ -142,7 +142,7 @@ "enumType": { "$ref": "12" }, - "description": "The V2 Preview version.", + "doc": "The V2 Preview version.", "decorators": [] }, { @@ -160,11 +160,11 @@ "enumType": { "$ref": "12" }, - "description": "The latest version v2.", + "doc": "The latest version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -299,7 +299,7 @@ { "$id": "32", "Name": "RemovedClient", - "Description": "Test for the `@removed` decorator.", + "Doc": "Test for the `@removed` decorator.", "Operations": [ { "$id": "33", @@ -311,7 +311,7 @@ "$id": "34", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "35", "kind": "constant", @@ -414,14 +414,14 @@ "$id": "42", "Name": "modelV3", "ResourceName": "Removed", - "Description": "This operation will pass different paths and different request bodies based on different versions.", + "Doc": "This operation will pass different paths and different request bodies based on different versions.", "Accessibility": "public", "Parameters": [ { "$id": "43", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "44", "kind": "constant", @@ -529,7 +529,7 @@ "$id": "52", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "53", "kind": "url", @@ -550,7 +550,7 @@ "$id": "54", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", + "Doc": "Need to be set as 'v1', 'v2preview' or 'v2' in client.", "Type": { "$ref": "12" }, diff --git a/test/CadlRanchProjects/versioning/renamedFrom/tspCodeModel.json b/test/CadlRanchProjects/versioning/renamedFrom/tspCodeModel.json index 95d70230571..835e4b2823b 100644 --- a/test/CadlRanchProjects/versioning/renamedFrom/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/renamedFrom/tspCodeModel.json @@ -70,7 +70,7 @@ "enumType": { "$ref": "6" }, - "description": "The version v1.", + "doc": "The version v1.", "decorators": [] }, { @@ -88,11 +88,11 @@ "enumType": { "$ref": "6" }, - "description": "The version v2.", + "doc": "The version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -190,7 +190,7 @@ { "$id": "21", "Name": "RenamedFromClient", - "Description": "Test for the `@renamedFrom` decorator.", + "Doc": "Test for the `@renamedFrom` decorator.", "Operations": [ { "$id": "22", @@ -223,7 +223,7 @@ "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -331,7 +331,7 @@ "$id": "34", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "35", "kind": "url", @@ -352,7 +352,7 @@ "$id": "36", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "6" }, @@ -383,7 +383,7 @@ "$id": "39", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "40", "kind": "constant", @@ -492,7 +492,7 @@ "$id": "48", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "49", "kind": "url", @@ -513,7 +513,7 @@ "$id": "50", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "6" }, diff --git a/test/CadlRanchProjects/versioning/returnTypeChangedFrom/tspCodeModel.json b/test/CadlRanchProjects/versioning/returnTypeChangedFrom/tspCodeModel.json index 4e307e361d7..7202d682cd7 100644 --- a/test/CadlRanchProjects/versioning/returnTypeChangedFrom/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/returnTypeChangedFrom/tspCodeModel.json @@ -34,7 +34,7 @@ "enumType": { "$ref": "2" }, - "description": "The version v1.", + "doc": "The version v1.", "decorators": [] }, { @@ -52,11 +52,11 @@ "enumType": { "$ref": "2" }, - "description": "The version v2.", + "doc": "The version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -68,7 +68,7 @@ { "$id": "8", "Name": "ReturnTypeChangedFromClient", - "Description": "Test for the `@returnTypeChangedFrom` decorator.", + "Doc": "Test for the `@returnTypeChangedFrom` decorator.", "Operations": [ { "$id": "9", @@ -80,7 +80,7 @@ "$id": "10", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "11", "kind": "constant", @@ -196,7 +196,7 @@ "$id": "21", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "22", "kind": "url", @@ -217,7 +217,7 @@ "$id": "23", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjects/versioning/typeChangedFrom/tspCodeModel.json b/test/CadlRanchProjects/versioning/typeChangedFrom/tspCodeModel.json index 710a5913931..4211c92207e 100644 --- a/test/CadlRanchProjects/versioning/typeChangedFrom/tspCodeModel.json +++ b/test/CadlRanchProjects/versioning/typeChangedFrom/tspCodeModel.json @@ -34,7 +34,7 @@ "enumType": { "$ref": "2" }, - "description": "The version v1.", + "doc": "The version v1.", "decorators": [] }, { @@ -52,11 +52,11 @@ "enumType": { "$ref": "2" }, - "description": "The version v2.", + "doc": "The version v2.", "decorators": [] } ], - "description": "The version of the API.", + "doc": "The version of the API.", "isFixed": true, "isFlags": false, "usage": "Input,ApiVersionEnum", @@ -117,7 +117,7 @@ { "$id": "13", "Name": "TypeChangedFromClient", - "Description": "Test for the `@typeChangedFrom` decorator.", + "Doc": "Test for the `@typeChangedFrom` decorator.", "Operations": [ { "$id": "14", @@ -150,7 +150,7 @@ "$id": "17", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "18", "kind": "constant", @@ -258,7 +258,7 @@ "$id": "26", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Need to be set as 'http://localhost:3000' in client.", + "Doc": "Need to be set as 'http://localhost:3000' in client.", "Type": { "$id": "27", "kind": "url", @@ -279,7 +279,7 @@ "$id": "28", "Name": "version", "NameInRequest": "version", - "Description": "Need to be set as 'v1' or 'v2' in client.", + "Doc": "Need to be set as 'v1' or 'v2' in client.", "Type": { "$ref": "2" }, diff --git a/test/CadlRanchProjectsNonAzure/authentication/api-key/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/authentication/api-key/tspCodeModel.json index fc72c08e84d..f021c5ff051 100644 --- a/test/CadlRanchProjectsNonAzure/authentication/api-key/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/authentication/api-key/tspCodeModel.json @@ -38,13 +38,13 @@ { "$id": "5", "Name": "ApiKeyClient", - "Description": "Illustrates clients generated with ApiKey authentication.", + "Doc": "Illustrates clients generated with ApiKey authentication.", "Operations": [ { "$id": "6", "Name": "valid", "ResourceName": "ApiKey", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -72,7 +72,7 @@ "$id": "8", "Name": "invalid", "ResourceName": "ApiKey", - "Description": "Check whether client is authenticated.", + "Doc": "Check whether client is authenticated.", "Accessibility": "public", "Parameters": [ { @@ -133,7 +133,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/authentication/http/custom/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/authentication/http/custom/tspCodeModel.json index 3cb96146845..839735c8460 100644 --- a/test/CadlRanchProjectsNonAzure/authentication/http/custom/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/authentication/http/custom/tspCodeModel.json @@ -38,13 +38,13 @@ { "$id": "5", "Name": "CustomClient", - "Description": "Illustrates clients generated with generic HTTP auth.", + "Doc": "Illustrates clients generated with generic HTTP auth.", "Operations": [ { "$id": "6", "Name": "valid", "ResourceName": "Custom", - "Description": "Check whether client is authenticated", + "Doc": "Check whether client is authenticated", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -72,7 +72,7 @@ "$id": "8", "Name": "invalid", "ResourceName": "Custom", - "Description": "Check whether client is authenticated.", + "Doc": "Check whether client is authenticated.", "Accessibility": "public", "Parameters": [ { @@ -133,7 +133,7 @@ "$id": "14", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "15", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/client/naming/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/client/naming/tspCodeModel.json index 9dd12ec66cf..b45cd859a46 100644 --- a/test/CadlRanchProjectsNonAzure/client/naming/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/client/naming/tspCodeModel.json @@ -107,7 +107,7 @@ "kind": "property", "name": "clientName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "14", "kind": "boolean", @@ -137,7 +137,7 @@ "kind": "property", "name": "CSName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "17", "kind": "boolean", @@ -167,7 +167,7 @@ "kind": "property", "name": "clientName", "serializedName": "wireName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "20", "kind": "boolean", @@ -197,7 +197,7 @@ "kind": "property", "name": "defaultName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "23", "kind": "boolean", @@ -227,7 +227,7 @@ "kind": "property", "name": "defaultName", "serializedName": "defaultName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "26", "kind": "boolean", @@ -249,7 +249,7 @@ { "$id": "27", "Name": "NamingClient", - "Description": "Describe changing names of types in a client with `@clientName`", + "Doc": "Describe changing names of types in a client with `@clientName`", "Operations": [ { "$id": "28", @@ -337,7 +337,7 @@ "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -413,7 +413,7 @@ "$id": "41", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "42", "kind": "constant", @@ -489,7 +489,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -653,7 +653,7 @@ "$id": "61", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "62", "kind": "url", @@ -697,7 +697,7 @@ "$id": "67", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "68", "kind": "constant", @@ -773,7 +773,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -849,7 +849,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -893,7 +893,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -969,7 +969,7 @@ "$id": "91", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "92", "kind": "constant", @@ -1045,7 +1045,7 @@ "$id": "97", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "98", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/parameters/body-optionality/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/parameters/body-optionality/tspCodeModel.json index b67afd40a95..8339a4a06c8 100644 --- a/test/CadlRanchProjectsNonAzure/parameters/body-optionality/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/parameters/body-optionality/tspCodeModel.json @@ -38,7 +38,7 @@ { "$id": "5", "Name": "BodyOptionalityClient", - "Description": "Test describing optionality of the request body.", + "Doc": "Test describing optionality of the request body.", "Operations": [ { "$id": "6", @@ -50,7 +50,7 @@ "$id": "7", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "8", "kind": "constant", @@ -126,7 +126,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -201,7 +201,7 @@ "$id": "19", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "20", "kind": "url", @@ -245,7 +245,7 @@ "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -321,7 +321,7 @@ "$id": "31", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "32", "kind": "constant", @@ -397,7 +397,7 @@ "$id": "37", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "38", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/parameters/spread/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/parameters/spread/tspCodeModel.json index 3cc532ba734..f750112b2bc 100644 --- a/test/CadlRanchProjectsNonAzure/parameters/spread/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/parameters/spread/tspCodeModel.json @@ -104,7 +104,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "required string", + "doc": "required string", "type": { "$id": "13", "kind": "string", @@ -124,7 +124,7 @@ "kind": "property", "name": "optionalInt", "serializedName": "optionalInt", - "description": "optional int", + "doc": "optional int", "type": { "$id": "15", "kind": "int32", @@ -144,7 +144,7 @@ "kind": "property", "name": "requiredIntList", "serializedName": "requiredIntList", - "description": "required int", + "doc": "required int", "type": { "$id": "17", "kind": "array", @@ -171,7 +171,7 @@ "kind": "property", "name": "optionalStringList", "serializedName": "optionalStringList", - "description": "optional string", + "doc": "optional string", "type": { "$id": "20", "kind": "array", @@ -208,7 +208,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "24", "kind": "string", @@ -228,7 +228,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "age of the Thing", + "doc": "age of the Thing", "type": { "$id": "26", "kind": "int32", @@ -251,7 +251,7 @@ "name": "BodyParameter", "crossLanguageDefinitionId": "Parameters.Spread.Model.BodyParameter", "usage": "Input,Spread,Json", - "description": "This is a simple model.", + "doc": "This is a simple model.", "decorators": [], "properties": [ { @@ -309,7 +309,7 @@ { "$id": "33", "Name": "SpreadClient", - "Description": "Test for the spread operator.", + "Doc": "Test for the spread operator.", "Operations": [], "Protocol": { "$id": "34" @@ -319,7 +319,7 @@ "$id": "35", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "36", "kind": "url", @@ -363,7 +363,7 @@ "$id": "41", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "42", "kind": "constant", @@ -439,7 +439,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -627,7 +627,7 @@ "$id": "63", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "64", "kind": "constant", @@ -745,7 +745,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -821,7 +821,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -865,7 +865,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -983,7 +983,7 @@ "$id": "95", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "96", "kind": "constant", @@ -1101,7 +1101,7 @@ "$id": "105", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "106", "kind": "constant", @@ -1219,7 +1219,7 @@ "$id": "115", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "116", "kind": "constant", @@ -1289,7 +1289,7 @@ "$id": "120", "Name": "spreadParameterWithInnerAlias", "ResourceName": "Alias", - "Description": "spread an alias with contains another alias property as body.", + "Doc": "spread an alias with contains another alias property as body.", "Accessibility": "public", "Parameters": [ { @@ -1338,7 +1338,7 @@ "$id": "125", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "126", "kind": "constant", @@ -1414,7 +1414,7 @@ "$id": "131", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "132", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/payload/content-negotiation/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/payload/content-negotiation/tspCodeModel.json index 3e9be3f5305..1f299606a5d 100644 --- a/test/CadlRanchProjectsNonAzure/payload/content-negotiation/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/payload/content-negotiation/tspCodeModel.json @@ -39,7 +39,7 @@ { "$id": "5", "Name": "ContentNegotiationClient", - "Description": "Test describing optionality of the request body.", + "Doc": "Test describing optionality of the request body.", "Operations": [], "Protocol": { "$id": "6" @@ -49,7 +49,7 @@ "$id": "7", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "8", "kind": "url", @@ -261,7 +261,7 @@ "$id": "31", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "32", "kind": "url", @@ -469,7 +469,7 @@ "$id": "54", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "55", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/payload/multipart/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/payload/multipart/tspCodeModel.json index cfc7d5e279b..f134fc4e364 100644 --- a/test/CadlRanchProjectsNonAzure/payload/multipart/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/payload/multipart/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "image/jpg", "value": "image/jpg", - "description": "image/jpg", + "doc": "image/jpg", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FileSpecificContentType_contentType", + "doc": "The FileSpecificContentType_contentType", "isFixed": false, "isFlags": false, "usage": "Input", @@ -813,7 +813,7 @@ { "$id": "79", "Name": "MultiPartClient", - "Description": "Test for multipart", + "Doc": "Test for multipart", "Operations": [], "Protocol": { "$id": "80" @@ -823,7 +823,7 @@ "$id": "81", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "82", "kind": "url", @@ -861,7 +861,7 @@ "$id": "86", "Name": "basic", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -937,7 +937,7 @@ "$id": "92", "Name": "fileArrayAndBasic", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for mixed scenarios", + "Doc": "Test content-type: multipart/form-data for mixed scenarios", "Accessibility": "public", "Parameters": [ { @@ -1013,7 +1013,7 @@ "$id": "98", "Name": "jsonPart", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains json part and binary part ", + "Doc": "Test content-type: multipart/form-data for scenario contains json part and binary part ", "Accessibility": "public", "Parameters": [ { @@ -1089,7 +1089,7 @@ "$id": "104", "Name": "binaryArrayParts", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains multi binary parts", + "Doc": "Test content-type: multipart/form-data for scenario contains multi binary parts", "Accessibility": "public", "Parameters": [ { @@ -1165,7 +1165,7 @@ "$id": "110", "Name": "multiBinaryParts", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data for scenario contains multi binary parts", + "Doc": "Test content-type: multipart/form-data for scenario contains multi binary parts", "Accessibility": "public", "Parameters": [ { @@ -1241,7 +1241,7 @@ "$id": "116", "Name": "checkFileNameAndContentType", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1317,7 +1317,7 @@ "$id": "122", "Name": "anonymousModel", "ResourceName": "FormData", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1399,7 +1399,7 @@ "$id": "129", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "130", "kind": "url", @@ -1437,7 +1437,7 @@ "$id": "134", "Name": "jsonArrayAndFileArray", "ResourceName": "HttpParts", - "Description": "Test content-type: multipart/form-data for mixed scenarios", + "Doc": "Test content-type: multipart/form-data for mixed scenarios", "Accessibility": "public", "Parameters": [ { @@ -1519,7 +1519,7 @@ "$id": "141", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "142", "kind": "url", @@ -1557,7 +1557,7 @@ "$id": "146", "Name": "imageJpegContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1633,7 +1633,7 @@ "$id": "152", "Name": "requiredContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data", + "Doc": "Test content-type: multipart/form-data", "Accessibility": "public", "Parameters": [ { @@ -1709,7 +1709,7 @@ "$id": "158", "Name": "optionalContentType", "ResourceName": "ContentType", - "Description": "Test content-type: multipart/form-data for optional content type", + "Doc": "Test content-type: multipart/form-data for optional content type", "Accessibility": "public", "Parameters": [ { @@ -1791,7 +1791,7 @@ "$id": "165", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "166", "kind": "url", @@ -1829,7 +1829,7 @@ "$id": "170", "Name": "float", "ResourceName": "NonString", - "Description": "Test content-type: multipart/form-data for non string", + "Doc": "Test content-type: multipart/form-data for non string", "Accessibility": "public", "Parameters": [ { @@ -1911,7 +1911,7 @@ "$id": "177", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "178", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/tspCodeModel.json index c0c94e895dc..ff49774478e 100644 --- a/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/tspCodeModel.json @@ -17,7 +17,7 @@ "kind": "property", "name": "defaultName", "serializedName": "wireName", - "description": "Pass in true", + "doc": "Pass in true", "type": { "$id": "4", "kind": "boolean", @@ -39,7 +39,7 @@ { "$id": "5", "Name": "JsonClient", - "Description": "Projection", + "Doc": "Projection", "Operations": [], "Protocol": { "$id": "6" @@ -49,7 +49,7 @@ "$id": "7", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "8", "kind": "url", @@ -93,7 +93,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -230,7 +230,7 @@ "$id": "24", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "25", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/server/endpoint/not-defined/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/server/endpoint/not-defined/tspCodeModel.json index 097d7cba3a8..2ab00f81615 100644 --- a/test/CadlRanchProjectsNonAzure/server/endpoint/not-defined/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/server/endpoint/not-defined/tspCodeModel.json @@ -8,7 +8,7 @@ { "$id": "2", "Name": "NotDefinedClient", - "Description": "Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.", + "Doc": "Illustrates server doesn't define endpoint. Client should automatically add an endpoint to let user pass in.", "Operations": [ { "$id": "3", @@ -46,7 +46,7 @@ "$id": "6", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "7", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/special-words/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/special-words/tspCodeModel.json index db71e6b4289..ae4ec34c193 100644 --- a/test/CadlRanchProjectsNonAzure/special-words/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/special-words/tspCodeModel.json @@ -995,7 +995,7 @@ { "$id": "104", "Name": "SpecialWordsClient", - "Description": "Scenarios to verify that reserved words can be used in service and generators will handle it appropriately.\n\nCurrent list of special words\n```txt\nand\nas\nassert\nasync\nawait\nbreak\nclass\nconstructor\ncontinue\ndef\ndel\nelif\nelse\nexcept\nexec\nfinally\nfor\nfrom\nglobal\nif\nimport\nin\nis\nlambda\nnot\nor\npass\nraise\nreturn\ntry\nwhile\nwith\nyield\n```", + "Doc": "Scenarios to verify that reserved words can be used in service and generators will handle it appropriately.\n\nCurrent list of special words\n```txt\nand\nas\nassert\nasync\nawait\nbreak\nclass\nconstructor\ncontinue\ndef\ndel\nelif\nelse\nexcept\nexec\nfinally\nfor\nfrom\nglobal\nif\nimport\nin\nis\nlambda\nnot\nor\npass\nraise\nreturn\ntry\nwhile\nwith\nyield\n```", "Operations": [], "Protocol": { "$id": "105" @@ -1005,7 +1005,7 @@ "$id": "106", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "107", "kind": "url", @@ -1038,7 +1038,7 @@ { "$id": "110", "Name": "ModelsOps", - "Description": "Verify model names", + "Doc": "Verify model names", "Operations": [ { "$id": "111", @@ -1050,7 +1050,7 @@ "$id": "112", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "113", "kind": "constant", @@ -1126,7 +1126,7 @@ "$id": "118", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "119", "kind": "constant", @@ -1202,7 +1202,7 @@ "$id": "124", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "125", "kind": "constant", @@ -1278,7 +1278,7 @@ "$id": "130", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "131", "kind": "constant", @@ -1354,7 +1354,7 @@ "$id": "136", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "137", "kind": "constant", @@ -1430,7 +1430,7 @@ "$id": "142", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "143", "kind": "constant", @@ -1506,7 +1506,7 @@ "$id": "148", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "149", "kind": "constant", @@ -1582,7 +1582,7 @@ "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1658,7 +1658,7 @@ "$id": "160", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "161", "kind": "constant", @@ -1734,7 +1734,7 @@ "$id": "166", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "167", "kind": "constant", @@ -1810,7 +1810,7 @@ "$id": "172", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "173", "kind": "constant", @@ -1886,7 +1886,7 @@ "$id": "178", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "179", "kind": "constant", @@ -1962,7 +1962,7 @@ "$id": "184", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "185", "kind": "constant", @@ -2038,7 +2038,7 @@ "$id": "190", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "191", "kind": "constant", @@ -2114,7 +2114,7 @@ "$id": "196", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "197", "kind": "constant", @@ -2190,7 +2190,7 @@ "$id": "202", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "203", "kind": "constant", @@ -2266,7 +2266,7 @@ "$id": "208", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "209", "kind": "constant", @@ -2342,7 +2342,7 @@ "$id": "214", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "215", "kind": "constant", @@ -2418,7 +2418,7 @@ "$id": "220", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "221", "kind": "constant", @@ -2494,7 +2494,7 @@ "$id": "226", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "227", "kind": "constant", @@ -2570,7 +2570,7 @@ "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2646,7 +2646,7 @@ "$id": "238", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "239", "kind": "constant", @@ -2722,7 +2722,7 @@ "$id": "244", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "245", "kind": "constant", @@ -2798,7 +2798,7 @@ "$id": "250", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "251", "kind": "constant", @@ -2874,7 +2874,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2950,7 +2950,7 @@ "$id": "262", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "263", "kind": "constant", @@ -3026,7 +3026,7 @@ "$id": "268", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "269", "kind": "constant", @@ -3102,7 +3102,7 @@ "$id": "274", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "275", "kind": "constant", @@ -3178,7 +3178,7 @@ "$id": "280", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "281", "kind": "constant", @@ -3254,7 +3254,7 @@ "$id": "286", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "287", "kind": "constant", @@ -3330,7 +3330,7 @@ "$id": "292", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "293", "kind": "constant", @@ -3406,7 +3406,7 @@ "$id": "298", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "299", "kind": "constant", @@ -3482,7 +3482,7 @@ "$id": "304", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "305", "kind": "constant", @@ -3558,7 +3558,7 @@ "$id": "310", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "311", "kind": "url", @@ -3591,7 +3591,7 @@ { "$id": "314", "Name": "ModelProperties", - "Description": "Verify model names", + "Doc": "Verify model names", "Operations": [ { "$id": "315", @@ -3603,7 +3603,7 @@ "$id": "316", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "317", "kind": "constant", @@ -3679,7 +3679,7 @@ "$id": "322", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "323", "kind": "url", @@ -3712,7 +3712,7 @@ { "$id": "326", "Name": "Operations", - "Description": "Test reserved words as operation name.", + "Doc": "Test reserved words as operation name.", "Operations": [ { "$id": "327", @@ -4615,7 +4615,7 @@ "$id": "394", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "395", "kind": "url", @@ -4648,7 +4648,7 @@ { "$id": "398", "Name": "Parameters", - "Description": "Verify reserved words as parameter name.", + "Doc": "Verify reserved words as parameter name.", "Operations": [ { "$id": "399", @@ -6326,7 +6326,7 @@ "$id": "536", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "537", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/array/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/array/tspCodeModel.json index 3fecf5468b8..d6e1378995e 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/array/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Array.InnerModel", "usage": "Input,Output,Json", - "description": "Array inner model", + "doc": "Array inner model", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "4", "kind": "string", @@ -62,7 +62,7 @@ { "$id": "7", "Name": "ArrayClient", - "Description": "Illustrates various types of arrays.", + "Doc": "Illustrates various types of arrays.", "Operations": [], "Protocol": { "$id": "8" @@ -72,7 +72,7 @@ "$id": "9", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "10", "kind": "url", @@ -105,7 +105,7 @@ { "$id": "13", "Name": "Int32Value", - "Description": "Array of int32 values", + "Doc": "Array of int32 values", "Operations": [ { "$id": "14", @@ -189,7 +189,7 @@ "$id": "22", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "23", "kind": "constant", @@ -276,7 +276,7 @@ "$id": "30", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "31", "kind": "url", @@ -309,7 +309,7 @@ { "$id": "34", "Name": "Int64Value", - "Description": "Array of int64 values", + "Doc": "Array of int64 values", "Operations": [ { "$id": "35", @@ -393,7 +393,7 @@ "$id": "43", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "44", "kind": "constant", @@ -480,7 +480,7 @@ "$id": "51", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "52", "kind": "url", @@ -513,7 +513,7 @@ { "$id": "55", "Name": "BooleanValue", - "Description": "Array of boolean values", + "Doc": "Array of boolean values", "Operations": [ { "$id": "56", @@ -597,7 +597,7 @@ "$id": "64", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "65", "kind": "constant", @@ -684,7 +684,7 @@ "$id": "72", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "73", "kind": "url", @@ -717,7 +717,7 @@ { "$id": "76", "Name": "StringValue", - "Description": "Array of string values", + "Doc": "Array of string values", "Operations": [ { "$id": "77", @@ -801,7 +801,7 @@ "$id": "85", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "86", "kind": "constant", @@ -888,7 +888,7 @@ "$id": "93", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "94", "kind": "url", @@ -921,7 +921,7 @@ { "$id": "97", "Name": "Float32Value", - "Description": "Array of float values", + "Doc": "Array of float values", "Operations": [ { "$id": "98", @@ -1005,7 +1005,7 @@ "$id": "106", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "107", "kind": "constant", @@ -1092,7 +1092,7 @@ "$id": "114", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "115", "kind": "url", @@ -1125,7 +1125,7 @@ { "$id": "118", "Name": "DatetimeValue", - "Description": "Array of datetime values", + "Doc": "Array of datetime values", "Operations": [ { "$id": "119", @@ -1217,7 +1217,7 @@ "$id": "128", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "129", "kind": "constant", @@ -1312,7 +1312,7 @@ "$id": "137", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "138", "kind": "url", @@ -1345,7 +1345,7 @@ { "$id": "141", "Name": "DurationValue", - "Description": "Array of duration values", + "Doc": "Array of duration values", "Operations": [ { "$id": "142", @@ -1437,7 +1437,7 @@ "$id": "151", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "152", "kind": "constant", @@ -1532,7 +1532,7 @@ "$id": "160", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "161", "kind": "url", @@ -1565,7 +1565,7 @@ { "$id": "164", "Name": "UnknownValue", - "Description": "Array of unknown values", + "Doc": "Array of unknown values", "Operations": [ { "$id": "165", @@ -1649,7 +1649,7 @@ "$id": "173", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "174", "kind": "constant", @@ -1736,7 +1736,7 @@ "$id": "181", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "182", "kind": "url", @@ -1769,7 +1769,7 @@ { "$id": "185", "Name": "ModelValue", - "Description": "Array of model values", + "Doc": "Array of model values", "Operations": [ { "$id": "186", @@ -1849,7 +1849,7 @@ "$id": "193", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "194", "kind": "constant", @@ -1932,7 +1932,7 @@ "$id": "200", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "201", "kind": "url", @@ -1965,7 +1965,7 @@ { "$id": "204", "Name": "NullableFloatValue", - "Description": "Array of nullable float values", + "Doc": "Array of nullable float values", "Operations": [ { "$id": "205", @@ -2053,7 +2053,7 @@ "$id": "214", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "215", "kind": "constant", @@ -2136,7 +2136,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2169,7 +2169,7 @@ { "$id": "225", "Name": "NullableInt32Value", - "Description": "Array of nullable int32 values", + "Doc": "Array of nullable int32 values", "Operations": [ { "$id": "226", @@ -2257,7 +2257,7 @@ "$id": "235", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "236", "kind": "constant", @@ -2340,7 +2340,7 @@ "$id": "242", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "243", "kind": "url", @@ -2373,7 +2373,7 @@ { "$id": "246", "Name": "NullableBooleanValue", - "Description": "Array of nullable boolean values", + "Doc": "Array of nullable boolean values", "Operations": [ { "$id": "247", @@ -2461,7 +2461,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2544,7 +2544,7 @@ "$id": "263", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "264", "kind": "url", @@ -2577,7 +2577,7 @@ { "$id": "267", "Name": "NullableStringValue", - "Description": "Array of nullable string values", + "Doc": "Array of nullable string values", "Operations": [ { "$id": "268", @@ -2665,7 +2665,7 @@ "$id": "277", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "278", "kind": "constant", @@ -2748,7 +2748,7 @@ "$id": "284", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "285", "kind": "url", @@ -2781,7 +2781,7 @@ { "$id": "288", "Name": "NullableModelValue", - "Description": "Array of nullable model values", + "Doc": "Array of nullable model values", "Operations": [ { "$id": "289", @@ -2865,7 +2865,7 @@ "$id": "297", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "298", "kind": "constant", @@ -2948,7 +2948,7 @@ "$id": "304", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "305", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/dictionary/tspCodeModel.json index 870aab372bd..66058bb59cb 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Dictionary.InnerModel", "usage": "Input,Output,Json", - "description": "Dictionary inner model", + "doc": "Dictionary inner model", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "4", "kind": "string", @@ -67,7 +67,7 @@ { "$id": "8", "Name": "DictionaryClient", - "Description": "Illustrates various of dictionaries.", + "Doc": "Illustrates various of dictionaries.", "Operations": [], "Protocol": { "$id": "9" @@ -77,7 +77,7 @@ "$id": "10", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "11", "kind": "url", @@ -110,7 +110,7 @@ { "$id": "14", "Name": "Int32Value", - "Description": "Dictionary of int32 values", + "Doc": "Dictionary of int32 values", "Operations": [ { "$id": "15", @@ -199,7 +199,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -291,7 +291,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", @@ -324,7 +324,7 @@ { "$id": "37", "Name": "Int64Value", - "Description": "Dictionary of int64 values", + "Doc": "Dictionary of int64 values", "Operations": [ { "$id": "38", @@ -413,7 +413,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -505,7 +505,7 @@ "$id": "56", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "57", "kind": "url", @@ -538,7 +538,7 @@ { "$id": "60", "Name": "BooleanValue", - "Description": "Dictionary of boolean values", + "Doc": "Dictionary of boolean values", "Operations": [ { "$id": "61", @@ -627,7 +627,7 @@ "$id": "70", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "71", "kind": "constant", @@ -719,7 +719,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", @@ -752,7 +752,7 @@ { "$id": "83", "Name": "StringValue", - "Description": "Dictionary of string values", + "Doc": "Dictionary of string values", "Operations": [ { "$id": "84", @@ -841,7 +841,7 @@ "$id": "93", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "94", "kind": "constant", @@ -933,7 +933,7 @@ "$id": "102", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "103", "kind": "url", @@ -966,7 +966,7 @@ { "$id": "106", "Name": "Float32Value", - "Description": "Dictionary of float values", + "Doc": "Dictionary of float values", "Operations": [ { "$id": "107", @@ -1055,7 +1055,7 @@ "$id": "116", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "117", "kind": "constant", @@ -1147,7 +1147,7 @@ "$id": "125", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "126", "kind": "url", @@ -1180,7 +1180,7 @@ { "$id": "129", "Name": "DatetimeValue", - "Description": "Dictionary of datetime values", + "Doc": "Dictionary of datetime values", "Operations": [ { "$id": "130", @@ -1277,7 +1277,7 @@ "$id": "140", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "141", "kind": "constant", @@ -1377,7 +1377,7 @@ "$id": "150", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "151", "kind": "url", @@ -1410,7 +1410,7 @@ { "$id": "154", "Name": "DurationValue", - "Description": "Dictionary of duration values", + "Doc": "Dictionary of duration values", "Operations": [ { "$id": "155", @@ -1507,7 +1507,7 @@ "$id": "165", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "166", "kind": "constant", @@ -1607,7 +1607,7 @@ "$id": "175", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "176", "kind": "url", @@ -1640,7 +1640,7 @@ { "$id": "179", "Name": "UnknownValue", - "Description": "Dictionary of unknown values", + "Doc": "Dictionary of unknown values", "Operations": [ { "$id": "180", @@ -1729,7 +1729,7 @@ "$id": "189", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "190", "kind": "constant", @@ -1821,7 +1821,7 @@ "$id": "198", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "199", "kind": "url", @@ -1854,7 +1854,7 @@ { "$id": "202", "Name": "ModelValue", - "Description": "Dictionary of model values", + "Doc": "Dictionary of model values", "Operations": [ { "$id": "203", @@ -1939,7 +1939,7 @@ "$id": "211", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "212", "kind": "constant", @@ -2027,7 +2027,7 @@ "$id": "219", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "220", "kind": "url", @@ -2060,7 +2060,7 @@ { "$id": "223", "Name": "RecursiveModelValue", - "Description": "Dictionary of model values", + "Doc": "Dictionary of model values", "Operations": [ { "$id": "224", @@ -2145,7 +2145,7 @@ "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2233,7 +2233,7 @@ "$id": "240", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "241", "kind": "url", @@ -2266,7 +2266,7 @@ { "$id": "244", "Name": "NullableFloatValue", - "Description": "Dictionary of nullable float values", + "Doc": "Dictionary of nullable float values", "Operations": [ { "$id": "245", @@ -2359,7 +2359,7 @@ "$id": "255", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "256", "kind": "constant", @@ -2447,7 +2447,7 @@ "$id": "263", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "264", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/enum/extensible/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/enum/extensible/tspCodeModel.json index e1a58db7dd6..8cc09068b11 100644 --- a/test/CadlRanchProjectsNonAzure/type/enum/extensible/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/enum/extensible/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "Monday.", + "doc": "Monday.", "decorators": [] }, { @@ -49,7 +49,7 @@ "enumType": { "$ref": "2" }, - "description": "Tuesday.", + "doc": "Tuesday.", "decorators": [] }, { @@ -67,7 +67,7 @@ "enumType": { "$ref": "2" }, - "description": "Wednesday.", + "doc": "Wednesday.", "decorators": [] }, { @@ -85,7 +85,7 @@ "enumType": { "$ref": "2" }, - "description": "Thursday.", + "doc": "Thursday.", "decorators": [] }, { @@ -103,7 +103,7 @@ "enumType": { "$ref": "2" }, - "description": "Friday.", + "doc": "Friday.", "decorators": [] }, { @@ -121,7 +121,7 @@ "enumType": { "$ref": "2" }, - "description": "Saturday.", + "doc": "Saturday.", "decorators": [] }, { @@ -139,11 +139,11 @@ "enumType": { "$ref": "2" }, - "description": "Sunday.", + "doc": "Sunday.", "decorators": [] } ], - "description": "Days of the week", + "doc": "Days of the week", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -164,7 +164,7 @@ "$id": "20", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "21", "kind": "url", @@ -330,7 +330,7 @@ "$id": "36", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "37", "kind": "constant", @@ -406,7 +406,7 @@ "$id": "42", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "43", "kind": "constant", @@ -482,7 +482,7 @@ "$id": "48", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "49", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/enum/fixed/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/enum/fixed/tspCodeModel.json index 619ff5a0c5e..3487706435a 100644 --- a/test/CadlRanchProjectsNonAzure/type/enum/fixed/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/enum/fixed/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "Monday.", + "doc": "Monday.", "decorators": [] }, { @@ -49,7 +49,7 @@ "enumType": { "$ref": "2" }, - "description": "Tuesday.", + "doc": "Tuesday.", "decorators": [] }, { @@ -67,7 +67,7 @@ "enumType": { "$ref": "2" }, - "description": "Wednesday.", + "doc": "Wednesday.", "decorators": [] }, { @@ -85,7 +85,7 @@ "enumType": { "$ref": "2" }, - "description": "Thursday.", + "doc": "Thursday.", "decorators": [] }, { @@ -103,7 +103,7 @@ "enumType": { "$ref": "2" }, - "description": "Friday.", + "doc": "Friday.", "decorators": [] }, { @@ -121,7 +121,7 @@ "enumType": { "$ref": "2" }, - "description": "Saturday.", + "doc": "Saturday.", "decorators": [] }, { @@ -139,11 +139,11 @@ "enumType": { "$ref": "2" }, - "description": "Sunday.", + "doc": "Sunday.", "decorators": [] } ], - "description": "Days of the week", + "doc": "Days of the week", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -164,7 +164,7 @@ "$id": "20", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "21", "kind": "url", @@ -202,7 +202,7 @@ "$id": "25", "Name": "getKnownValue", "ResourceName": "String", - "Description": "getKnownValue", + "Doc": "getKnownValue", "Accessibility": "public", "Parameters": [ { @@ -264,14 +264,14 @@ "$id": "30", "Name": "putKnownValue", "ResourceName": "String", - "Description": "putKnownValue", + "Doc": "putKnownValue", "Accessibility": "public", "Parameters": [ { "$id": "31", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "32", "kind": "constant", @@ -299,7 +299,7 @@ "$id": "34", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "2" }, @@ -342,14 +342,14 @@ "$id": "36", "Name": "putUnknownValue", "ResourceName": "String", - "Description": "putUnknownValue", + "Doc": "putUnknownValue", "Accessibility": "public", "Parameters": [ { "$id": "37", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "38", "kind": "constant", @@ -377,7 +377,7 @@ "$id": "40", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$ref": "2" }, @@ -426,7 +426,7 @@ "$id": "43", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "44", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/empty/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/empty/tspCodeModel.json index e645bf40273..293823d38fd 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/empty/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/empty/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "EmptyInput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyInput", "usage": "Input,Json", - "description": "Empty model used in operation parameters", + "doc": "Empty model used in operation parameters", "decorators": [], "properties": [] }, @@ -20,7 +20,7 @@ "name": "EmptyOutput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyOutput", "usage": "Output,Json", - "description": "Empty model used in operation return type", + "doc": "Empty model used in operation return type", "decorators": [], "properties": [] }, @@ -30,7 +30,7 @@ "name": "EmptyInputOutput", "crossLanguageDefinitionId": "Type.Model.Empty.EmptyInputOutput", "usage": "Input,Output,Json", - "description": "Empty model used in both parameter and return type", + "doc": "Empty model used in both parameter and return type", "decorators": [], "properties": [] } @@ -39,7 +39,7 @@ { "$id": "5", "Name": "EmptyClient", - "Description": "Illustrates usage of empty model used in operation's parameters and responses.", + "Doc": "Illustrates usage of empty model used in operation's parameters and responses.", "Operations": [ { "$id": "6", @@ -51,7 +51,7 @@ "$id": "7", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "8", "kind": "constant", @@ -188,7 +188,7 @@ "$id": "18", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "19", "kind": "constant", @@ -296,7 +296,7 @@ "$id": "27", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "28", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/inheritance/enum-discriminator/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/inheritance/enum-discriminator/tspCodeModel.json index 3c94a1dd972..ffb18ff3534 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/inheritance/enum-discriminator/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/inheritance/enum-discriminator/tspCodeModel.json @@ -31,11 +31,11 @@ "enumType": { "$ref": "2" }, - "description": "Species golden", + "doc": "Species golden", "decorators": [] } ], - "description": "extensible enum type for discriminator", + "doc": "extensible enum type for discriminator", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -69,11 +69,11 @@ "enumType": { "$ref": "6" }, - "description": "Species cobra", + "doc": "Species cobra", "decorators": [] } ], - "description": "fixed enum type for discriminator", + "doc": "fixed enum type for discriminator", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -87,14 +87,14 @@ "name": "Dog", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Dog", "usage": "Input,Output,Json", - "description": "Test extensible enum type for discriminator", + "doc": "Test extensible enum type for discriminator", "decorators": [], "discriminatorProperty": { "$id": "11", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$ref": "2" }, @@ -114,7 +114,7 @@ "kind": "property", "name": "weight", "serializedName": "weight", - "description": "Weight of the dog", + "doc": "Weight of the dog", "type": { "$id": "13", "kind": "int32", @@ -138,7 +138,7 @@ "name": "Golden", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Golden", "usage": "Input,Output,Json", - "description": "Golden dog model", + "doc": "Golden dog model", "discriminatorValue": "golden", "decorators": [], "baseModel": { @@ -150,7 +150,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$id": "17", "kind": "constant", @@ -184,14 +184,14 @@ "name": "Snake", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Snake", "usage": "Input,Output,Json", - "description": "Test fixed enum type for discriminator", + "doc": "Test fixed enum type for discriminator", "decorators": [], "discriminatorProperty": { "$id": "20", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$ref": "6" }, @@ -211,7 +211,7 @@ "kind": "property", "name": "length", "serializedName": "length", - "description": "Length of the snake", + "doc": "Length of the snake", "type": { "$id": "22", "kind": "int32", @@ -235,7 +235,7 @@ "name": "Cobra", "crossLanguageDefinitionId": "Type.Model.Inheritance.EnumDiscriminator.Cobra", "usage": "Input,Output,Json", - "description": "Cobra model", + "doc": "Cobra model", "discriminatorValue": "cobra", "decorators": [], "baseModel": { @@ -247,7 +247,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "discriminator property", + "doc": "discriminator property", "type": { "$id": "26", "kind": "constant", @@ -280,13 +280,13 @@ { "$id": "28", "Name": "EnumDiscriminatorClient", - "Description": "Illustrates inheritance with enum discriminator.", + "Doc": "Illustrates inheritance with enum discriminator.", "Operations": [ { "$id": "29", "Name": "getExtensibleModel", "ResourceName": "EnumDiscriminator", - "Description": "Receive model with extensible enum discriminator type.", + "Doc": "Receive model with extensible enum discriminator type.", "Accessibility": "public", "Parameters": [ { @@ -348,14 +348,14 @@ "$id": "34", "Name": "putExtensibleModel", "ResourceName": "EnumDiscriminator", - "Description": "Send model with extensible enum discriminator type.", + "Doc": "Send model with extensible enum discriminator type.", "Accessibility": "public", "Parameters": [ { "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -383,7 +383,7 @@ "$id": "38", "Name": "input", "NameInRequest": "input", - "Description": "Dog to create", + "Doc": "Dog to create", "Type": { "$ref": "10" }, @@ -426,7 +426,7 @@ "$id": "40", "Name": "getExtensibleModelMissingDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model omitting the discriminator.", + "Doc": "Get a model omitting the discriminator.", "Accessibility": "public", "Parameters": [ { @@ -488,7 +488,7 @@ "$id": "45", "Name": "getExtensibleModelWrongDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model containing discriminator value never defined.", + "Doc": "Get a model containing discriminator value never defined.", "Accessibility": "public", "Parameters": [ { @@ -550,7 +550,7 @@ "$id": "50", "Name": "getFixedModel", "ResourceName": "EnumDiscriminator", - "Description": "Receive model with fixed enum discriminator type.", + "Doc": "Receive model with fixed enum discriminator type.", "Accessibility": "public", "Parameters": [ { @@ -612,14 +612,14 @@ "$id": "55", "Name": "putFixedModel", "ResourceName": "EnumDiscriminator", - "Description": "Send model with fixed enum discriminator type.", + "Doc": "Send model with fixed enum discriminator type.", "Accessibility": "public", "Parameters": [ { "$id": "56", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "57", "kind": "constant", @@ -647,7 +647,7 @@ "$id": "59", "Name": "input", "NameInRequest": "input", - "Description": "Snake to create", + "Doc": "Snake to create", "Type": { "$ref": "19" }, @@ -690,7 +690,7 @@ "$id": "61", "Name": "getFixedModelMissingDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model omitting the discriminator.", + "Doc": "Get a model omitting the discriminator.", "Accessibility": "public", "Parameters": [ { @@ -752,7 +752,7 @@ "$id": "66", "Name": "getFixedModelWrongDiscriminator", "ResourceName": "EnumDiscriminator", - "Description": "Get a model containing discriminator value never defined.", + "Doc": "Get a model containing discriminator value never defined.", "Accessibility": "public", "Parameters": [ { @@ -819,7 +819,7 @@ "$id": "72", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "73", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/inheritance/not-discriminated/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/inheritance/not-discriminated/tspCodeModel.json index abe203cb12c..a29b2e35669 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/inheritance/not-discriminated/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/inheritance/not-discriminated/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Siamese", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Siamese", "usage": "Input,Output,Json", - "description": "The third level model in the normal multiple levels inheritance.", + "doc": "The third level model in the normal multiple levels inheritance.", "decorators": [], "baseModel": { "$id": "3", @@ -18,7 +18,7 @@ "name": "Cat", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Cat", "usage": "Input,Output,Json", - "description": "The second level model in the normal multiple levels inheritance.", + "doc": "The second level model in the normal multiple levels inheritance.", "decorators": [], "baseModel": { "$id": "4", @@ -26,7 +26,7 @@ "name": "Pet", "crossLanguageDefinitionId": "Type.Model.Inheritance.NotDiscriminated.Pet", "usage": "Input,Output,Json", - "description": "This is base model for not-discriminated normal multiple levels inheritance.", + "doc": "This is base model for not-discriminated normal multiple levels inheritance.", "decorators": [], "properties": [ { @@ -105,7 +105,7 @@ { "$id": "11", "Name": "NotDiscriminatedClient", - "Description": "Illustrates not-discriminated inheritance model.", + "Doc": "Illustrates not-discriminated inheritance model.", "Operations": [ { "$id": "12", @@ -117,7 +117,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -254,7 +254,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -362,7 +362,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/tspCodeModel.json index 209ea500b16..a6125807007 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Extension", "crossLanguageDefinitionId": "Type.Model.Inheritance.Recursive.Extension", "usage": "Input,Output,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "3", @@ -18,7 +18,7 @@ "name": "Element", "crossLanguageDefinitionId": "Type.Model.Inheritance.Recursive.Element", "usage": "Input,Output,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -75,7 +75,7 @@ { "$id": "8", "Name": "RecursiveClient", - "Description": "Illustrates inheritance recursion", + "Doc": "Illustrates inheritance recursion", "Operations": [ { "$id": "9", @@ -87,7 +87,7 @@ "$id": "10", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "11", "kind": "constant", @@ -223,7 +223,7 @@ "$id": "21", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "22", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/inheritance/single-discriminator/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/inheritance/single-discriminator/tspCodeModel.json index 0075459cad1..61d5c2e68ca 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/inheritance/single-discriminator/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/inheritance/single-discriminator/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Bird", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Bird", "usage": "Input,Output,Json", - "description": "This is base model for polymorphic single level inheritance with a discriminator.", + "doc": "This is base model for polymorphic single level inheritance with a discriminator.", "decorators": [], "discriminatorProperty": { "$id": "3", @@ -63,7 +63,7 @@ "name": "SeaGull", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.SeaGull", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "seagull", "decorators": [], "baseModel": { @@ -103,7 +103,7 @@ "name": "Sparrow", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Sparrow", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "sparrow", "decorators": [], "baseModel": { @@ -143,7 +143,7 @@ "name": "Goose", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Goose", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single level inheritance.", + "doc": "The second level model in polymorphic single level inheritance.", "discriminatorValue": "goose", "decorators": [], "baseModel": { @@ -183,7 +183,7 @@ "name": "Eagle", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Eagle", "usage": "Input,Output,Json", - "description": "The second level model in polymorphic single levels inheritance which contains references to other polymorphic instances.", + "doc": "The second level model in polymorphic single levels inheritance which contains references to other polymorphic instances.", "discriminatorValue": "eagle", "decorators": [], "baseModel": { @@ -301,14 +301,14 @@ "name": "Dinosaur", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.Dinosaur", "usage": "Output,Json", - "description": "Define a base class in the legacy way. Discriminator property is not explicitly defined in the model.", + "doc": "Define a base class in the legacy way. Discriminator property is not explicitly defined in the model.", "decorators": [], "discriminatorProperty": { "$id": "31", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "Discriminator property for Dinosaur.", + "doc": "Discriminator property for Dinosaur.", "type": { "$id": "32", "kind": "string", @@ -355,7 +355,7 @@ "name": "TRex", "crossLanguageDefinitionId": "Type.Model.Inheritance.SingleDiscriminator.TRex", "usage": "Output,Json", - "description": "The second level legacy model in polymorphic single level inheritance.", + "doc": "The second level legacy model in polymorphic single level inheritance.", "discriminatorValue": "t-rex", "decorators": [], "baseModel": { @@ -399,7 +399,7 @@ { "$id": "40", "Name": "SingleDiscriminatorClient", - "Description": "Illustrates inheritance with single discriminator.", + "Doc": "Illustrates inheritance with single discriminator.", "Operations": [ { "$id": "41", @@ -472,7 +472,7 @@ "$id": "47", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "48", "kind": "constant", @@ -609,7 +609,7 @@ "$id": "58", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "59", "kind": "constant", @@ -867,7 +867,7 @@ "$id": "79", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "80", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/model/usage/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/model/usage/tspCodeModel.json index e73fd5363ed..88e7279715e 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/usage/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/model/usage/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "InputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.InputRecord", "usage": "Input,Json", - "description": "Record used in operation parameters", + "doc": "Record used in operation parameters", "decorators": [], "properties": [ { @@ -40,7 +40,7 @@ "name": "OutputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.OutputRecord", "usage": "Output,Json", - "description": "Record used in operation return type", + "doc": "Record used in operation return type", "decorators": [], "properties": [ { @@ -70,7 +70,7 @@ "name": "InputOutputRecord", "crossLanguageDefinitionId": "Type.Model.Usage.InputOutputRecord", "usage": "Input,Output,Json", - "description": "Record used both as operation parameter and return type", + "doc": "Record used both as operation parameter and return type", "decorators": [], "properties": [ { @@ -99,7 +99,7 @@ { "$id": "11", "Name": "UsageClient", - "Description": "Illustrates usage of Record in different places(Operation parameters, return type or both).", + "Doc": "Illustrates usage of Record in different places(Operation parameters, return type or both).", "Operations": [ { "$id": "12", @@ -111,7 +111,7 @@ "$id": "13", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "14", "kind": "constant", @@ -248,7 +248,7 @@ "$id": "24", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "25", "kind": "constant", @@ -356,7 +356,7 @@ "$id": "33", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "34", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/property/additional-properties/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/property/additional-properties/tspCodeModel.json index 878f1b8ac6f..ada137f848a 100644 --- a/test/CadlRanchProjectsNonAzure/type/property/additional-properties/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/property/additional-properties/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "kind1", "value": "kind1", - "description": "kind1", + "doc": "kind1", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData2_kind", + "doc": "The WidgetData2_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "kind1", "value": "kind1", - "description": "kind1", + "doc": "kind1", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData1_kind", + "doc": "The WidgetData1_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "kind0", "value": "kind0", - "description": "kind0", + "doc": "kind0", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The WidgetData0_kind", + "doc": "The WidgetData0_kind", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -110,7 +110,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion3", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion3", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "12", @@ -268,7 +268,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "29", "kind": "string", @@ -297,7 +297,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion2", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion2", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "31", @@ -319,7 +319,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "33", "kind": "string", @@ -342,7 +342,7 @@ "name": "SpreadRecordForNonDiscriminatedUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForNonDiscriminatedUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "35", @@ -411,7 +411,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "42", "kind": "string", @@ -437,7 +437,7 @@ "name": "SpreadRecordForDiscriminatedUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForDiscriminatedUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "44", @@ -459,7 +459,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "46", "kind": "string", @@ -482,7 +482,7 @@ "name": "SpreadRecordForUnion", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadRecordForUnion", "usage": "Input,Output,Json", - "description": "The model spread Record", + "doc": "The model spread Record", "decorators": [], "additionalProperties": { "$id": "48", @@ -512,7 +512,7 @@ "kind": "property", "name": "flag", "serializedName": "flag", - "description": "The name property", + "doc": "The name property", "type": { "$id": "52", "kind": "boolean", @@ -535,7 +535,7 @@ "name": "MultipleSpreadRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.MultipleSpreadRecord", "usage": "Input,Output,Json", - "description": "The model spread Record and Record", + "doc": "The model spread Record and Record", "decorators": [], "additionalProperties": { "$id": "54", @@ -565,7 +565,7 @@ "kind": "property", "name": "flag", "serializedName": "flag", - "description": "The name property", + "doc": "The name property", "type": { "$id": "58", "kind": "boolean", @@ -588,7 +588,7 @@ "name": "DifferentSpreadModelArrayDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelArrayDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "60", @@ -596,7 +596,7 @@ "name": "DifferentSpreadModelArrayRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelArrayRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "61", @@ -608,7 +608,7 @@ "name": "ModelForRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ModelForRecord", "usage": "Input,Output,Json", - "description": "model for record", + "doc": "model for record", "decorators": [], "properties": [ { @@ -616,7 +616,7 @@ "kind": "property", "name": "state", "serializedName": "state", - "description": "The state property", + "doc": "The state property", "type": { "$id": "64", "kind": "string", @@ -664,7 +664,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "68", "kind": "array", @@ -696,7 +696,7 @@ "name": "DifferentSpreadModelDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "70", @@ -704,7 +704,7 @@ "name": "DifferentSpreadModelRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadModelRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$ref": "62" @@ -737,7 +737,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$ref": "62" }, @@ -759,7 +759,7 @@ "name": "DifferentSpreadFloatDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadFloatDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "75", @@ -767,7 +767,7 @@ "name": "DifferentSpreadFloatRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadFloatRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "76", @@ -782,7 +782,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The id property", + "doc": "The id property", "type": { "$id": "78", "kind": "string", @@ -805,7 +805,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "80", "kind": "float32", @@ -831,7 +831,7 @@ "name": "DifferentSpreadStringDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadStringDerived", "usage": "Input,Output,Json", - "description": "The model extends from a model that spread Record with the different known property type", + "doc": "The model extends from a model that spread Record with the different known property type", "decorators": [], "baseModel": { "$id": "82", @@ -839,7 +839,7 @@ "name": "DifferentSpreadStringRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.DifferentSpreadStringRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the different known property type", + "doc": "The model spread Record with the different known property type", "decorators": [], "additionalProperties": { "$id": "83", @@ -854,7 +854,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The name property", + "doc": "The name property", "type": { "$id": "85", "kind": "float32", @@ -877,7 +877,7 @@ "kind": "property", "name": "derivedProp", "serializedName": "derivedProp", - "description": "The index property", + "doc": "The index property", "type": { "$id": "87", "kind": "string", @@ -945,7 +945,7 @@ "name": "IsModelArrayAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsModelArrayAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "93", @@ -988,7 +988,7 @@ "name": "ExtendsModelArrayAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsModelArrayAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "97", @@ -1031,7 +1031,7 @@ "name": "SpreadModelRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadModelRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1060,7 +1060,7 @@ "name": "IsModelAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsModelAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1089,7 +1089,7 @@ "name": "ExtendsModelAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsModelAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$ref": "62" @@ -1118,7 +1118,7 @@ "name": "SpreadFloatRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadFloatRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$id": "107", @@ -1133,7 +1133,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "109", "kind": "float32", @@ -1156,7 +1156,7 @@ "name": "IsFloatAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsFloatAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "111", @@ -1171,7 +1171,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "113", "kind": "float32", @@ -1194,7 +1194,7 @@ "name": "ExtendsFloatAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsFloatAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "115", @@ -1209,7 +1209,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property", + "doc": "The id property", "type": { "$id": "117", "kind": "float32", @@ -1232,7 +1232,7 @@ "name": "SpreadStringRecord", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.SpreadStringRecord", "usage": "Input,Output,Json", - "description": "The model spread Record with the same known property type", + "doc": "The model spread Record with the same known property type", "decorators": [], "additionalProperties": { "$id": "119", @@ -1247,7 +1247,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "121", "kind": "string", @@ -1270,7 +1270,7 @@ "name": "IsStringAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsStringAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "123", @@ -1285,7 +1285,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "125", "kind": "string", @@ -1308,7 +1308,7 @@ "name": "ExtendsStringAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsStringAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "127", @@ -1323,7 +1323,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "129", "kind": "string", @@ -1346,7 +1346,7 @@ "name": "IsUnknownAdditionalPropertiesDiscriminated", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDiscriminated", "usage": "Input,Output,Json", - "description": "The model is Record with a discriminator.", + "doc": "The model is Record with a discriminator.", "decorators": [], "additionalProperties": { "$id": "131", @@ -1360,7 +1360,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "The discriminator", + "doc": "The discriminator", "type": { "$id": "133", "kind": "string", @@ -1381,7 +1381,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "135", "kind": "string", @@ -1408,7 +1408,7 @@ "name": "IsUnknownAdditionalPropertiesDiscriminatedDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDiscriminatedDerived", "usage": "Input,Output,Json", - "description": "The derived discriminated type", + "doc": "The derived discriminated type", "discriminatorValue": "derived", "decorators": [], "baseModel": { @@ -1445,7 +1445,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "142", "kind": "int32", @@ -1465,7 +1465,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "144", "kind": "float32", @@ -1493,7 +1493,7 @@ "name": "IsUnknownAdditionalPropertiesDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalPropertiesDerived", "usage": "Input,Output,Json", - "description": "The model extends from a type that is Record type", + "doc": "The model extends from a type that is Record type", "decorators": [], "baseModel": { "$id": "146", @@ -1501,7 +1501,7 @@ "name": "IsUnknownAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.IsUnknownAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model is from Record type.", + "doc": "The model is from Record type.", "decorators": [], "additionalProperties": { "$id": "147", @@ -1516,7 +1516,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "149", "kind": "string", @@ -1539,7 +1539,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "151", "kind": "int32", @@ -1559,7 +1559,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "153", "kind": "float32", @@ -1585,7 +1585,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDiscriminated", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDiscriminated", "usage": "Input,Output,Json", - "description": "The model extends from Record with a discriminator.", + "doc": "The model extends from Record with a discriminator.", "decorators": [], "additionalProperties": { "$id": "155", @@ -1599,7 +1599,7 @@ "kind": "property", "name": "kind", "serializedName": "kind", - "description": "The discriminator", + "doc": "The discriminator", "type": { "$id": "157", "kind": "string", @@ -1620,7 +1620,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "159", "kind": "string", @@ -1647,7 +1647,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDiscriminatedDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDiscriminatedDerived", "usage": "Input,Output,Json", - "description": "The derived discriminated type", + "doc": "The derived discriminated type", "discriminatorValue": "derived", "decorators": [], "baseModel": { @@ -1684,7 +1684,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "166", "kind": "int32", @@ -1704,7 +1704,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "168", "kind": "float32", @@ -1732,7 +1732,7 @@ "name": "ExtendsUnknownAdditionalPropertiesDerived", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalPropertiesDerived", "usage": "Input,Output,Json", - "description": "The model extends from a type that extends from Record.", + "doc": "The model extends from a type that extends from Record.", "decorators": [], "baseModel": { "$id": "170", @@ -1740,7 +1740,7 @@ "name": "ExtendsUnknownAdditionalProperties", "crossLanguageDefinitionId": "Type.Property.AdditionalProperties.ExtendsUnknownAdditionalProperties", "usage": "Input,Output,Json", - "description": "The model extends from Record type.", + "doc": "The model extends from Record type.", "decorators": [], "additionalProperties": { "$id": "171", @@ -1755,7 +1755,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property", + "doc": "The name property", "type": { "$id": "173", "kind": "string", @@ -1778,7 +1778,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index property", + "doc": "The index property", "type": { "$id": "175", "kind": "int32", @@ -1798,7 +1798,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property", + "doc": "The age property", "type": { "$id": "177", "kind": "float32", @@ -1823,7 +1823,7 @@ { "$id": "178", "Name": "AdditionalPropertiesClient", - "Description": "Tests for additional properties of models", + "Doc": "Tests for additional properties of models", "Operations": [], "Protocol": { "$id": "179" @@ -1833,7 +1833,7 @@ "$id": "180", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "181", "kind": "url", @@ -1871,7 +1871,7 @@ "$id": "185", "Name": "get", "ResourceName": "ExtendsUnknown", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1933,14 +1933,14 @@ "$id": "190", "Name": "put", "ResourceName": "ExtendsUnknown", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "191", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "192", "kind": "constant", @@ -1968,7 +1968,7 @@ "$id": "194", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "170" }, @@ -2017,7 +2017,7 @@ "$id": "197", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "198", "kind": "url", @@ -2055,7 +2055,7 @@ "$id": "202", "Name": "get", "ResourceName": "ExtendsUnknownDerived", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2117,14 +2117,14 @@ "$id": "207", "Name": "put", "ResourceName": "ExtendsUnknownDerived", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "208", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "209", "kind": "constant", @@ -2152,7 +2152,7 @@ "$id": "211", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "169" }, @@ -2201,7 +2201,7 @@ "$id": "214", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "215", "kind": "url", @@ -2239,7 +2239,7 @@ "$id": "219", "Name": "get", "ResourceName": "ExtendsUnknownDiscriminated", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2301,14 +2301,14 @@ "$id": "224", "Name": "put", "ResourceName": "ExtendsUnknownDiscriminated", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "225", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "226", "kind": "constant", @@ -2336,7 +2336,7 @@ "$id": "228", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "154" }, @@ -2385,7 +2385,7 @@ "$id": "231", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "232", "kind": "url", @@ -2423,7 +2423,7 @@ "$id": "236", "Name": "get", "ResourceName": "IsUnknown", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2485,14 +2485,14 @@ "$id": "241", "Name": "put", "ResourceName": "IsUnknown", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "242", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "243", "kind": "constant", @@ -2520,7 +2520,7 @@ "$id": "245", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "146" }, @@ -2569,7 +2569,7 @@ "$id": "248", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "249", "kind": "url", @@ -2607,7 +2607,7 @@ "$id": "253", "Name": "get", "ResourceName": "IsUnknownDerived", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2669,14 +2669,14 @@ "$id": "258", "Name": "put", "ResourceName": "IsUnknownDerived", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "259", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "260", "kind": "constant", @@ -2704,7 +2704,7 @@ "$id": "262", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "145" }, @@ -2753,7 +2753,7 @@ "$id": "265", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "266", "kind": "url", @@ -2791,7 +2791,7 @@ "$id": "270", "Name": "get", "ResourceName": "IsUnknownDiscriminated", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2853,14 +2853,14 @@ "$id": "275", "Name": "put", "ResourceName": "IsUnknownDiscriminated", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "276", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "277", "kind": "constant", @@ -2888,7 +2888,7 @@ "$id": "279", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "130" }, @@ -2937,7 +2937,7 @@ "$id": "282", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "283", "kind": "url", @@ -2975,7 +2975,7 @@ "$id": "287", "Name": "get", "ResourceName": "ExtendsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3037,14 +3037,14 @@ "$id": "292", "Name": "put", "ResourceName": "ExtendsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "293", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "294", "kind": "constant", @@ -3072,7 +3072,7 @@ "$id": "296", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "126" }, @@ -3121,7 +3121,7 @@ "$id": "299", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "300", "kind": "url", @@ -3159,7 +3159,7 @@ "$id": "304", "Name": "get", "ResourceName": "IsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3221,14 +3221,14 @@ "$id": "309", "Name": "put", "ResourceName": "IsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "310", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "311", "kind": "constant", @@ -3256,7 +3256,7 @@ "$id": "313", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "122" }, @@ -3305,7 +3305,7 @@ "$id": "316", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "317", "kind": "url", @@ -3343,7 +3343,7 @@ "$id": "321", "Name": "get", "ResourceName": "SpreadString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3405,14 +3405,14 @@ "$id": "326", "Name": "put", "ResourceName": "SpreadString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "327", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "328", "kind": "constant", @@ -3440,7 +3440,7 @@ "$id": "330", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "118" }, @@ -3489,7 +3489,7 @@ "$id": "333", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "334", "kind": "url", @@ -3527,7 +3527,7 @@ "$id": "338", "Name": "get", "ResourceName": "ExtendsFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3589,14 +3589,14 @@ "$id": "343", "Name": "put", "ResourceName": "ExtendsFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "344", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "345", "kind": "constant", @@ -3624,7 +3624,7 @@ "$id": "347", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "114" }, @@ -3673,7 +3673,7 @@ "$id": "350", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "351", "kind": "url", @@ -3711,7 +3711,7 @@ "$id": "355", "Name": "get", "ResourceName": "IsFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3773,14 +3773,14 @@ "$id": "360", "Name": "put", "ResourceName": "IsFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "361", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "362", "kind": "constant", @@ -3808,7 +3808,7 @@ "$id": "364", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "110" }, @@ -3857,7 +3857,7 @@ "$id": "367", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "368", "kind": "url", @@ -3895,7 +3895,7 @@ "$id": "372", "Name": "get", "ResourceName": "SpreadFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3957,14 +3957,14 @@ "$id": "377", "Name": "put", "ResourceName": "SpreadFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "378", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "379", "kind": "constant", @@ -3992,7 +3992,7 @@ "$id": "381", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "106" }, @@ -4041,7 +4041,7 @@ "$id": "384", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "385", "kind": "url", @@ -4079,7 +4079,7 @@ "$id": "389", "Name": "get", "ResourceName": "ExtendsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4141,14 +4141,14 @@ "$id": "394", "Name": "put", "ResourceName": "ExtendsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "395", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "396", "kind": "constant", @@ -4176,7 +4176,7 @@ "$id": "398", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "104" }, @@ -4225,7 +4225,7 @@ "$id": "401", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "402", "kind": "url", @@ -4263,7 +4263,7 @@ "$id": "406", "Name": "get", "ResourceName": "IsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4325,14 +4325,14 @@ "$id": "411", "Name": "put", "ResourceName": "IsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "412", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "413", "kind": "constant", @@ -4360,7 +4360,7 @@ "$id": "415", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "102" }, @@ -4409,7 +4409,7 @@ "$id": "418", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "419", "kind": "url", @@ -4447,7 +4447,7 @@ "$id": "423", "Name": "get", "ResourceName": "SpreadModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4509,14 +4509,14 @@ "$id": "428", "Name": "put", "ResourceName": "SpreadModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "429", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "430", "kind": "constant", @@ -4544,7 +4544,7 @@ "$id": "432", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "100" }, @@ -4593,7 +4593,7 @@ "$id": "435", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "436", "kind": "url", @@ -4631,7 +4631,7 @@ "$id": "440", "Name": "get", "ResourceName": "ExtendsModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4693,14 +4693,14 @@ "$id": "445", "Name": "put", "ResourceName": "ExtendsModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "446", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "447", "kind": "constant", @@ -4728,7 +4728,7 @@ "$id": "449", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "96" }, @@ -4777,7 +4777,7 @@ "$id": "452", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "453", "kind": "url", @@ -4815,7 +4815,7 @@ "$id": "457", "Name": "get", "ResourceName": "IsModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4877,14 +4877,14 @@ "$id": "462", "Name": "put", "ResourceName": "IsModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "463", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "464", "kind": "constant", @@ -4912,7 +4912,7 @@ "$id": "466", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "92" }, @@ -4961,7 +4961,7 @@ "$id": "469", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "470", "kind": "url", @@ -4999,7 +4999,7 @@ "$id": "474", "Name": "get", "ResourceName": "SpreadModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5061,14 +5061,14 @@ "$id": "479", "Name": "put", "ResourceName": "SpreadModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "480", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "481", "kind": "constant", @@ -5096,7 +5096,7 @@ "$id": "483", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "88" }, @@ -5145,7 +5145,7 @@ "$id": "486", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "487", "kind": "url", @@ -5183,7 +5183,7 @@ "$id": "491", "Name": "get", "ResourceName": "SpreadDifferentString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5245,14 +5245,14 @@ "$id": "496", "Name": "put", "ResourceName": "SpreadDifferentString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "497", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "498", "kind": "constant", @@ -5280,7 +5280,7 @@ "$id": "500", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "82" }, @@ -5329,7 +5329,7 @@ "$id": "503", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "504", "kind": "url", @@ -5367,7 +5367,7 @@ "$id": "508", "Name": "get", "ResourceName": "SpreadDifferentFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5429,14 +5429,14 @@ "$id": "513", "Name": "put", "ResourceName": "SpreadDifferentFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "514", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "515", "kind": "constant", @@ -5464,7 +5464,7 @@ "$id": "517", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "75" }, @@ -5513,7 +5513,7 @@ "$id": "520", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "521", "kind": "url", @@ -5551,7 +5551,7 @@ "$id": "525", "Name": "get", "ResourceName": "SpreadDifferentModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5613,14 +5613,14 @@ "$id": "530", "Name": "put", "ResourceName": "SpreadDifferentModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "531", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "532", "kind": "constant", @@ -5648,7 +5648,7 @@ "$id": "534", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "70" }, @@ -5697,7 +5697,7 @@ "$id": "537", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "538", "kind": "url", @@ -5735,7 +5735,7 @@ "$id": "542", "Name": "get", "ResourceName": "SpreadDifferentModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5797,14 +5797,14 @@ "$id": "547", "Name": "put", "ResourceName": "SpreadDifferentModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "548", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "549", "kind": "constant", @@ -5832,7 +5832,7 @@ "$id": "551", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "60" }, @@ -5881,7 +5881,7 @@ "$id": "554", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "555", "kind": "url", @@ -5919,7 +5919,7 @@ "$id": "559", "Name": "get", "ResourceName": "ExtendsDifferentSpreadString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5981,14 +5981,14 @@ "$id": "564", "Name": "put", "ResourceName": "ExtendsDifferentSpreadString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "565", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "566", "kind": "constant", @@ -6016,7 +6016,7 @@ "$id": "568", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "81" }, @@ -6065,7 +6065,7 @@ "$id": "571", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "572", "kind": "url", @@ -6103,7 +6103,7 @@ "$id": "576", "Name": "get", "ResourceName": "ExtendsDifferentSpreadFloat", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6165,14 +6165,14 @@ "$id": "581", "Name": "put", "ResourceName": "ExtendsDifferentSpreadFloat", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "582", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "583", "kind": "constant", @@ -6200,7 +6200,7 @@ "$id": "585", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "74" }, @@ -6249,7 +6249,7 @@ "$id": "588", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "589", "kind": "url", @@ -6287,7 +6287,7 @@ "$id": "593", "Name": "get", "ResourceName": "ExtendsDifferentSpreadModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6349,14 +6349,14 @@ "$id": "598", "Name": "put", "ResourceName": "ExtendsDifferentSpreadModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "599", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "600", "kind": "constant", @@ -6384,7 +6384,7 @@ "$id": "602", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "69" }, @@ -6433,7 +6433,7 @@ "$id": "605", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "606", "kind": "url", @@ -6471,7 +6471,7 @@ "$id": "610", "Name": "get", "ResourceName": "ExtendsDifferentSpreadModelArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6533,14 +6533,14 @@ "$id": "615", "Name": "put", "ResourceName": "ExtendsDifferentSpreadModelArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "616", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "617", "kind": "constant", @@ -6568,7 +6568,7 @@ "$id": "619", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "59" }, @@ -6617,7 +6617,7 @@ "$id": "622", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "623", "kind": "url", @@ -6655,7 +6655,7 @@ "$id": "627", "Name": "get", "ResourceName": "MultipleSpread", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6717,14 +6717,14 @@ "$id": "632", "Name": "put", "ResourceName": "MultipleSpread", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "633", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "634", "kind": "constant", @@ -6752,7 +6752,7 @@ "$id": "636", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "53" }, @@ -6801,7 +6801,7 @@ "$id": "639", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "640", "kind": "url", @@ -6839,7 +6839,7 @@ "$id": "644", "Name": "get", "ResourceName": "SpreadRecordUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6901,14 +6901,14 @@ "$id": "649", "Name": "put", "ResourceName": "SpreadRecordUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "650", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "651", "kind": "constant", @@ -6936,7 +6936,7 @@ "$id": "653", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "47" }, @@ -6985,7 +6985,7 @@ "$id": "656", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "657", "kind": "url", @@ -7023,7 +7023,7 @@ "$id": "661", "Name": "get", "ResourceName": "SpreadRecordDiscriminatedUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7085,14 +7085,14 @@ "$id": "666", "Name": "put", "ResourceName": "SpreadRecordDiscriminatedUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "667", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "668", "kind": "constant", @@ -7120,7 +7120,7 @@ "$id": "670", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "43" }, @@ -7169,7 +7169,7 @@ "$id": "673", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "674", "kind": "url", @@ -7207,7 +7207,7 @@ "$id": "678", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7269,14 +7269,14 @@ "$id": "683", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "684", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "685", "kind": "constant", @@ -7304,7 +7304,7 @@ "$id": "687", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "34" }, @@ -7353,7 +7353,7 @@ "$id": "690", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "691", "kind": "url", @@ -7391,7 +7391,7 @@ "$id": "695", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion2", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7453,14 +7453,14 @@ "$id": "700", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion2", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "701", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "702", "kind": "constant", @@ -7488,7 +7488,7 @@ "$id": "704", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "30" }, @@ -7537,7 +7537,7 @@ "$id": "707", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "708", "kind": "url", @@ -7575,7 +7575,7 @@ "$id": "712", "Name": "get", "ResourceName": "SpreadRecordNonDiscriminatedUnion3", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -7637,14 +7637,14 @@ "$id": "717", "Name": "put", "ResourceName": "SpreadRecordNonDiscriminatedUnion3", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "718", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "719", "kind": "constant", @@ -7672,7 +7672,7 @@ "$id": "721", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "11" }, @@ -7721,7 +7721,7 @@ "$id": "724", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "725", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/property/nullable/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/property/nullable/tspCodeModel.json index a5874cb31ec..14e97db8871 100644 --- a/test/CadlRanchProjectsNonAzure/type/property/nullable/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/property/nullable/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "CollectionsStringProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsStringProperty", "usage": "Input,Output,JsonMergePatch,Json", - "description": "Model with collection string properties", + "doc": "Model with collection string properties", "decorators": [], "properties": [ { @@ -18,7 +18,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "4", "kind": "string", @@ -38,7 +38,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "6", "kind": "nullable", @@ -72,7 +72,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsModelProperty", "usage": "Output,Json", - "description": "Model with collection models properties", + "doc": "Model with collection models properties", "decorators": [], "properties": [ { @@ -80,7 +80,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "11", "kind": "string", @@ -100,7 +100,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "13", "kind": "nullable", @@ -114,7 +114,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Property.Nullable.InnerModel", "usage": "Output,Json", - "description": "Inner model used in collections model property", + "doc": "Inner model used in collections model property", "decorators": [], "properties": [ { @@ -122,7 +122,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Inner model property", + "doc": "Inner model property", "type": { "$id": "17", "kind": "string", @@ -161,7 +161,7 @@ "name": "CollectionsByteProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.CollectionsByteProperty", "usage": "Output,Json", - "description": "Model with collection bytes properties", + "doc": "Model with collection bytes properties", "decorators": [], "properties": [ { @@ -169,7 +169,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "20", "kind": "string", @@ -189,7 +189,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "22", "kind": "nullable", @@ -224,7 +224,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.DurationProperty", "usage": "Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -232,7 +232,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "27", "kind": "string", @@ -252,7 +252,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "29", "kind": "nullable", @@ -287,7 +287,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.DatetimeProperty", "usage": "Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -295,7 +295,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "34", "kind": "string", @@ -315,7 +315,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "36", "kind": "nullable", @@ -350,7 +350,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.BytesProperty", "usage": "Output,Json", - "description": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -358,7 +358,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "41", "kind": "string", @@ -378,7 +378,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "43", "kind": "nullable", @@ -406,7 +406,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.Nullable.StringProperty", "usage": "Output,Json", - "description": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with nullable property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -414,7 +414,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "Required property", + "doc": "Required property", "type": { "$id": "47", "kind": "string", @@ -434,7 +434,7 @@ "kind": "property", "name": "nullableProperty", "serializedName": "nullableProperty", - "description": "Property", + "doc": "Property", "type": { "$id": "49", "kind": "nullable", @@ -460,7 +460,7 @@ { "$id": "51", "Name": "NullableClient", - "Description": "Illustrates models with nullable properties.", + "Doc": "Illustrates models with nullable properties.", "Operations": [], "Protocol": { "$id": "52" @@ -470,7 +470,7 @@ "$id": "53", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "54", "kind": "url", @@ -508,7 +508,7 @@ "$id": "58", "Name": "getNonNull", "ResourceName": "String", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -570,7 +570,7 @@ "$id": "63", "Name": "getNull", "ResourceName": "String", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -632,14 +632,14 @@ "$id": "68", "Name": "patchNonNull", "ResourceName": "String", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "69", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "70", "kind": "constant", @@ -709,14 +709,14 @@ "$id": "74", "Name": "patchNull", "ResourceName": "String", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "75", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "76", "kind": "constant", @@ -792,7 +792,7 @@ "$id": "81", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "82", "kind": "url", @@ -830,7 +830,7 @@ "$id": "86", "Name": "getNonNull", "ResourceName": "Bytes", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -892,7 +892,7 @@ "$id": "91", "Name": "getNull", "ResourceName": "Bytes", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -954,14 +954,14 @@ "$id": "96", "Name": "patchNonNull", "ResourceName": "Bytes", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "97", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "98", "kind": "constant", @@ -1031,14 +1031,14 @@ "$id": "102", "Name": "patchNull", "ResourceName": "Bytes", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "103", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "104", "kind": "constant", @@ -1114,7 +1114,7 @@ "$id": "109", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "110", "kind": "url", @@ -1152,7 +1152,7 @@ "$id": "114", "Name": "getNonNull", "ResourceName": "Datetime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1214,7 +1214,7 @@ "$id": "119", "Name": "getNull", "ResourceName": "Datetime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1276,14 +1276,14 @@ "$id": "124", "Name": "patchNonNull", "ResourceName": "Datetime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "125", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "126", "kind": "constant", @@ -1353,14 +1353,14 @@ "$id": "130", "Name": "patchNull", "ResourceName": "Datetime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "131", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "132", "kind": "constant", @@ -1436,7 +1436,7 @@ "$id": "137", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "138", "kind": "url", @@ -1474,7 +1474,7 @@ "$id": "142", "Name": "getNonNull", "ResourceName": "Duration", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1536,7 +1536,7 @@ "$id": "147", "Name": "getNull", "ResourceName": "Duration", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1598,14 +1598,14 @@ "$id": "152", "Name": "patchNonNull", "ResourceName": "Duration", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "153", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "154", "kind": "constant", @@ -1675,14 +1675,14 @@ "$id": "158", "Name": "patchNull", "ResourceName": "Duration", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "159", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "160", "kind": "constant", @@ -1758,7 +1758,7 @@ "$id": "165", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "166", "kind": "url", @@ -1796,7 +1796,7 @@ "$id": "170", "Name": "getNonNull", "ResourceName": "CollectionsByte", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1858,7 +1858,7 @@ "$id": "175", "Name": "getNull", "ResourceName": "CollectionsByte", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1920,14 +1920,14 @@ "$id": "180", "Name": "patchNonNull", "ResourceName": "CollectionsByte", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "181", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "182", "kind": "constant", @@ -1997,14 +1997,14 @@ "$id": "186", "Name": "patchNull", "ResourceName": "CollectionsByte", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "187", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "188", "kind": "constant", @@ -2080,7 +2080,7 @@ "$id": "193", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "194", "kind": "url", @@ -2118,7 +2118,7 @@ "$id": "198", "Name": "getNonNull", "ResourceName": "CollectionsModel", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2180,7 +2180,7 @@ "$id": "203", "Name": "getNull", "ResourceName": "CollectionsModel", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2242,14 +2242,14 @@ "$id": "208", "Name": "patchNonNull", "ResourceName": "CollectionsModel", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "209", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "210", "kind": "constant", @@ -2319,14 +2319,14 @@ "$id": "214", "Name": "patchNull", "ResourceName": "CollectionsModel", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "215", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "216", "kind": "constant", @@ -2402,7 +2402,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2440,7 +2440,7 @@ "$id": "226", "Name": "getNonNull", "ResourceName": "CollectionsString", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2502,7 +2502,7 @@ "$id": "231", "Name": "getNull", "ResourceName": "CollectionsString", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2564,14 +2564,14 @@ "$id": "236", "Name": "patchNonNull", "ResourceName": "CollectionsString", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "237", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "238", "kind": "constant", @@ -2641,14 +2641,14 @@ "$id": "242", "Name": "patchNull", "ResourceName": "CollectionsString", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "243", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "content-type is application/merge-patch+json", + "Doc": "content-type is application/merge-patch+json", "Type": { "$id": "244", "kind": "constant", @@ -2724,7 +2724,7 @@ "$id": "249", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "250", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/property/optionality/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/property/optionality/tspCodeModel.json index b19bdfff08b..7b966d8806a 100644 --- a/test/CadlRanchProjectsNonAzure/type/property/optionality/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/property/optionality/tspCodeModel.json @@ -179,7 +179,7 @@ "kind": "enumvalue", "name": "1.25", "value": 1.25, - "description": "1.25", + "doc": "1.25", "valueType": { "$ref": "21" }, @@ -189,7 +189,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FloatLiteralProperty_property", + "doc": "The FloatLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -212,7 +212,7 @@ "kind": "enumvalue", "name": "1", "value": 1, - "description": "1", + "doc": "1", "valueType": { "$ref": "24" }, @@ -222,7 +222,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The IntLiteralProperty_property", + "doc": "The IntLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -245,7 +245,7 @@ "kind": "enumvalue", "name": "hello", "value": "hello", - "description": "hello", + "doc": "hello", "valueType": { "$ref": "27" }, @@ -255,7 +255,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The StringLiteralProperty_property", + "doc": "The StringLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -269,7 +269,7 @@ "name": "RequiredAndOptionalProperty", "crossLanguageDefinitionId": "Type.Property.Optional.RequiredAndOptionalProperty", "usage": "Input,Output,Json", - "description": "Model with required and optional properties", + "doc": "Model with required and optional properties", "decorators": [], "properties": [ { @@ -277,7 +277,7 @@ "kind": "property", "name": "optionalProperty", "serializedName": "optionalProperty", - "description": "optional string property", + "doc": "optional string property", "type": { "$id": "31", "kind": "string", @@ -297,7 +297,7 @@ "kind": "property", "name": "requiredProperty", "serializedName": "requiredProperty", - "description": "required int property", + "doc": "required int property", "type": { "$id": "33", "kind": "int32", @@ -320,7 +320,7 @@ "name": "UnionFloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionFloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of float literal property", + "doc": "Model with union of float literal property", "decorators": [], "properties": [ { @@ -328,7 +328,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "2" }, @@ -347,7 +347,7 @@ "name": "UnionIntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionIntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of int literal property", + "doc": "Model with union of int literal property", "decorators": [], "properties": [ { @@ -355,7 +355,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "8" }, @@ -374,7 +374,7 @@ "name": "UnionStringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.UnionStringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with union of string literal property", + "doc": "Model with union of string literal property", "decorators": [], "properties": [ { @@ -382,7 +382,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "14" }, @@ -401,7 +401,7 @@ "name": "BooleanLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.BooleanLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with boolean literal property", + "doc": "Model with boolean literal property", "decorators": [], "properties": [ { @@ -409,7 +409,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "42", "kind": "constant", @@ -438,7 +438,7 @@ "name": "FloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.FloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with float literal property", + "doc": "Model with float literal property", "decorators": [], "properties": [ { @@ -446,7 +446,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "46", "kind": "constant", @@ -471,7 +471,7 @@ "name": "IntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.IntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with int literal property", + "doc": "Model with int literal property", "decorators": [], "properties": [ { @@ -479,7 +479,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "49", "kind": "constant", @@ -504,7 +504,7 @@ "name": "StringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.Optional.StringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with string literal property", + "doc": "Model with string literal property", "decorators": [], "properties": [ { @@ -512,7 +512,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "52", "kind": "constant", @@ -537,7 +537,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.Optional.CollectionsModelProperty", "usage": "Input,Output,Json", - "description": "Model with collection models properties", + "doc": "Model with collection models properties", "decorators": [], "properties": [ { @@ -545,7 +545,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "55", "kind": "array", @@ -556,7 +556,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.Optional.StringProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with optional property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with optional property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -564,7 +564,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "58", "kind": "string", @@ -602,7 +602,7 @@ "name": "CollectionsByteProperty", "crossLanguageDefinitionId": "Type.Property.Optional.CollectionsByteProperty", "usage": "Input,Output,Json", - "description": "Model with collection bytes properties", + "doc": "Model with collection bytes properties", "decorators": [], "properties": [ { @@ -610,7 +610,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "61", "kind": "array", @@ -641,7 +641,7 @@ "name": "PlainTimeProperty", "crossLanguageDefinitionId": "Type.Property.Optional.PlainTimeProperty", "usage": "Input,Output,Json", - "description": "Model with a plainTime property", + "doc": "Model with a plainTime property", "decorators": [], "properties": [ { @@ -649,7 +649,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "65", "kind": "plainTime", @@ -672,7 +672,7 @@ "name": "PlainDateProperty", "crossLanguageDefinitionId": "Type.Property.Optional.PlainDateProperty", "usage": "Input,Output,Json", - "description": "Model with a plainDate property", + "doc": "Model with a plainDate property", "decorators": [], "properties": [ { @@ -680,7 +680,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "68", "kind": "plainDate", @@ -703,7 +703,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.Optional.DurationProperty", "usage": "Input,Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -711,7 +711,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "71", "kind": "duration", @@ -742,7 +742,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.Optional.DatetimeProperty", "usage": "Input,Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -750,7 +750,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "75", "kind": "utcDateTime", @@ -781,7 +781,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.Optional.BytesProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with optional property. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with optional property. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -789,7 +789,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "79", "kind": "bytes", @@ -812,7 +812,7 @@ { "$id": "80", "Name": "OptionalClient", - "Description": "Illustrates models with optional properties.", + "Doc": "Illustrates models with optional properties.", "Operations": [], "Protocol": { "$id": "81" @@ -822,7 +822,7 @@ "$id": "82", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "83", "kind": "url", @@ -860,7 +860,7 @@ "$id": "87", "Name": "getAll", "ResourceName": "String", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -922,7 +922,7 @@ "$id": "92", "Name": "getDefault", "ResourceName": "String", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -984,14 +984,14 @@ "$id": "97", "Name": "putAll", "ResourceName": "String", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "98", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "99", "kind": "constant", @@ -1061,14 +1061,14 @@ "$id": "103", "Name": "putDefault", "ResourceName": "String", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "104", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "105", "kind": "constant", @@ -1144,7 +1144,7 @@ "$id": "110", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "111", "kind": "url", @@ -1182,7 +1182,7 @@ "$id": "115", "Name": "getAll", "ResourceName": "Bytes", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1244,7 +1244,7 @@ "$id": "120", "Name": "getDefault", "ResourceName": "Bytes", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1306,14 +1306,14 @@ "$id": "125", "Name": "putAll", "ResourceName": "Bytes", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "126", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "127", "kind": "constant", @@ -1383,14 +1383,14 @@ "$id": "131", "Name": "putDefault", "ResourceName": "Bytes", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "132", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "133", "kind": "constant", @@ -1466,7 +1466,7 @@ "$id": "138", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "139", "kind": "url", @@ -1504,7 +1504,7 @@ "$id": "143", "Name": "getAll", "ResourceName": "Datetime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1566,7 +1566,7 @@ "$id": "148", "Name": "getDefault", "ResourceName": "Datetime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1628,14 +1628,14 @@ "$id": "153", "Name": "putAll", "ResourceName": "Datetime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1705,14 +1705,14 @@ "$id": "159", "Name": "putDefault", "ResourceName": "Datetime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "160", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "161", "kind": "constant", @@ -1788,7 +1788,7 @@ "$id": "166", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "167", "kind": "url", @@ -1826,7 +1826,7 @@ "$id": "171", "Name": "getAll", "ResourceName": "Duration", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -1888,7 +1888,7 @@ "$id": "176", "Name": "getDefault", "ResourceName": "Duration", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -1950,14 +1950,14 @@ "$id": "181", "Name": "putAll", "ResourceName": "Duration", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "182", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "183", "kind": "constant", @@ -2027,14 +2027,14 @@ "$id": "187", "Name": "putDefault", "ResourceName": "Duration", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "188", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "189", "kind": "constant", @@ -2110,7 +2110,7 @@ "$id": "194", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "195", "kind": "url", @@ -2148,7 +2148,7 @@ "$id": "199", "Name": "getAll", "ResourceName": "PlainDate", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2210,7 +2210,7 @@ "$id": "204", "Name": "getDefault", "ResourceName": "PlainDate", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2272,14 +2272,14 @@ "$id": "209", "Name": "putAll", "ResourceName": "PlainDate", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "210", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "211", "kind": "constant", @@ -2349,14 +2349,14 @@ "$id": "215", "Name": "putDefault", "ResourceName": "PlainDate", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "216", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "217", "kind": "constant", @@ -2432,7 +2432,7 @@ "$id": "222", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "223", "kind": "url", @@ -2470,7 +2470,7 @@ "$id": "227", "Name": "getAll", "ResourceName": "PlainTime", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2532,7 +2532,7 @@ "$id": "232", "Name": "getDefault", "ResourceName": "PlainTime", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2594,14 +2594,14 @@ "$id": "237", "Name": "putAll", "ResourceName": "PlainTime", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "238", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "239", "kind": "constant", @@ -2671,14 +2671,14 @@ "$id": "243", "Name": "putDefault", "ResourceName": "PlainTime", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "244", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "245", "kind": "constant", @@ -2754,7 +2754,7 @@ "$id": "250", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "251", "kind": "url", @@ -2792,7 +2792,7 @@ "$id": "255", "Name": "getAll", "ResourceName": "CollectionsByte", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -2854,7 +2854,7 @@ "$id": "260", "Name": "getDefault", "ResourceName": "CollectionsByte", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -2916,14 +2916,14 @@ "$id": "265", "Name": "putAll", "ResourceName": "CollectionsByte", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "266", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "267", "kind": "constant", @@ -2993,14 +2993,14 @@ "$id": "271", "Name": "putDefault", "ResourceName": "CollectionsByte", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "272", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "273", "kind": "constant", @@ -3076,7 +3076,7 @@ "$id": "278", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "279", "kind": "url", @@ -3114,7 +3114,7 @@ "$id": "283", "Name": "getAll", "ResourceName": "CollectionsModel", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3176,7 +3176,7 @@ "$id": "288", "Name": "getDefault", "ResourceName": "CollectionsModel", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3238,14 +3238,14 @@ "$id": "293", "Name": "putAll", "ResourceName": "CollectionsModel", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "294", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "295", "kind": "constant", @@ -3315,14 +3315,14 @@ "$id": "299", "Name": "putDefault", "ResourceName": "CollectionsModel", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "300", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "301", "kind": "constant", @@ -3398,7 +3398,7 @@ "$id": "306", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "307", "kind": "url", @@ -3436,7 +3436,7 @@ "$id": "311", "Name": "getAll", "ResourceName": "StringLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3498,7 +3498,7 @@ "$id": "316", "Name": "getDefault", "ResourceName": "StringLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3560,14 +3560,14 @@ "$id": "321", "Name": "putAll", "ResourceName": "StringLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "322", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "323", "kind": "constant", @@ -3637,14 +3637,14 @@ "$id": "327", "Name": "putDefault", "ResourceName": "StringLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "328", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "329", "kind": "constant", @@ -3720,7 +3720,7 @@ "$id": "334", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "335", "kind": "url", @@ -3758,7 +3758,7 @@ "$id": "339", "Name": "getAll", "ResourceName": "IntLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -3820,7 +3820,7 @@ "$id": "344", "Name": "getDefault", "ResourceName": "IntLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -3882,14 +3882,14 @@ "$id": "349", "Name": "putAll", "ResourceName": "IntLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "350", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "351", "kind": "constant", @@ -3959,14 +3959,14 @@ "$id": "355", "Name": "putDefault", "ResourceName": "IntLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "356", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "357", "kind": "constant", @@ -4042,7 +4042,7 @@ "$id": "362", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "363", "kind": "url", @@ -4080,7 +4080,7 @@ "$id": "367", "Name": "getAll", "ResourceName": "FloatLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4142,7 +4142,7 @@ "$id": "372", "Name": "getDefault", "ResourceName": "FloatLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4204,14 +4204,14 @@ "$id": "377", "Name": "putAll", "ResourceName": "FloatLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "378", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "379", "kind": "constant", @@ -4281,14 +4281,14 @@ "$id": "383", "Name": "putDefault", "ResourceName": "FloatLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "384", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "385", "kind": "constant", @@ -4364,7 +4364,7 @@ "$id": "390", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "391", "kind": "url", @@ -4402,7 +4402,7 @@ "$id": "395", "Name": "getAll", "ResourceName": "BooleanLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4464,7 +4464,7 @@ "$id": "400", "Name": "getDefault", "ResourceName": "BooleanLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4526,14 +4526,14 @@ "$id": "405", "Name": "putAll", "ResourceName": "BooleanLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "406", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "407", "kind": "constant", @@ -4603,14 +4603,14 @@ "$id": "411", "Name": "putDefault", "ResourceName": "BooleanLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "412", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "413", "kind": "constant", @@ -4686,7 +4686,7 @@ "$id": "418", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "419", "kind": "url", @@ -4724,7 +4724,7 @@ "$id": "423", "Name": "getAll", "ResourceName": "UnionStringLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -4786,7 +4786,7 @@ "$id": "428", "Name": "getDefault", "ResourceName": "UnionStringLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -4848,14 +4848,14 @@ "$id": "433", "Name": "putAll", "ResourceName": "UnionStringLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "434", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "435", "kind": "constant", @@ -4925,14 +4925,14 @@ "$id": "439", "Name": "putDefault", "ResourceName": "UnionStringLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "440", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "441", "kind": "constant", @@ -5008,7 +5008,7 @@ "$id": "446", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "447", "kind": "url", @@ -5046,7 +5046,7 @@ "$id": "451", "Name": "getAll", "ResourceName": "UnionIntLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5108,7 +5108,7 @@ "$id": "456", "Name": "getDefault", "ResourceName": "UnionIntLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -5170,14 +5170,14 @@ "$id": "461", "Name": "putAll", "ResourceName": "UnionIntLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "462", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "463", "kind": "constant", @@ -5247,14 +5247,14 @@ "$id": "467", "Name": "putDefault", "ResourceName": "UnionIntLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "468", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "469", "kind": "constant", @@ -5330,7 +5330,7 @@ "$id": "474", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "475", "kind": "url", @@ -5368,7 +5368,7 @@ "$id": "479", "Name": "getAll", "ResourceName": "UnionFloatLiteral", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5430,7 +5430,7 @@ "$id": "484", "Name": "getDefault", "ResourceName": "UnionFloatLiteral", - "Description": "Get models that will return the default object", + "Doc": "Get models that will return the default object", "Accessibility": "public", "Parameters": [ { @@ -5492,14 +5492,14 @@ "$id": "489", "Name": "putAll", "ResourceName": "UnionFloatLiteral", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "490", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "491", "kind": "constant", @@ -5569,14 +5569,14 @@ "$id": "495", "Name": "putDefault", "ResourceName": "UnionFloatLiteral", - "Description": "Put a body with default properties.", + "Doc": "Put a body with default properties.", "Accessibility": "public", "Parameters": [ { "$id": "496", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "497", "kind": "constant", @@ -5652,7 +5652,7 @@ "$id": "502", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "503", "kind": "url", @@ -5685,13 +5685,13 @@ { "$id": "506", "Name": "RequiredAndOptional", - "Description": "Test optional and required properties", + "Doc": "Test optional and required properties", "Operations": [ { "$id": "507", "Name": "getAll", "ResourceName": "RequiredAndOptional", - "Description": "Get models that will return all properties in the model", + "Doc": "Get models that will return all properties in the model", "Accessibility": "public", "Parameters": [ { @@ -5753,7 +5753,7 @@ "$id": "512", "Name": "getRequiredOnly", "ResourceName": "RequiredAndOptional", - "Description": "Get models that will return only the required properties", + "Doc": "Get models that will return only the required properties", "Accessibility": "public", "Parameters": [ { @@ -5815,14 +5815,14 @@ "$id": "517", "Name": "putAll", "ResourceName": "RequiredAndOptional", - "Description": "Put a body with all properties present.", + "Doc": "Put a body with all properties present.", "Accessibility": "public", "Parameters": [ { "$id": "518", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "519", "kind": "constant", @@ -5892,14 +5892,14 @@ "$id": "523", "Name": "putRequiredOnly", "ResourceName": "RequiredAndOptional", - "Description": "Put a body with only required properties.", + "Doc": "Put a body with only required properties.", "Accessibility": "public", "Parameters": [ { "$id": "524", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "525", "kind": "constant", @@ -5975,7 +5975,7 @@ "$id": "530", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "531", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/property/value-types/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/property/value-types/tspCodeModel.json index cd41538a220..f8b7d62a328 100644 --- a/test/CadlRanchProjectsNonAzure/type/property/value-types/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/property/value-types/tspCodeModel.json @@ -215,7 +215,7 @@ "kind": "enumvalue", "name": "43.125", "value": 43.125, - "description": "43.125", + "doc": "43.125", "valueType": { "$ref": "25" }, @@ -225,7 +225,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FloatLiteralProperty_property", + "doc": "The FloatLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -248,7 +248,7 @@ "kind": "enumvalue", "name": "42", "value": 42, - "description": "42", + "doc": "42", "valueType": { "$ref": "28" }, @@ -258,7 +258,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The IntLiteralProperty_property", + "doc": "The IntLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -281,7 +281,7 @@ "kind": "enumvalue", "name": "hello", "value": "hello", - "description": "hello", + "doc": "hello", "valueType": { "$ref": "31" }, @@ -291,7 +291,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The StringLiteralProperty_property", + "doc": "The StringLiteralProperty_property", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -325,7 +325,7 @@ "enumType": { "$ref": "33" }, - "description": "First value.", + "doc": "First value.", "decorators": [] }, { @@ -343,11 +343,11 @@ "enumType": { "$ref": "33" }, - "description": "Second value.", + "doc": "Second value.", "decorators": [] } ], - "description": "Enum that will be used as a property for model EnumProperty. Extensible.", + "doc": "Enum that will be used as a property for model EnumProperty. Extensible.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -381,7 +381,7 @@ "enumType": { "$ref": "39" }, - "description": "First value.", + "doc": "First value.", "decorators": [] }, { @@ -399,11 +399,11 @@ "enumType": { "$ref": "39" }, - "description": "Second value.", + "doc": "Second value.", "decorators": [] } ], - "description": "Enum that will be used as a property for model EnumProperty. Non-extensible.", + "doc": "Enum that will be used as a property for model EnumProperty. Non-extensible.", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -417,7 +417,7 @@ "name": "UnionEnumValueProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionEnumValueProperty", "usage": "Input,Output,Json", - "description": "Template type for testing models with specific properties. Pass in the type of the property you are looking for", + "doc": "Template type for testing models with specific properties. Pass in the type of the property you are looking for", "decorators": [], "properties": [ { @@ -425,7 +425,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "47", "kind": "constant", @@ -450,7 +450,7 @@ "name": "UnionFloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionFloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of float literal as property.", + "doc": "Model with a union of float literal as property.", "decorators": [], "properties": [ { @@ -458,7 +458,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "6" }, @@ -477,7 +477,7 @@ "name": "UnionIntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionIntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of int literal as property.", + "doc": "Model with a union of int literal as property.", "decorators": [], "properties": [ { @@ -485,7 +485,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "12" }, @@ -504,7 +504,7 @@ "name": "UnionStringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnionStringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a union of string literal as property.", + "doc": "Model with a union of string literal as property.", "decorators": [], "properties": [ { @@ -512,7 +512,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "18" }, @@ -531,7 +531,7 @@ "name": "BooleanLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BooleanLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a boolean literal property.", + "doc": "Model with a boolean literal property.", "decorators": [], "properties": [ { @@ -539,7 +539,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "56", "kind": "constant", @@ -568,7 +568,7 @@ "name": "FloatLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.FloatLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a float literal property.", + "doc": "Model with a float literal property.", "decorators": [], "properties": [ { @@ -576,7 +576,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "60", "kind": "constant", @@ -601,7 +601,7 @@ "name": "IntLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.IntLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a int literal property.", + "doc": "Model with a int literal property.", "decorators": [], "properties": [ { @@ -609,7 +609,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "63", "kind": "constant", @@ -634,7 +634,7 @@ "name": "StringLiteralProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.StringLiteralProperty", "usage": "Input,Output,Json", - "description": "Model with a string literal property.", + "doc": "Model with a string literal property.", "decorators": [], "properties": [ { @@ -642,7 +642,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "66", "kind": "constant", @@ -667,7 +667,7 @@ "name": "UnknownArrayProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownArrayProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is an array.", + "doc": "Model with a property unknown, and the data is an array.", "decorators": [], "properties": [ { @@ -675,7 +675,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "69", "kind": "unknown", @@ -698,7 +698,7 @@ "name": "UnknownDictProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownDictProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a dictionnary.", + "doc": "Model with a property unknown, and the data is a dictionnary.", "decorators": [], "properties": [ { @@ -706,7 +706,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "72", "kind": "unknown", @@ -729,7 +729,7 @@ "name": "UnknownIntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownIntProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a int32.", + "doc": "Model with a property unknown, and the data is a int32.", "decorators": [], "properties": [ { @@ -737,7 +737,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "75", "kind": "unknown", @@ -760,7 +760,7 @@ "name": "UnknownStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.UnknownStringProperty", "usage": "Input,Output,Json", - "description": "Model with a property unknown, and the data is a string.", + "doc": "Model with a property unknown, and the data is a string.", "decorators": [], "properties": [ { @@ -768,7 +768,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "78", "kind": "unknown", @@ -791,7 +791,7 @@ "name": "NeverProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.NeverProperty", "usage": "Input,Output,Json", - "description": "Model with a property never. (This property should not be included).", + "doc": "Model with a property never. (This property should not be included).", "decorators": [], "properties": [] }, @@ -801,7 +801,7 @@ "name": "DictionaryStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DictionaryStringProperty", "usage": "Input,Output,Json", - "description": "Model with dictionary string properties", + "doc": "Model with dictionary string properties", "decorators": [], "properties": [ { @@ -809,7 +809,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "82", "kind": "dict", @@ -844,7 +844,7 @@ "name": "CollectionsModelProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsModelProperty", "usage": "Input,Output,Json", - "description": "Model with collection model properties", + "doc": "Model with collection model properties", "decorators": [], "properties": [ { @@ -852,7 +852,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "87", "kind": "array", @@ -863,7 +863,7 @@ "name": "InnerModel", "crossLanguageDefinitionId": "Type.Property.ValueTypes.InnerModel", "usage": "Input,Output,Json", - "description": "Inner model. Will be a property type for ModelWithModelProperties", + "doc": "Inner model. Will be a property type for ModelWithModelProperties", "decorators": [], "properties": [ { @@ -871,7 +871,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Required string property", + "doc": "Required string property", "type": { "$id": "90", "kind": "string", @@ -909,7 +909,7 @@ "name": "CollectionsIntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsIntProperty", "usage": "Input,Output,Json", - "description": "Model with collection int properties", + "doc": "Model with collection int properties", "decorators": [], "properties": [ { @@ -917,7 +917,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "93", "kind": "array", @@ -947,7 +947,7 @@ "name": "CollectionsStringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.CollectionsStringProperty", "usage": "Input,Output,Json", - "description": "Model with collection string properties", + "doc": "Model with collection string properties", "decorators": [], "properties": [ { @@ -955,7 +955,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "97", "kind": "array", @@ -985,7 +985,7 @@ "name": "ModelProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.ModelProperty", "usage": "Input,Output,Json", - "description": "Model with model properties", + "doc": "Model with model properties", "decorators": [], "properties": [ { @@ -993,7 +993,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "88" }, @@ -1012,7 +1012,7 @@ "name": "ExtensibleEnumProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.ExtensibleEnumProperty", "usage": "Input,Output,Json", - "description": "Model with extensible enum properties", + "doc": "Model with extensible enum properties", "decorators": [], "properties": [ { @@ -1020,7 +1020,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "33" }, @@ -1039,7 +1039,7 @@ "name": "EnumProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.EnumProperty", "usage": "Input,Output,Json", - "description": "Model with enum properties", + "doc": "Model with enum properties", "decorators": [], "properties": [ { @@ -1047,7 +1047,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$ref": "39" }, @@ -1066,7 +1066,7 @@ "name": "DurationProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DurationProperty", "usage": "Input,Output,Json", - "description": "Model with a duration property", + "doc": "Model with a duration property", "decorators": [], "properties": [ { @@ -1074,7 +1074,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "107", "kind": "duration", @@ -1105,7 +1105,7 @@ "name": "DatetimeProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DatetimeProperty", "usage": "Input,Output,Json", - "description": "Model with a datetime property", + "doc": "Model with a datetime property", "decorators": [], "properties": [ { @@ -1113,7 +1113,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "111", "kind": "utcDateTime", @@ -1144,7 +1144,7 @@ "name": "Decimal128Property", "crossLanguageDefinitionId": "Type.Property.ValueTypes.Decimal128Property", "usage": "Input,Output,Json", - "description": "Model with a decimal128 property", + "doc": "Model with a decimal128 property", "decorators": [], "properties": [ { @@ -1152,7 +1152,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "115", "kind": "decimal128", @@ -1175,7 +1175,7 @@ "name": "DecimalProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.DecimalProperty", "usage": "Input,Output,Json", - "description": "Model with a decimal property", + "doc": "Model with a decimal property", "decorators": [], "properties": [ { @@ -1183,7 +1183,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "118", "kind": "decimal", @@ -1206,7 +1206,7 @@ "name": "FloatProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.FloatProperty", "usage": "Input,Output,Json", - "description": "Model with a float property", + "doc": "Model with a float property", "decorators": [], "properties": [ { @@ -1214,7 +1214,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "121", "kind": "float32", @@ -1237,7 +1237,7 @@ "name": "IntProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.IntProperty", "usage": "Input,Output,Json", - "description": "Model with a int property", + "doc": "Model with a int property", "decorators": [], "properties": [ { @@ -1245,7 +1245,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "124", "kind": "int32", @@ -1268,7 +1268,7 @@ "name": "BytesProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BytesProperty", "usage": "Input,Output,Json", - "description": "Model with a bytes property", + "doc": "Model with a bytes property", "decorators": [], "properties": [ { @@ -1276,7 +1276,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "127", "kind": "bytes", @@ -1300,7 +1300,7 @@ "name": "StringProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.StringProperty", "usage": "Input,Output,Json", - "description": "Model with a string property", + "doc": "Model with a string property", "decorators": [], "properties": [ { @@ -1308,7 +1308,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "130", "kind": "string", @@ -1331,7 +1331,7 @@ "name": "BooleanProperty", "crossLanguageDefinitionId": "Type.Property.ValueTypes.BooleanProperty", "usage": "Input,Output,Json", - "description": "Model with a boolean property", + "doc": "Model with a boolean property", "decorators": [], "properties": [ { @@ -1339,7 +1339,7 @@ "kind": "property", "name": "property", "serializedName": "property", - "description": "Property", + "doc": "Property", "type": { "$id": "133", "kind": "boolean", @@ -1361,7 +1361,7 @@ { "$id": "134", "Name": "ValueTypesClient", - "Description": "Illustrates various property types for models", + "Doc": "Illustrates various property types for models", "Operations": [], "Protocol": { "$id": "135" @@ -1371,7 +1371,7 @@ "$id": "136", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "137", "kind": "url", @@ -1409,7 +1409,7 @@ "$id": "141", "Name": "get", "ResourceName": "Boolean", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1471,14 +1471,14 @@ "$id": "146", "Name": "put", "ResourceName": "Boolean", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "147", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "148", "kind": "constant", @@ -1506,7 +1506,7 @@ "$id": "150", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "131" }, @@ -1555,7 +1555,7 @@ "$id": "153", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "154", "kind": "url", @@ -1593,7 +1593,7 @@ "$id": "158", "Name": "get", "ResourceName": "String", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1655,14 +1655,14 @@ "$id": "163", "Name": "put", "ResourceName": "String", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "164", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "165", "kind": "constant", @@ -1690,7 +1690,7 @@ "$id": "167", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "128" }, @@ -1739,7 +1739,7 @@ "$id": "170", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "171", "kind": "url", @@ -1777,7 +1777,7 @@ "$id": "175", "Name": "get", "ResourceName": "Bytes", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -1839,14 +1839,14 @@ "$id": "180", "Name": "put", "ResourceName": "Bytes", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "181", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "182", "kind": "constant", @@ -1874,7 +1874,7 @@ "$id": "184", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "125" }, @@ -1923,7 +1923,7 @@ "$id": "187", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "188", "kind": "url", @@ -1961,7 +1961,7 @@ "$id": "192", "Name": "get", "ResourceName": "Int", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2023,14 +2023,14 @@ "$id": "197", "Name": "put", "ResourceName": "Int", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "198", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "199", "kind": "constant", @@ -2058,7 +2058,7 @@ "$id": "201", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "122" }, @@ -2107,7 +2107,7 @@ "$id": "204", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "205", "kind": "url", @@ -2145,7 +2145,7 @@ "$id": "209", "Name": "get", "ResourceName": "Float", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2207,14 +2207,14 @@ "$id": "214", "Name": "put", "ResourceName": "Float", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "215", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "216", "kind": "constant", @@ -2242,7 +2242,7 @@ "$id": "218", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "119" }, @@ -2291,7 +2291,7 @@ "$id": "221", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "222", "kind": "url", @@ -2329,7 +2329,7 @@ "$id": "226", "Name": "get", "ResourceName": "Decimal", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2391,14 +2391,14 @@ "$id": "231", "Name": "put", "ResourceName": "Decimal", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "232", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "233", "kind": "constant", @@ -2426,7 +2426,7 @@ "$id": "235", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "116" }, @@ -2475,7 +2475,7 @@ "$id": "238", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "239", "kind": "url", @@ -2513,7 +2513,7 @@ "$id": "243", "Name": "get", "ResourceName": "Decimal128", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2575,14 +2575,14 @@ "$id": "248", "Name": "put", "ResourceName": "Decimal128", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "249", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "250", "kind": "constant", @@ -2610,7 +2610,7 @@ "$id": "252", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "113" }, @@ -2659,7 +2659,7 @@ "$id": "255", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "256", "kind": "url", @@ -2697,7 +2697,7 @@ "$id": "260", "Name": "get", "ResourceName": "Datetime", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2759,14 +2759,14 @@ "$id": "265", "Name": "put", "ResourceName": "Datetime", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "266", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "267", "kind": "constant", @@ -2794,7 +2794,7 @@ "$id": "269", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "109" }, @@ -2843,7 +2843,7 @@ "$id": "272", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "273", "kind": "url", @@ -2881,7 +2881,7 @@ "$id": "277", "Name": "get", "ResourceName": "Duration", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -2943,14 +2943,14 @@ "$id": "282", "Name": "put", "ResourceName": "Duration", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "283", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "284", "kind": "constant", @@ -2978,7 +2978,7 @@ "$id": "286", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "105" }, @@ -3027,7 +3027,7 @@ "$id": "289", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "290", "kind": "url", @@ -3065,7 +3065,7 @@ "$id": "294", "Name": "get", "ResourceName": "Enum", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3127,14 +3127,14 @@ "$id": "299", "Name": "put", "ResourceName": "Enum", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "300", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "301", "kind": "constant", @@ -3162,7 +3162,7 @@ "$id": "303", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "103" }, @@ -3211,7 +3211,7 @@ "$id": "306", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "307", "kind": "url", @@ -3249,7 +3249,7 @@ "$id": "311", "Name": "get", "ResourceName": "ExtensibleEnum", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3311,14 +3311,14 @@ "$id": "316", "Name": "put", "ResourceName": "ExtensibleEnum", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "317", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "318", "kind": "constant", @@ -3346,7 +3346,7 @@ "$id": "320", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "101" }, @@ -3395,7 +3395,7 @@ "$id": "323", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "324", "kind": "url", @@ -3433,7 +3433,7 @@ "$id": "328", "Name": "get", "ResourceName": "Model", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3495,14 +3495,14 @@ "$id": "333", "Name": "put", "ResourceName": "Model", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "334", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "335", "kind": "constant", @@ -3530,7 +3530,7 @@ "$id": "337", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "99" }, @@ -3579,7 +3579,7 @@ "$id": "340", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "341", "kind": "url", @@ -3617,7 +3617,7 @@ "$id": "345", "Name": "get", "ResourceName": "CollectionsString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3679,14 +3679,14 @@ "$id": "350", "Name": "put", "ResourceName": "CollectionsString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "351", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "352", "kind": "constant", @@ -3714,7 +3714,7 @@ "$id": "354", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "95" }, @@ -3763,7 +3763,7 @@ "$id": "357", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "358", "kind": "url", @@ -3801,7 +3801,7 @@ "$id": "362", "Name": "get", "ResourceName": "CollectionsInt", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -3863,14 +3863,14 @@ "$id": "367", "Name": "put", "ResourceName": "CollectionsInt", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "368", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "369", "kind": "constant", @@ -3898,7 +3898,7 @@ "$id": "371", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "91" }, @@ -3947,7 +3947,7 @@ "$id": "374", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "375", "kind": "url", @@ -3985,7 +3985,7 @@ "$id": "379", "Name": "get", "ResourceName": "CollectionsModel", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4047,14 +4047,14 @@ "$id": "384", "Name": "put", "ResourceName": "CollectionsModel", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "385", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "386", "kind": "constant", @@ -4082,7 +4082,7 @@ "$id": "388", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "85" }, @@ -4131,7 +4131,7 @@ "$id": "391", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "392", "kind": "url", @@ -4169,7 +4169,7 @@ "$id": "396", "Name": "get", "ResourceName": "DictionaryString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4231,14 +4231,14 @@ "$id": "401", "Name": "put", "ResourceName": "DictionaryString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "402", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "403", "kind": "constant", @@ -4266,7 +4266,7 @@ "$id": "405", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "80" }, @@ -4315,7 +4315,7 @@ "$id": "408", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "409", "kind": "url", @@ -4353,7 +4353,7 @@ "$id": "413", "Name": "get", "ResourceName": "Never", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4415,14 +4415,14 @@ "$id": "418", "Name": "put", "ResourceName": "Never", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "419", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "420", "kind": "constant", @@ -4450,7 +4450,7 @@ "$id": "422", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "79" }, @@ -4499,7 +4499,7 @@ "$id": "425", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "426", "kind": "url", @@ -4537,7 +4537,7 @@ "$id": "430", "Name": "get", "ResourceName": "UnknownString", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4599,14 +4599,14 @@ "$id": "435", "Name": "put", "ResourceName": "UnknownString", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "436", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "437", "kind": "constant", @@ -4634,7 +4634,7 @@ "$id": "439", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "76" }, @@ -4683,7 +4683,7 @@ "$id": "442", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "443", "kind": "url", @@ -4721,7 +4721,7 @@ "$id": "447", "Name": "get", "ResourceName": "UnknownInt", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4783,14 +4783,14 @@ "$id": "452", "Name": "put", "ResourceName": "UnknownInt", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "453", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "454", "kind": "constant", @@ -4818,7 +4818,7 @@ "$id": "456", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "73" }, @@ -4867,7 +4867,7 @@ "$id": "459", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "460", "kind": "url", @@ -4905,7 +4905,7 @@ "$id": "464", "Name": "get", "ResourceName": "UnknownDict", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -4967,14 +4967,14 @@ "$id": "469", "Name": "put", "ResourceName": "UnknownDict", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "470", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "471", "kind": "constant", @@ -5002,7 +5002,7 @@ "$id": "473", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "70" }, @@ -5051,7 +5051,7 @@ "$id": "476", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "477", "kind": "url", @@ -5089,7 +5089,7 @@ "$id": "481", "Name": "get", "ResourceName": "UnknownArray", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5151,14 +5151,14 @@ "$id": "486", "Name": "put", "ResourceName": "UnknownArray", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "487", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "488", "kind": "constant", @@ -5186,7 +5186,7 @@ "$id": "490", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "67" }, @@ -5235,7 +5235,7 @@ "$id": "493", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "494", "kind": "url", @@ -5273,7 +5273,7 @@ "$id": "498", "Name": "get", "ResourceName": "StringLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5335,14 +5335,14 @@ "$id": "503", "Name": "put", "ResourceName": "StringLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "504", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "505", "kind": "constant", @@ -5370,7 +5370,7 @@ "$id": "507", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "64" }, @@ -5419,7 +5419,7 @@ "$id": "510", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "511", "kind": "url", @@ -5457,7 +5457,7 @@ "$id": "515", "Name": "get", "ResourceName": "IntLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5519,14 +5519,14 @@ "$id": "520", "Name": "put", "ResourceName": "IntLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "521", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "522", "kind": "constant", @@ -5554,7 +5554,7 @@ "$id": "524", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "61" }, @@ -5603,7 +5603,7 @@ "$id": "527", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "528", "kind": "url", @@ -5641,7 +5641,7 @@ "$id": "532", "Name": "get", "ResourceName": "FloatLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5703,14 +5703,14 @@ "$id": "537", "Name": "put", "ResourceName": "FloatLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "538", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "539", "kind": "constant", @@ -5738,7 +5738,7 @@ "$id": "541", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "58" }, @@ -5787,7 +5787,7 @@ "$id": "544", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "545", "kind": "url", @@ -5825,7 +5825,7 @@ "$id": "549", "Name": "get", "ResourceName": "BooleanLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -5887,14 +5887,14 @@ "$id": "554", "Name": "put", "ResourceName": "BooleanLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "555", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "556", "kind": "constant", @@ -5922,7 +5922,7 @@ "$id": "558", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "54" }, @@ -5971,7 +5971,7 @@ "$id": "561", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "562", "kind": "url", @@ -6009,7 +6009,7 @@ "$id": "566", "Name": "get", "ResourceName": "UnionStringLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6071,14 +6071,14 @@ "$id": "571", "Name": "put", "ResourceName": "UnionStringLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "572", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "573", "kind": "constant", @@ -6106,7 +6106,7 @@ "$id": "575", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "52" }, @@ -6155,7 +6155,7 @@ "$id": "578", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "579", "kind": "url", @@ -6193,7 +6193,7 @@ "$id": "583", "Name": "get", "ResourceName": "UnionIntLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6255,14 +6255,14 @@ "$id": "588", "Name": "put", "ResourceName": "UnionIntLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "589", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "590", "kind": "constant", @@ -6290,7 +6290,7 @@ "$id": "592", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "50" }, @@ -6339,7 +6339,7 @@ "$id": "595", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "596", "kind": "url", @@ -6377,7 +6377,7 @@ "$id": "600", "Name": "get", "ResourceName": "UnionFloatLiteral", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6439,14 +6439,14 @@ "$id": "605", "Name": "put", "ResourceName": "UnionFloatLiteral", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "606", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "607", "kind": "constant", @@ -6474,7 +6474,7 @@ "$id": "609", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "48" }, @@ -6523,7 +6523,7 @@ "$id": "612", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "613", "kind": "url", @@ -6561,7 +6561,7 @@ "$id": "617", "Name": "get", "ResourceName": "UnionEnumValue", - "Description": "Get call", + "Doc": "Get call", "Accessibility": "public", "Parameters": [ { @@ -6623,14 +6623,14 @@ "$id": "622", "Name": "put", "ResourceName": "UnionEnumValue", - "Description": "Put operation", + "Doc": "Put operation", "Accessibility": "public", "Parameters": [ { "$id": "623", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "624", "kind": "constant", @@ -6658,7 +6658,7 @@ "$id": "626", "Name": "body", "NameInRequest": "body", - "Description": "body", + "Doc": "body", "Type": { "$ref": "45" }, @@ -6707,7 +6707,7 @@ "$id": "629", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "630", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/scalar/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/scalar/tspCodeModel.json index 84a443b23d6..9672651fbc6 100644 --- a/test/CadlRanchProjectsNonAzure/type/scalar/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/scalar/tspCodeModel.json @@ -17,7 +17,7 @@ "$id": "4", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "5", "kind": "url", @@ -55,7 +55,7 @@ "$id": "9", "Name": "get", "ResourceName": "String", - "Description": "get string value", + "Doc": "get string value", "Accessibility": "public", "Parameters": [ { @@ -121,14 +121,14 @@ "$id": "15", "Name": "put", "ResourceName": "String", - "Description": "put string value", + "Doc": "put string value", "Accessibility": "public", "Parameters": [ { "$id": "16", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "17", "kind": "constant", @@ -156,7 +156,7 @@ "$id": "19", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "20", "kind": "string", @@ -209,7 +209,7 @@ "$id": "23", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "24", "kind": "url", @@ -247,7 +247,7 @@ "$id": "28", "Name": "get", "ResourceName": "Boolean", - "Description": "get boolean value", + "Doc": "get boolean value", "Accessibility": "public", "Parameters": [ { @@ -313,14 +313,14 @@ "$id": "34", "Name": "put", "ResourceName": "Boolean", - "Description": "put boolean value", + "Doc": "put boolean value", "Accessibility": "public", "Parameters": [ { "$id": "35", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "36", "kind": "constant", @@ -348,7 +348,7 @@ "$id": "38", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "39", "kind": "boolean", @@ -401,7 +401,7 @@ "$id": "42", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "43", "kind": "url", @@ -439,7 +439,7 @@ "$id": "47", "Name": "get", "ResourceName": "Unknown", - "Description": "get unknown value", + "Doc": "get unknown value", "Accessibility": "public", "Parameters": [ { @@ -505,14 +505,14 @@ "$id": "53", "Name": "put", "ResourceName": "Unknown", - "Description": "put unknown value", + "Doc": "put unknown value", "Accessibility": "public", "Parameters": [ { "$id": "54", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "55", "kind": "constant", @@ -540,7 +540,7 @@ "$id": "57", "Name": "body", "NameInRequest": "body", - "Description": "_", + "Doc": "_", "Type": { "$id": "58", "kind": "unknown", @@ -593,7 +593,7 @@ "$id": "61", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "62", "kind": "url", @@ -626,7 +626,7 @@ { "$id": "65", "Name": "DecimalType", - "Description": "Decimal type", + "Doc": "Decimal type", "Operations": [ { "$id": "66", @@ -703,7 +703,7 @@ "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", @@ -832,7 +832,7 @@ "$id": "84", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "85", "kind": "url", @@ -865,7 +865,7 @@ { "$id": "88", "Name": "Decimal128Type", - "Description": "Decimal128 type", + "Doc": "Decimal128 type", "Operations": [ { "$id": "89", @@ -942,7 +942,7 @@ "$id": "96", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "97", "kind": "constant", @@ -1071,7 +1071,7 @@ "$id": "107", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "108", "kind": "url", @@ -1104,7 +1104,7 @@ { "$id": "111", "Name": "DecimalVerify", - "Description": "Decimal type verification", + "Doc": "Decimal type verification", "Operations": [ { "$id": "112", @@ -1188,7 +1188,7 @@ "$id": "120", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "121", "kind": "constant", @@ -1268,7 +1268,7 @@ "$id": "127", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "128", "kind": "url", @@ -1301,7 +1301,7 @@ { "$id": "131", "Name": "Decimal128Verify", - "Description": "Decimal128 type verification", + "Doc": "Decimal128 type verification", "Operations": [ { "$id": "132", @@ -1385,7 +1385,7 @@ "$id": "140", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "141", "kind": "constant", @@ -1465,7 +1465,7 @@ "$id": "147", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "148", "kind": "url", diff --git a/test/CadlRanchProjectsNonAzure/type/union/tspCodeModel.json b/test/CadlRanchProjectsNonAzure/type/union/tspCodeModel.json index d2537a386a6..00194b00247 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/tspCodeModel.json +++ b/test/CadlRanchProjectsNonAzure/type/union/tspCodeModel.json @@ -487,7 +487,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "This should be receive/send the Cat variant", + "doc": "This should be receive/send the Cat variant", "type": { "$id": "58", "kind": "union", @@ -564,7 +564,7 @@ "kind": "property", "name": "literal", "serializedName": "literal", - "description": "This should be receive/send the \"a\" variant", + "doc": "This should be receive/send the \"a\" variant", "type": { "$ref": "58" }, @@ -580,7 +580,7 @@ "kind": "property", "name": "int", "serializedName": "int", - "description": "This should be receive/send the int variant", + "doc": "This should be receive/send the int variant", "type": { "$ref": "58" }, @@ -596,7 +596,7 @@ "kind": "property", "name": "boolean", "serializedName": "boolean", - "description": "This should be receive/send the boolean variant", + "doc": "This should be receive/send the boolean variant", "type": { "$ref": "58" }, @@ -612,7 +612,7 @@ "kind": "property", "name": "array", "serializedName": "array", - "description": "This should be receive/send 4 element with Cat, \"a\", int, and boolean", + "doc": "This should be receive/send 4 element with Cat, \"a\", int, and boolean", "type": { "$id": "70", "kind": "array", @@ -698,7 +698,7 @@ "kind": "property", "name": "stringLiteral", "serializedName": "stringLiteral", - "description": "This should be receive/send the \"a\" variant", + "doc": "This should be receive/send the \"a\" variant", "type": { "$id": "77", "kind": "union", @@ -771,7 +771,7 @@ "kind": "property", "name": "intLiteral", "serializedName": "intLiteral", - "description": "This should be receive/send the 2 variant", + "doc": "This should be receive/send the 2 variant", "type": { "$ref": "77" }, @@ -787,7 +787,7 @@ "kind": "property", "name": "floatLiteral", "serializedName": "floatLiteral", - "description": "This should be receive/send the 3.3 variant", + "doc": "This should be receive/send the 3.3 variant", "type": { "$ref": "77" }, @@ -803,7 +803,7 @@ "kind": "property", "name": "booleanLiteral", "serializedName": "booleanLiteral", - "description": "This should be receive/send the true variant", + "doc": "This should be receive/send the true variant", "type": { "$ref": "77" }, @@ -879,7 +879,7 @@ "kind": "property", "name": "string", "serializedName": "string", - "description": "This should be receive/send the string variant", + "doc": "This should be receive/send the string variant", "type": { "$id": "95", "kind": "union", @@ -921,7 +921,7 @@ "kind": "property", "name": "array", "serializedName": "array", - "description": "This should be receive/send the array variant", + "doc": "This should be receive/send the array variant", "type": { "$id": "100", "kind": "union", @@ -1023,7 +1023,7 @@ "kind": "property", "name": "lr", "serializedName": "lr", - "description": "This should be receive/send the left variant", + "doc": "This should be receive/send the left variant", "type": { "$ref": "2" }, @@ -1039,7 +1039,7 @@ "kind": "property", "name": "ud", "serializedName": "ud", - "description": "This should be receive/send the up variant", + "doc": "This should be receive/send the up variant", "type": { "$ref": "12" }, @@ -1434,7 +1434,7 @@ { "$id": "141", "Name": "UnionClient", - "Description": "Describe scenarios for various combinations of unions.", + "Doc": "Describe scenarios for various combinations of unions.", "Operations": [], "Protocol": { "$id": "142" @@ -1444,7 +1444,7 @@ "$id": "143", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "144", "kind": "url", @@ -1477,7 +1477,7 @@ { "$id": "147", "Name": "StringsOnly", - "Description": "Describe union of string \"a\" | \"b\" | \"c\"", + "Doc": "Describe union of string \"a\" | \"b\" | \"c\"", "Operations": [ { "$id": "148", @@ -1550,7 +1550,7 @@ "$id": "154", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "155", "kind": "constant", @@ -1626,7 +1626,7 @@ "$id": "160", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "161", "kind": "url", @@ -1659,7 +1659,7 @@ { "$id": "164", "Name": "StringExtensible", - "Description": "Describe union of string string | \"b\" | \"c\"", + "Doc": "Describe union of string string | \"b\" | \"c\"", "Operations": [ { "$id": "165", @@ -1732,7 +1732,7 @@ "$id": "171", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "172", "kind": "constant", @@ -1808,7 +1808,7 @@ "$id": "177", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "178", "kind": "url", @@ -1841,7 +1841,7 @@ { "$id": "181", "Name": "StringExtensibleNamed", - "Description": "Describe union of string string | \"b\" | \"c\" but where the union is named and some of the variants are named", + "Doc": "Describe union of string string | \"b\" | \"c\" but where the union is named and some of the variants are named", "Operations": [ { "$id": "182", @@ -1914,7 +1914,7 @@ "$id": "188", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "189", "kind": "constant", @@ -1990,7 +1990,7 @@ "$id": "194", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "195", "kind": "url", @@ -2023,7 +2023,7 @@ { "$id": "198", "Name": "IntsOnly", - "Description": "Describe union of integer 1 | 2 | 3", + "Doc": "Describe union of integer 1 | 2 | 3", "Operations": [ { "$id": "199", @@ -2096,7 +2096,7 @@ "$id": "205", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "206", "kind": "constant", @@ -2172,7 +2172,7 @@ "$id": "211", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "212", "kind": "url", @@ -2205,7 +2205,7 @@ { "$id": "215", "Name": "FloatsOnly", - "Description": "Describe union of floats 1.1 | 2.2 | 3.3", + "Doc": "Describe union of floats 1.1 | 2.2 | 3.3", "Operations": [ { "$id": "216", @@ -2278,7 +2278,7 @@ "$id": "222", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "223", "kind": "constant", @@ -2354,7 +2354,7 @@ "$id": "228", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "229", "kind": "url", @@ -2387,7 +2387,7 @@ { "$id": "232", "Name": "ModelsOnly", - "Description": "Describe union of models", + "Doc": "Describe union of models", "Operations": [ { "$id": "233", @@ -2460,7 +2460,7 @@ "$id": "239", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "240", "kind": "constant", @@ -2536,7 +2536,7 @@ "$id": "245", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "246", "kind": "url", @@ -2569,7 +2569,7 @@ { "$id": "249", "Name": "EnumsOnly", - "Description": "Describe union of 2 different enums", + "Doc": "Describe union of 2 different enums", "Operations": [ { "$id": "250", @@ -2642,7 +2642,7 @@ "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2718,7 +2718,7 @@ "$id": "262", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "263", "kind": "url", @@ -2751,7 +2751,7 @@ { "$id": "266", "Name": "StringAndArray", - "Description": "Describe union of a string and an array of strings", + "Doc": "Describe union of a string and an array of strings", "Operations": [ { "$id": "267", @@ -2824,7 +2824,7 @@ "$id": "273", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "274", "kind": "constant", @@ -2900,7 +2900,7 @@ "$id": "279", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "280", "kind": "url", @@ -2933,7 +2933,7 @@ { "$id": "283", "Name": "MixedLiterals", - "Description": "Describe union of floats \"a\" | 2 | 3.3", + "Doc": "Describe union of floats \"a\" | 2 | 3.3", "Operations": [ { "$id": "284", @@ -3006,7 +3006,7 @@ "$id": "290", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "291", "kind": "constant", @@ -3082,7 +3082,7 @@ "$id": "296", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "297", "kind": "url", @@ -3115,7 +3115,7 @@ { "$id": "300", "Name": "MixedTypes", - "Description": "Describe union of floats \"a\" | 2 | 3.3", + "Doc": "Describe union of floats \"a\" | 2 | 3.3", "Operations": [ { "$id": "301", @@ -3188,7 +3188,7 @@ "$id": "307", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "308", "kind": "constant", @@ -3264,7 +3264,7 @@ "$id": "313", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "314", "kind": "url", diff --git a/test/TestProjects/Authoring-TypeSpec/tspCodeModel.json b/test/TestProjects/Authoring-TypeSpec/tspCodeModel.json index fac06d747ee..38a028916d3 100644 --- a/test/TestProjects/Authoring-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/Authoring-TypeSpec/tspCodeModel.json @@ -138,7 +138,7 @@ "decorators": [] } ], - "description": "Represents the job status values.", + "doc": "Represents the job status values.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -172,7 +172,7 @@ "enumType": { "$ref": "18" }, - "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B.", + "doc": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B.", "decorators": [] }, { @@ -190,7 +190,7 @@ "enumType": { "$ref": "18" }, - "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C.", + "doc": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C.", "decorators": [] }, { @@ -208,11 +208,11 @@ "enumType": { "$ref": "18" }, - "description": "For building an extraction model to identify your domain categories using your own data.", + "doc": "For building an extraction model to identify your domain categories using your own data.", "decorators": [] } ], - "description": "Represents the project kind.", + "doc": "Represents the project kind.", "isFixed": false, "isFlags": false, "usage": "Json", @@ -282,7 +282,7 @@ "enumType": { "$ref": "30" }, - "description": "The operation has not started.", + "doc": "The operation has not started.", "decorators": [] }, { @@ -300,7 +300,7 @@ "enumType": { "$ref": "30" }, - "description": "The operation is in progress.", + "doc": "The operation is in progress.", "decorators": [] }, { @@ -318,7 +318,7 @@ "enumType": { "$ref": "30" }, - "description": "The operation has completed successfully.", + "doc": "The operation has completed successfully.", "decorators": [] }, { @@ -336,7 +336,7 @@ "enumType": { "$ref": "30" }, - "description": "The operation has failed.", + "doc": "The operation has failed.", "decorators": [] }, { @@ -354,11 +354,11 @@ "enumType": { "$ref": "30" }, - "description": "The operation has been canceled by the user.", + "doc": "The operation has been canceled by the user.", "decorators": [] } ], - "description": "Enum describing allowed operation states.", + "doc": "Enum describing allowed operation states.", "isFixed": false, "isFlags": false, "usage": "Json", @@ -372,7 +372,7 @@ "name": "SupportedLanguages", "crossLanguageDefinitionId": "AuthoringTypeSpec.SupportedLanguages", "usage": "Json", - "description": "Paged collection of SupportedLanguage items", + "doc": "Paged collection of SupportedLanguage items", "decorators": [], "properties": [ { @@ -380,7 +380,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The SupportedLanguage items on this page", + "doc": "The SupportedLanguage items on this page", "type": { "$id": "44", "kind": "array", @@ -391,7 +391,7 @@ "name": "SupportedLanguage", "crossLanguageDefinitionId": "AuthoringTypeSpec.SupportedLanguage", "usage": "Json", - "description": "Represents a supported language.", + "doc": "Represents a supported language.", "decorators": [], "properties": [ { @@ -399,7 +399,7 @@ "kind": "property", "name": "languageName", "serializedName": "languageName", - "description": "The language name.", + "doc": "The language name.", "type": { "$id": "47", "kind": "string", @@ -419,7 +419,7 @@ "kind": "property", "name": "languageCode", "serializedName": "languageCode", - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "doc": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", "type": { "$id": "49", "kind": "string", @@ -451,7 +451,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "51", "kind": "url", @@ -484,7 +484,7 @@ "name": "TrainingConfigVersions", "crossLanguageDefinitionId": "AuthoringTypeSpec.TrainingConfigVersions", "usage": "Json", - "description": "Paged collection of TrainingConfigVersion items", + "doc": "Paged collection of TrainingConfigVersion items", "decorators": [], "properties": [ { @@ -492,7 +492,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The TrainingConfigVersion items on this page", + "doc": "The TrainingConfigVersion items on this page", "type": { "$id": "55", "kind": "array", @@ -503,7 +503,7 @@ "name": "TrainingConfigVersion", "crossLanguageDefinitionId": "AuthoringTypeSpec.TrainingConfigVersion", "usage": "Json", - "description": "Represents a training config version.", + "doc": "Represents a training config version.", "decorators": [], "properties": [ { @@ -511,7 +511,7 @@ "kind": "property", "name": "trainingConfigVersionStr", "serializedName": "trainingConfigVersionStr", - "description": "Represents the version of the config.", + "doc": "Represents the version of the config.", "type": { "$id": "58", "kind": "string", @@ -531,7 +531,7 @@ "kind": "property", "name": "modelExpirationDate", "serializedName": "modelExpirationDate", - "description": "Represents the training config version expiration date.", + "doc": "Represents the training config version expiration date.", "type": { "$id": "60", "kind": "plainDate", @@ -563,7 +563,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "62", "kind": "url", @@ -603,7 +603,7 @@ "kind": "property", "name": "jobId", "serializedName": "jobId", - "description": "The job ID.", + "doc": "The job ID.", "type": { "$id": "66", "kind": "string", @@ -623,7 +623,7 @@ "kind": "property", "name": "createdDateTime", "serializedName": "createdDateTime", - "description": "The creation date time of the job.", + "doc": "The creation date time of the job.", "type": { "$id": "68", "kind": "utcDateTime", @@ -651,7 +651,7 @@ "kind": "property", "name": "lastUpdatedDateTime", "serializedName": "lastUpdatedDateTime", - "description": "The the last date time the job was updated.", + "doc": "The the last date time the job was updated.", "type": { "$id": "71", "kind": "utcDateTime", @@ -679,7 +679,7 @@ "kind": "property", "name": "expirationDateTime", "serializedName": "expirationDateTime", - "description": "The expiration date time of the job.", + "doc": "The expiration date time of the job.", "type": { "$id": "74", "kind": "utcDateTime", @@ -707,7 +707,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The job status.", + "doc": "The job status.", "type": { "$ref": "2" }, @@ -723,7 +723,7 @@ "kind": "property", "name": "warnings", "serializedName": "warnings", - "description": "The warnings that were encountered while executing the job.", + "doc": "The warnings that were encountered while executing the job.", "type": { "$id": "78", "kind": "array", @@ -734,7 +734,7 @@ "name": "JobWarning", "crossLanguageDefinitionId": "AuthoringTypeSpec.JobWarning", "usage": "Output,Json", - "description": "Represents a warning that was encountered while executing the request.", + "doc": "Represents a warning that was encountered while executing the request.", "decorators": [], "properties": [ { @@ -742,7 +742,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The warning code.", + "doc": "The warning code.", "type": { "$id": "81", "kind": "string", @@ -762,7 +762,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The warning message.", + "doc": "The warning message.", "type": { "$id": "83", "kind": "string", @@ -794,14 +794,14 @@ "kind": "property", "name": "errors", "serializedName": "errors", - "description": "The errors encountered while executing the job.", + "doc": "The errors encountered while executing the job.", "type": { "$id": "85", "kind": "model", "name": "Error", "crossLanguageDefinitionId": "Azure.Core.Foundations.Error", "usage": "Output,Json", - "description": "The error object.", + "doc": "The error object.", "decorators": [], "properties": [ { @@ -809,7 +809,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "87", "kind": "string", @@ -829,7 +829,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A human-readable representation of the error.", + "doc": "A human-readable representation of the error.", "type": { "$id": "89", "kind": "string", @@ -849,7 +849,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The target of the error.", + "doc": "The target of the error.", "type": { "$id": "91", "kind": "string", @@ -869,7 +869,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "An array of details about specific errors that led to this reported error.", + "doc": "An array of details about specific errors that led to this reported error.", "type": { "$id": "93", "kind": "array", @@ -892,14 +892,14 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "An object containing more specific information than the current object about the error.", + "doc": "An object containing more specific information than the current object about the error.", "type": { "$id": "95", "kind": "model", "name": "InnerError", "crossLanguageDefinitionId": "Azure.Core.Foundations.InnerError", "usage": "Output,Json", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "doc": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "decorators": [], "properties": [ { @@ -907,7 +907,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "97", "kind": "string", @@ -927,7 +927,7 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "Inner error.", + "doc": "Inner error.", "type": { "$ref": "95" }, @@ -999,7 +999,7 @@ "kind": "property", "name": "jobId", "serializedName": "jobId", - "description": "The job ID.", + "doc": "The job ID.", "type": { "$id": "103", "kind": "string", @@ -1019,7 +1019,7 @@ "kind": "property", "name": "createdDateTime", "serializedName": "createdDateTime", - "description": "The creation date time of the job.", + "doc": "The creation date time of the job.", "type": { "$id": "105", "kind": "utcDateTime", @@ -1047,7 +1047,7 @@ "kind": "property", "name": "lastUpdatedDateTime", "serializedName": "lastUpdatedDateTime", - "description": "The the last date time the job was updated.", + "doc": "The the last date time the job was updated.", "type": { "$id": "108", "kind": "utcDateTime", @@ -1075,7 +1075,7 @@ "kind": "property", "name": "expirationDateTime", "serializedName": "expirationDateTime", - "description": "The expiration date time of the job.", + "doc": "The expiration date time of the job.", "type": { "$id": "111", "kind": "utcDateTime", @@ -1103,7 +1103,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The job status.", + "doc": "The job status.", "type": { "$ref": "2" }, @@ -1119,7 +1119,7 @@ "kind": "property", "name": "warnings", "serializedName": "warnings", - "description": "The warnings that were encountered while executing the job.", + "doc": "The warnings that were encountered while executing the job.", "type": { "$id": "115", "kind": "array", @@ -1142,7 +1142,7 @@ "kind": "property", "name": "errors", "serializedName": "errors", - "description": "The errors encountered while executing the job.", + "doc": "The errors encountered while executing the job.", "type": { "$ref": "85" }, @@ -1235,7 +1235,7 @@ "kind": "property", "name": "projectKind", "serializedName": "projectKind", - "description": "The project kind.", + "doc": "The project kind.", "type": { "$ref": "18" }, @@ -1251,7 +1251,7 @@ "kind": "property", "name": "storageInputContainerName", "serializedName": "storageInputContainerName", - "description": "The storage container name.", + "doc": "The storage container name.", "type": { "$id": "127", "kind": "string", @@ -1271,14 +1271,14 @@ "kind": "property", "name": "settings", "serializedName": "settings", - "description": "The project settings.", + "doc": "The project settings.", "type": { "$id": "129", "kind": "model", "name": "ProjectSettings", "crossLanguageDefinitionId": "AuthoringTypeSpec.ProjectSettings", "usage": "Json", - "description": "Represents the settings used to define the project behavior.", + "doc": "Represents the settings used to define the project behavior.", "decorators": [], "additionalProperties": { "$id": "130", @@ -1301,7 +1301,7 @@ "kind": "property", "name": "multilingual", "serializedName": "multilingual", - "description": "Whether the project would be used for multiple languages or not.", + "doc": "Whether the project would be used for multiple languages or not.", "type": { "$id": "132", "kind": "boolean", @@ -1321,7 +1321,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "The project description.", + "doc": "The project description.", "type": { "$id": "134", "kind": "string", @@ -1341,7 +1341,7 @@ "kind": "property", "name": "language", "serializedName": "language", - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "doc": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", "type": { "$id": "136", "kind": "string", @@ -1361,7 +1361,7 @@ "kind": "property", "name": "createdDateTime", "serializedName": "createdDateTime", - "description": "Represents the project creation datetime.", + "doc": "Represents the project creation datetime.", "type": { "$id": "138", "kind": "utcDateTime", @@ -1389,7 +1389,7 @@ "kind": "property", "name": "lastModifiedDateTime", "serializedName": "lastModifiedDateTime", - "description": "Represents the project last modification datetime.", + "doc": "Represents the project last modification datetime.", "type": { "$id": "141", "kind": "utcDateTime", @@ -1417,7 +1417,7 @@ "kind": "property", "name": "lastTrainedDateTime", "serializedName": "lastTrainedDateTime", - "description": "Represents the project last training datetime.", + "doc": "Represents the project last training datetime.", "type": { "$id": "144", "kind": "utcDateTime", @@ -1445,7 +1445,7 @@ "kind": "property", "name": "lastDeployedDateTime", "serializedName": "lastDeployedDateTime", - "description": "Represents the project last deployment datetime.", + "doc": "Represents the project last deployment datetime.", "type": { "$id": "147", "kind": "utcDateTime", @@ -1479,7 +1479,7 @@ "name": "OperationStatusError", "crossLanguageDefinitionId": "Azure.Core.Foundations.OperationStatus", "usage": "Json", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -1487,7 +1487,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "151", "kind": "string", @@ -1507,7 +1507,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "30" }, @@ -1523,7 +1523,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$ref": "85" }, @@ -1542,7 +1542,7 @@ "name": "PagedProject", "crossLanguageDefinitionId": "Azure.Core.Foundations.CustomPage", "usage": "Json", - "description": "Paged collection of Project items", + "doc": "Paged collection of Project items", "decorators": [], "properties": [ { @@ -1550,7 +1550,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The Project items on this page", + "doc": "The Project items on this page", "type": { "$id": "156", "kind": "array", @@ -1573,7 +1573,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "158", "kind": "url", @@ -1603,7 +1603,7 @@ "name": "TrainingJobOptions", "crossLanguageDefinitionId": "AuthoringTypeSpec.TrainingJobOptions", "usage": "None", - "description": "Training job parameters.", + "doc": "Training job parameters.", "decorators": [], "properties": [ { @@ -1633,7 +1633,7 @@ "name": "PagedDeployment", "crossLanguageDefinitionId": "Azure.Core.Foundations.CustomPage", "usage": "Json", - "description": "Paged collection of Deployment items", + "doc": "Paged collection of Deployment items", "decorators": [], "properties": [ { @@ -1641,7 +1641,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The Deployment items on this page", + "doc": "The Deployment items on this page", "type": { "$id": "165", "kind": "array", @@ -1664,7 +1664,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "167", "kind": "url", @@ -1701,7 +1701,7 @@ "kind": "property", "name": "firstDeploymentName", "serializedName": "firstDeploymentName", - "description": "Represents the first deployment name.", + "doc": "Represents the first deployment name.", "type": { "$id": "171", "kind": "string", @@ -1721,7 +1721,7 @@ "kind": "property", "name": "secondDeploymentName", "serializedName": "secondDeploymentName", - "description": "Represents the second deployment name.", + "doc": "Represents the second deployment name.", "type": { "$id": "173", "kind": "string", @@ -1779,14 +1779,14 @@ "$id": "179", "Name": "createOrUpdate", "ResourceName": "Project", - "Description": "Creates a new project or updates an existing one.", + "Doc": "Creates a new project or updates an existing one.", "Accessibility": "public", "Parameters": [ { "$id": "180", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "181", "kind": "string", @@ -1839,7 +1839,7 @@ "$id": "186", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "187", "kind": "constant", @@ -1894,7 +1894,7 @@ "$id": "192", "Name": "resource", "NameInRequest": "resource", - "Description": "The resource instance.", + "Doc": "The resource instance.", "Type": { "$ref": "122" }, @@ -1924,7 +1924,7 @@ "$id": "194", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "195", "kind": "url", @@ -1960,7 +1960,7 @@ "$id": "198", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "199", "kind": "url", @@ -2014,14 +2014,14 @@ "$id": "203", "Name": "get", "ResourceName": "Project", - "Description": "Gets the details of a project.", + "Doc": "Gets the details of a project.", "Accessibility": "public", "Parameters": [ { "$id": "204", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "205", "kind": "string", @@ -2129,14 +2129,14 @@ "$id": "214", "Name": "delete", "ResourceName": "Project", - "Description": "Deletes a project.", + "Doc": "Deletes a project.", "Accessibility": "public", "Parameters": [ { "$id": "215", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "216", "kind": "string", @@ -2228,7 +2228,7 @@ "$id": "225", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "226", "kind": "url", @@ -2276,14 +2276,14 @@ "$id": "230", "Name": "list", "ResourceName": "Project", - "Description": "Lists the existing projects.", + "Doc": "Lists the existing projects.", "Accessibility": "public", "Parameters": [ { "$id": "231", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "232", "kind": "string", @@ -2375,14 +2375,14 @@ "$id": "240", "Name": "export", "ResourceName": "Projects", - "Description": "Triggers a job to export a project's data.", + "Doc": "Triggers a job to export a project's data.", "Accessibility": "public", "Parameters": [ { "$id": "241", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "242", "kind": "string", @@ -2492,7 +2492,7 @@ "$id": "253", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "254", "kind": "url", @@ -2537,14 +2537,14 @@ "$id": "258", "Name": "importx", "ResourceName": "Projects", - "Description": "Triggers a job to export a project's data.", + "Doc": "Triggers a job to export a project's data.", "Accessibility": "public", "Parameters": [ { "$id": "259", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "260", "kind": "string", @@ -2633,7 +2633,7 @@ "$id": "269", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "270", "kind": "url", @@ -2678,14 +2678,14 @@ "$id": "274", "Name": "train", "ResourceName": "Projects", - "Description": "Triggers a training job for a project.", + "Doc": "Triggers a training job for a project.", "Accessibility": "public", "Parameters": [ { "$id": "275", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "276", "kind": "string", @@ -2738,7 +2738,7 @@ "$id": "281", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "282", "kind": "constant", @@ -2819,7 +2819,7 @@ "$id": "289", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "290", "kind": "url", @@ -2900,14 +2900,14 @@ "$id": "298", "Name": "getDeployment", "ResourceName": "Deployment", - "Description": "Gets the details of a deployment.", + "Doc": "Gets the details of a deployment.", "Accessibility": "public", "Parameters": [ { "$id": "299", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "300", "kind": "string", @@ -3036,14 +3036,14 @@ "$id": "311", "Name": "deployProject", "ResourceName": "Deployment", - "Description": "Creates a new deployment or replaces an existing one.", + "Doc": "Creates a new deployment or replaces an existing one.", "Accessibility": "public", "Parameters": [ { "$id": "312", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "313", "kind": "string", @@ -3117,7 +3117,7 @@ "$id": "320", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "321", "kind": "constant", @@ -3172,7 +3172,7 @@ "$id": "326", "Name": "resource", "NameInRequest": "resource", - "Description": "The resource instance.", + "Doc": "The resource instance.", "Type": { "$ref": "119" }, @@ -3202,7 +3202,7 @@ "$id": "328", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "329", "kind": "url", @@ -3238,7 +3238,7 @@ "$id": "332", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "333", "kind": "url", @@ -3292,14 +3292,14 @@ "$id": "337", "Name": "deleteDeployment", "ResourceName": "Deployment", - "Description": "Deletes a project deployment.", + "Doc": "Deletes a project deployment.", "Accessibility": "public", "Parameters": [ { "$id": "338", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "339", "kind": "string", @@ -3412,7 +3412,7 @@ "$id": "350", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "351", "kind": "url", @@ -3460,14 +3460,14 @@ "$id": "355", "Name": "list", "ResourceName": "Deployment", - "Description": "Lists the existing deployments.", + "Doc": "Lists the existing deployments.", "Accessibility": "public", "Parameters": [ { "$id": "356", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "357", "kind": "string", @@ -3580,14 +3580,14 @@ "$id": "367", "Name": "swapDeployments", "ResourceName": "Deployments", - "Description": "Swaps two existing deployments with each other.", + "Doc": "Swaps two existing deployments with each other.", "Accessibility": "public", "Parameters": [ { "$id": "368", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "369", "kind": "string", @@ -3640,7 +3640,7 @@ "$id": "374", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "375", "kind": "constant", @@ -3695,7 +3695,7 @@ "$id": "380", "Name": "body", "NameInRequest": "body", - "Description": "The body schema of the operation.", + "Doc": "The body schema of the operation.", "Type": { "$ref": "169" }, @@ -3722,7 +3722,7 @@ "$id": "382", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "383", "kind": "url", @@ -3803,14 +3803,14 @@ "$id": "391", "Name": "getDeploymentStatus", "ResourceName": "DeploymentJob", - "Description": "Gets the status of an existing deployment job.", + "Doc": "Gets the status of an existing deployment job.", "Accessibility": "public", "Parameters": [ { "$id": "392", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "393", "kind": "string", @@ -3960,14 +3960,14 @@ "$id": "406", "Name": "getSwapDeploymentsStatus", "ResourceName": "SwapDeploymentsJob", - "Description": "Gets the status of an existing swap deployment job.", + "Doc": "Gets the status of an existing swap deployment job.", "Accessibility": "public", "Parameters": [ { "$id": "407", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "408", "kind": "string", @@ -4219,7 +4219,7 @@ "$id": "432", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "433", "kind": "string", @@ -4380,7 +4380,7 @@ "$id": "448", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "449", "kind": "string", diff --git a/test/TestProjects/ConvenienceUpdate-TypeSpec/tspCodeModel.json b/test/TestProjects/ConvenienceUpdate-TypeSpec/tspCodeModel.json index 188d07a4ad0..98d2e926cc1 100644 --- a/test/TestProjects/ConvenienceUpdate-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/ConvenienceUpdate-TypeSpec/tspCodeModel.json @@ -10,7 +10,7 @@ "name": "Model", "crossLanguageDefinitionId": "ConvenienceInCadl.Model", "usage": "Input,Output,Json", - "description": "A model.", + "doc": "A model.", "decorators": [], "properties": [ { @@ -39,13 +39,13 @@ { "$id": "5", "Name": "ConvenienceInCadlClient", - "Description": "Typespec project to test various types of convenience methods.", + "Doc": "Typespec project to test various types of convenience methods.", "Operations": [ { "$id": "6", "Name": "updateConvenience", "ResourceName": "ConvenienceInCadl", - "Description": "No initial operation methods. In the updated version, we add the protocol method and convenience method.", + "Doc": "No initial operation methods. In the updated version, we add the protocol method and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -107,7 +107,7 @@ "$id": "11", "Name": "convenienceOptionalBeforeRequired", "ResourceName": "ConvenienceInCadl", - "Description": "No initial operation methods. In the updated version, we add the protocol method and convenience method.", + "Doc": "No initial operation methods. In the updated version, we add the protocol method and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -135,7 +135,7 @@ "$id": "14", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "15", "kind": "constant", @@ -205,7 +205,7 @@ "$id": "19", "Name": "noConvenience", "ResourceName": "ConvenienceInCadl", - "Description": "No convenience method. But if we add the convenientAPI decorator, there will be ambiguity.", + "Doc": "No convenience method. But if we add the convenientAPI decorator, there will be ambiguity.", "Accessibility": "public", "Parameters": [ { @@ -267,14 +267,14 @@ "$id": "24", "Name": "noConvenienceRequiredBody", "ResourceName": "ConvenienceInCadl", - "Description": "No convenience method. But if we add the convenientAPI decorator, there will be no ambiguity.", + "Doc": "No convenience method. But if we add the convenientAPI decorator, there will be no ambiguity.", "Accessibility": "public", "Parameters": [ { "$id": "25", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "26", "kind": "constant", @@ -344,14 +344,14 @@ "$id": "30", "Name": "noConvenienceOptionalBody", "ResourceName": "ConvenienceInCadl", - "Description": "No convenience method. But if we add the convenientAPI decorator, there will be ambiguity.", + "Doc": "No convenience method. But if we add the convenientAPI decorator, there will be ambiguity.", "Accessibility": "public", "Parameters": [ { "$id": "31", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "32", "kind": "constant", @@ -421,7 +421,7 @@ "$id": "36", "Name": "protocol", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method. In the updated version, we add the convenience method.", + "Doc": "Initial operation only has protocol method. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { @@ -483,7 +483,7 @@ "$id": "41", "Name": "convenienceWithOptional", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with optional RequestContext and convenience method.", + "Doc": "Operation has protocol method with optional RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -545,7 +545,7 @@ "$id": "46", "Name": "convenienceWithRequired", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with required RequestContext and convenience method.", + "Doc": "Operation has protocol method with required RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -607,7 +607,7 @@ "$id": "51", "Name": "convenienceShouldNotGenerate", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method marked with convenience method, but the convenience method should not be generated.", + "Doc": "Operation has protocol method marked with convenience method, but the convenience method should not be generated.", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -635,7 +635,7 @@ "$id": "53", "Name": "protocolShouldNotGenerateConvenience", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method, but the convenience method should not be generated even it marks the convenience decorator.", + "Doc": "Initial operation only has protocol method, but the convenience method should not be generated even it marks the convenience decorator.", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -663,7 +663,7 @@ "$id": "55", "Name": "protocolOptionalQuery", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method with optional query parameter. In the updated version, we add the convenience method.", + "Doc": "Initial operation only has protocol method with optional query parameter. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { @@ -746,7 +746,7 @@ "$id": "62", "Name": "protocolRequiredQuery", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method with required query parameter. In the updated version, we add the convenience method.", + "Doc": "Initial operation only has protocol method with required query parameter. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { @@ -829,14 +829,14 @@ "$id": "69", "Name": "protocolOptionalModel", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method with optional model parameter. In the updated version, we add the convenience method.", + "Doc": "Initial operation only has protocol method with optional model parameter. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { "$id": "70", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "71", "kind": "constant", @@ -906,14 +906,14 @@ "$id": "75", "Name": "protocolRequiredModel", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation only has protocol method with required model parameter. In the updated version, we add the convenience method.", + "Doc": "Initial operation only has protocol method with required model parameter. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { "$id": "76", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "77", "kind": "constant", @@ -983,7 +983,7 @@ "$id": "81", "Name": "convenienceOptionalQueryWithOptional", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with optional query parameter and optional RequestContext and convenience method.", + "Doc": "Operation has protocol method with optional query parameter and optional RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -1066,7 +1066,7 @@ "$id": "88", "Name": "convenienceRequiredQueryWithOptional", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with required query parameter and optional RequestContext and convenience method.", + "Doc": "Operation has protocol method with required query parameter and optional RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -1149,7 +1149,7 @@ "$id": "95", "Name": "convenienceOptionalQueryWithRequired", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with optional query parameter and required RequestContext and convenience method.", + "Doc": "Operation has protocol method with optional query parameter and required RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -1232,7 +1232,7 @@ "$id": "102", "Name": "convenienceRequiredQueryWithRequired", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with required query parameter and required RequestContext and convenience method.", + "Doc": "Operation has protocol method with required query parameter and required RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { @@ -1315,14 +1315,14 @@ "$id": "109", "Name": "convenienceOptionalModelWithOptional", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with optional body parameter and optional RequestContext and convenience method.", + "Doc": "Operation has protocol method with optional body parameter and optional RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { "$id": "110", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "111", "kind": "constant", @@ -1392,14 +1392,14 @@ "$id": "115", "Name": "convenienceRequiredModelWithOptional", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with required body parameter and optional RequestContext and convenience method.", + "Doc": "Operation has protocol method with required body parameter and optional RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { "$id": "116", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "117", "kind": "constant", @@ -1469,14 +1469,14 @@ "$id": "121", "Name": "convenienceOptionalModelWithRequired", "ResourceName": "ConvenienceInCadl", - "Description": "Operation has protocol method with optional body parameter and required RequestContext and convenience method.", + "Doc": "Operation has protocol method with optional body parameter and required RequestContext and convenience method.", "Accessibility": "public", "Parameters": [ { "$id": "122", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "123", "kind": "constant", @@ -1546,7 +1546,7 @@ "$id": "127", "Name": "protocolOptionalBeforeRequired", "ResourceName": "ConvenienceInCadl", - "Description": "Initial operation has protocol method with optioanl parameter before required parameter. In the updated version, we add the convenience method.", + "Doc": "Initial operation has protocol method with optioanl parameter before required parameter. In the updated version, we add the convenience method.", "Accessibility": "public", "Parameters": [ { @@ -1574,7 +1574,7 @@ "$id": "130", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "131", "kind": "constant", @@ -1649,7 +1649,7 @@ "$id": "136", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "137", "kind": "url", diff --git a/test/TestProjects/Customizations-TypeSpec/tspCodeModel.json b/test/TestProjects/Customizations-TypeSpec/tspCodeModel.json index 4b373aed35b..699899ce275 100644 --- a/test/TestProjects/Customizations-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/Customizations-TypeSpec/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "Monday.", + "doc": "Monday.", "decorators": [] }, { @@ -49,11 +49,11 @@ "enumType": { "$ref": "2" }, - "description": "Tuesday.", + "doc": "Tuesday.", "decorators": [] } ], - "description": "Extensible enum to customize operator", + "doc": "Extensible enum to customize operator", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -124,7 +124,7 @@ "decorators": [] } ], - "description": "Renamed enum (original name: EnumToRename)", + "doc": "Renamed enum (original name: EnumToRename)", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -195,7 +195,7 @@ "decorators": [] } ], - "description": "Enum with renamed value (original name: ValueToRename)", + "doc": "Enum with renamed value (original name: ValueToRename)", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -266,7 +266,7 @@ "decorators": [] } ], - "description": "Extensible enum", + "doc": "Extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -320,7 +320,7 @@ "decorators": [] } ], - "description": "A normal enum", + "doc": "A normal enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -334,7 +334,7 @@ "name": "RootModel", "crossLanguageDefinitionId": "CustomizationsInTsp.RootModel", "usage": "Input,Output,Json", - "description": "Root RoundTrip model to reference all other types to ensure generation", + "doc": "Root RoundTrip model to reference all other types to ensure generation", "decorators": [], "properties": [ { @@ -342,7 +342,7 @@ "kind": "property", "name": "propertyExtensibleEnum", "serializedName": "propertyExtensibleEnum", - "description": "ExtensibleEnumWithOperator", + "doc": "ExtensibleEnumWithOperator", "type": { "$ref": "2" }, @@ -358,14 +358,14 @@ "kind": "property", "name": "propertyModelToMakeInternal", "serializedName": "propertyModelToMakeInternal", - "description": "ModelToMakeInternal", + "doc": "ModelToMakeInternal", "type": { "$id": "41", "kind": "model", "name": "ModelToMakeInternal", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelToMakeInternal", "usage": "Input,Output,Json", - "description": "Public model made internal", + "doc": "Public model made internal", "decorators": [], "properties": [ { @@ -373,7 +373,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int", + "doc": "Required int", "type": { "$id": "43", "kind": "int32", @@ -402,14 +402,14 @@ "kind": "property", "name": "propertyModelToRename", "serializedName": "propertyModelToRename", - "description": "ModelToRename", + "doc": "ModelToRename", "type": { "$id": "45", "kind": "model", "name": "ModelToRename", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelToRename", "usage": "Input,Output,Spread,Json", - "description": "Renamed model (original name: ModelToRename)", + "doc": "Renamed model (original name: ModelToRename)", "decorators": [], "properties": [ { @@ -417,7 +417,7 @@ "kind": "property", "name": "requiredIntOnBase", "serializedName": "requiredIntOnBase", - "description": "Required int", + "doc": "Required int", "type": { "$id": "47", "kind": "int32", @@ -437,7 +437,7 @@ "kind": "property", "name": "optionalInt", "serializedName": "optionalInt", - "description": "Optional int", + "doc": "Optional int", "type": { "$id": "49", "kind": "int32", @@ -466,14 +466,14 @@ "kind": "property", "name": "propertyModelToChangeNamespace", "serializedName": "propertyModelToChangeNamespace", - "description": "ModelToChangeNamespace", + "doc": "ModelToChangeNamespace", "type": { "$id": "51", "kind": "model", "name": "ModelToChangeNamespace", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelToChangeNamespace", "usage": "Input,Output,Json", - "description": "Model moved into custom namespace", + "doc": "Model moved into custom namespace", "decorators": [], "properties": [ { @@ -481,7 +481,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int", + "doc": "Required int", "type": { "$id": "53", "kind": "int32", @@ -510,14 +510,14 @@ "kind": "property", "name": "propertyModelWithCustomizedProperties", "serializedName": "propertyModelWithCustomizedProperties", - "description": "ModelWithCustomizedProperties", + "doc": "ModelWithCustomizedProperties", "type": { "$id": "55", "kind": "model", "name": "ModelWithCustomizedProperties", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelWithCustomizedProperties", "usage": "Input,Output,Json", - "description": "Model with customized properties", + "doc": "Model with customized properties", "decorators": [], "properties": [ { @@ -525,7 +525,7 @@ "kind": "property", "name": "propertyToMakeInternal", "serializedName": "propertyToMakeInternal", - "description": "Public property made internal", + "doc": "Public property made internal", "type": { "$id": "57", "kind": "int32", @@ -545,7 +545,7 @@ "kind": "property", "name": "propertyToRename", "serializedName": "propertyToRename", - "description": "Renamed property (original name: PropertyToRename)", + "doc": "Renamed property (original name: PropertyToRename)", "type": { "$id": "59", "kind": "int32", @@ -565,7 +565,7 @@ "kind": "property", "name": "propertyToMakeFloat", "serializedName": "propertyToMakeFloat", - "description": "Property with type changed to float (original type: int)", + "doc": "Property with type changed to float (original type: int)", "type": { "$id": "61", "kind": "int32", @@ -585,7 +585,7 @@ "kind": "property", "name": "propertyToMakeInt", "serializedName": "propertyToMakeInt", - "description": "Property with type changed to int (original type: float)", + "doc": "Property with type changed to int (original type: float)", "type": { "$id": "63", "kind": "float32", @@ -605,7 +605,7 @@ "kind": "property", "name": "propertyToMakeDuration", "serializedName": "propertyToMakeDuration", - "description": "Property with type changed to duration (original type: string)", + "doc": "Property with type changed to duration (original type: string)", "type": { "$id": "65", "kind": "string", @@ -625,7 +625,7 @@ "kind": "property", "name": "propertyToMakeString", "serializedName": "propertyToMakeString", - "description": "Property with type changed to string (original type: duration)", + "doc": "Property with type changed to string (original type: duration)", "type": { "$id": "67", "kind": "duration", @@ -653,7 +653,7 @@ "kind": "property", "name": "propertyToMakeJsonElement", "serializedName": "propertyToMakeJsonElement", - "description": "Property with type changed to JsonElement (original type: string)", + "doc": "Property with type changed to JsonElement (original type: string)", "type": { "$id": "70", "kind": "string", @@ -673,7 +673,7 @@ "kind": "property", "name": "propertyToField", "serializedName": "propertyToField", - "description": "Field that replaces property (original name: PropertyToField)", + "doc": "Field that replaces property (original name: PropertyToField)", "type": { "$id": "72", "kind": "string", @@ -693,7 +693,7 @@ "kind": "property", "name": "badListName", "serializedName": "badListName", - "description": "Property renamed that is list", + "doc": "Property renamed that is list", "type": { "$id": "74", "kind": "array", @@ -720,7 +720,7 @@ "kind": "property", "name": "badDictionaryName", "serializedName": "badDictionaryName", - "description": "Property renamed that is dictionary", + "doc": "Property renamed that is dictionary", "type": { "$id": "77", "kind": "dict", @@ -752,7 +752,7 @@ "kind": "property", "name": "badListOfListName", "serializedName": "badListOfListName", - "description": "Property renamed that is listoflist", + "doc": "Property renamed that is listoflist", "type": { "$id": "81", "kind": "array", @@ -786,7 +786,7 @@ "kind": "property", "name": "badListOfDictionaryName", "serializedName": "badListOfDictionaryName", - "description": "Property renamed that is listofdictionary", + "doc": "Property renamed that is listofdictionary", "type": { "$id": "85", "kind": "array", @@ -825,7 +825,7 @@ "kind": "property", "name": "vector", "serializedName": "vector", - "description": "Property type changed to ReadOnlyMemory", + "doc": "Property type changed to ReadOnlyMemory", "type": { "$id": "90", "kind": "array", @@ -852,7 +852,7 @@ "kind": "property", "name": "vectorOptional", "serializedName": "vectorOptional", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "93", "kind": "array", @@ -879,7 +879,7 @@ "kind": "property", "name": "vectorNullable", "serializedName": "vectorNullable", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "96", "kind": "nullable", @@ -910,7 +910,7 @@ "kind": "property", "name": "vectorOptionalNullable", "serializedName": "vectorOptionalNullable", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "100", "kind": "nullable", @@ -941,7 +941,7 @@ "kind": "property", "name": "vectorReadOnly", "serializedName": "vectorReadOnly", - "description": "Property type changed to ReadOnlyMemory", + "doc": "Property type changed to ReadOnlyMemory", "type": { "$id": "104", "kind": "array", @@ -968,7 +968,7 @@ "kind": "property", "name": "vectorOptionalReadOnly", "serializedName": "vectorOptionalReadOnly", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "107", "kind": "array", @@ -995,7 +995,7 @@ "kind": "property", "name": "vectorNullableReadOnly", "serializedName": "vectorNullableReadOnly", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "110", "kind": "nullable", @@ -1026,7 +1026,7 @@ "kind": "property", "name": "vectorOptionalNullableReadOnly", "serializedName": "vectorOptionalNullableReadOnly", - "description": "Property type changed to ReadOnlyMemory?", + "doc": "Property type changed to ReadOnlyMemory?", "type": { "$id": "114", "kind": "nullable", @@ -1066,7 +1066,7 @@ "kind": "property", "name": "propertyEnumToRename", "serializedName": "propertyEnumToRename", - "description": "EnumToRename", + "doc": "EnumToRename", "type": { "$ref": "8" }, @@ -1082,7 +1082,7 @@ "kind": "property", "name": "propertyEnumWithValueToRename", "serializedName": "propertyEnumWithValueToRename", - "description": "EnumWithValueToRename", + "doc": "EnumWithValueToRename", "type": { "$ref": "16" }, @@ -1098,7 +1098,7 @@ "kind": "property", "name": "propertyEnumToBeMadeExtensible", "serializedName": "propertyEnumToBeMadeExtensible", - "description": "EnumToBeMadeExtensible", + "doc": "EnumToBeMadeExtensible", "type": { "$ref": "24" }, @@ -1114,14 +1114,14 @@ "kind": "property", "name": "propertyModelToAddAdditionalSerializableProperty", "serializedName": "propertyModelToAddAdditionalSerializableProperty", - "description": "ModelToAddAdditionalSerializableProperty", + "doc": "ModelToAddAdditionalSerializableProperty", "type": { "$id": "121", "kind": "model", "name": "ModelToAddAdditionalSerializableProperty", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelToAddAdditionalSerializableProperty", "usage": "Input,Output,Json", - "description": "Model to add additional serializable property", + "doc": "Model to add additional serializable property", "decorators": [], "baseModel": { "$ref": "45" @@ -1132,7 +1132,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int", + "doc": "Required int", "type": { "$id": "123", "kind": "int32", @@ -1161,7 +1161,7 @@ "kind": "property", "name": "propertyToMoveToCustomization", "serializedName": "propertyToMoveToCustomization", - "description": "Enum type property to move to customization code", + "doc": "Enum type property to move to customization code", "type": { "$ref": "32" }, @@ -1177,14 +1177,14 @@ "kind": "property", "name": "propertyModelStruct", "serializedName": "propertyModelStruct", - "description": "ModelStruct", + "doc": "ModelStruct", "type": { "$id": "126", "kind": "model", "name": "ModelStruct", "crossLanguageDefinitionId": "CustomizationsInTsp.ModelStruct", "usage": "Input,Output,Json", - "description": "Model to make to a struct", + "doc": "Model to make to a struct", "decorators": [], "properties": [ { @@ -1192,7 +1192,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int", + "doc": "Required int", "type": { "$id": "128", "kind": "int32", @@ -1212,7 +1212,7 @@ "kind": "property", "name": "optionalInt", "serializedName": "optionalInt", - "description": "Optional int", + "doc": "Optional int", "type": { "$id": "130", "kind": "int32", @@ -1232,7 +1232,7 @@ "kind": "property", "name": "optionalString", "serializedName": "optionalString", - "description": "Optional string", + "doc": "Optional string", "type": { "$id": "132", "kind": "string", @@ -1281,20 +1281,20 @@ { "$id": "133", "Name": "CustomizationsInTspClient", - "Description": "CADL project to test various types of models.", + "Doc": "CADL project to test various types of models.", "Operations": [ { "$id": "134", "Name": "roundTrip", "ResourceName": "CustomizationsInTsp", - "Description": "RoundTrip operation to make RootModel round-trip", + "Doc": "RoundTrip operation to make RootModel round-trip", "Accessibility": "public", "Parameters": [ { "$id": "135", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "136", "kind": "constant", @@ -1397,14 +1397,14 @@ "$id": "143", "Name": "foo", "ResourceName": "CustomizationsInTsp", - "Description": "Sample operation with request body of a renamed model", + "Doc": "Sample operation with request body of a renamed model", "Accessibility": "public", "Parameters": [ { "$id": "144", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "145", "kind": "constant", @@ -1507,14 +1507,14 @@ "$id": "152", "Name": "bar", "ResourceName": "CustomizationsInTsp", - "Description": "Sample operation with request body using a model parameter with a spread operator.", + "Doc": "Sample operation with request body using a model parameter with a spread operator.", "Accessibility": "public", "Parameters": [ { "$id": "153", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "154", "kind": "constant", @@ -1622,7 +1622,7 @@ "$id": "162", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "163", "kind": "url", diff --git a/test/TestProjects/FirstTest-TypeSpec/tspCodeModel.json b/test/TestProjects/FirstTest-TypeSpec/tspCodeModel.json index b6cd9441806..bfe86f01872 100644 --- a/test/TestProjects/FirstTest-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/FirstTest-TypeSpec/tspCodeModel.json @@ -22,7 +22,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -32,7 +32,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -55,7 +55,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -65,7 +65,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -88,7 +88,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -98,7 +98,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -121,7 +121,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -131,7 +131,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -154,7 +154,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -164,7 +164,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -187,7 +187,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -197,7 +197,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -268,7 +268,7 @@ "decorators": [] } ], - "description": "enum with projected name", + "doc": "enum with projected name", "isFixed": true, "isFlags": false, "usage": "Input", @@ -339,7 +339,7 @@ "decorators": [] } ], - "description": "enum with projected name used in a model", + "doc": "enum with projected name used in a model", "isFixed": true, "isFlags": false, "usage": "Input,Json", @@ -410,7 +410,7 @@ "decorators": [] } ], - "description": "Simple enum", + "doc": "Simple enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -481,7 +481,7 @@ "decorators": [] } ], - "description": "Extensible enum", + "doc": "Extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -552,7 +552,7 @@ "decorators": [] } ], - "description": "Int based extensible enum", + "doc": "Int based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -623,7 +623,7 @@ "decorators": [] } ], - "description": "Float based extensible enum", + "doc": "Float based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -694,7 +694,7 @@ "decorators": [] } ], - "description": "float fixed enum", + "doc": "float fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -765,7 +765,7 @@ "decorators": [] } ], - "description": "int fixed enum", + "doc": "int fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -973,7 +973,7 @@ "enumType": { "$ref": "104" }, - "description": "The operation has not started.", + "doc": "The operation has not started.", "decorators": [] }, { @@ -991,7 +991,7 @@ "enumType": { "$ref": "104" }, - "description": "The operation is in progress.", + "doc": "The operation is in progress.", "decorators": [] }, { @@ -1009,7 +1009,7 @@ "enumType": { "$ref": "104" }, - "description": "The operation has completed successfully.", + "doc": "The operation has completed successfully.", "decorators": [] }, { @@ -1027,7 +1027,7 @@ "enumType": { "$ref": "104" }, - "description": "The operation has failed.", + "doc": "The operation has failed.", "decorators": [] }, { @@ -1045,11 +1045,11 @@ "enumType": { "$ref": "104" }, - "description": "The operation has been canceled by the user.", + "doc": "The operation has been canceled by the user.", "decorators": [] } ], - "description": "Enum describing allowed operation states.", + "doc": "Enum describing allowed operation states.", "isFixed": false, "isFlags": false, "usage": "Json", @@ -1063,7 +1063,7 @@ "name": "Thing", "crossLanguageDefinitionId": "FirstTestTypeSpec.Thing", "usage": "Input,Output,Spread,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -1071,7 +1071,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "118", "kind": "string", @@ -1091,7 +1091,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "120", "kind": "union", @@ -1140,7 +1140,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "126", "kind": "constant", @@ -1162,7 +1162,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "128", "kind": "constant", @@ -1184,7 +1184,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "130", "kind": "constant", @@ -1206,7 +1206,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "132", "kind": "constant", @@ -1232,7 +1232,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "135", "kind": "constant", @@ -1254,7 +1254,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "137", "kind": "constant", @@ -1276,7 +1276,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "139", "kind": "constant", @@ -1298,7 +1298,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "141", "kind": "constant", @@ -1324,7 +1324,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "144", "kind": "string", @@ -1344,7 +1344,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "146", "kind": "nullable", @@ -1375,7 +1375,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "150", "kind": "nullable", @@ -1406,7 +1406,7 @@ "kind": "property", "name": "requiredFloatProperty", "serializedName": "requiredFloatProperty", - "description": "required float property", + "doc": "required float property", "type": { "$id": "154", "kind": "float", @@ -1426,7 +1426,7 @@ "kind": "property", "name": "optionalFloatProperty", "serializedName": "optionalFloatProperty", - "description": "optional float property", + "doc": "optional float property", "type": { "$id": "156", "kind": "float", @@ -1446,7 +1446,7 @@ "kind": "property", "name": "optionalResourceId", "serializedName": "optionalResourceId", - "description": "optional arm id.", + "doc": "optional arm id.", "type": { "$id": "158", "kind": "string", @@ -1476,7 +1476,7 @@ "name": "Friend", "crossLanguageDefinitionId": "FirstTestTypeSpec.NotFriend", "usage": "Output,Spread,Json", - "description": "this is not a friendly model but with a friendly name", + "doc": "this is not a friendly model but with a friendly name", "decorators": [], "properties": [ { @@ -1484,7 +1484,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the NotFriend", + "doc": "name of the NotFriend", "type": { "$id": "162", "kind": "string", @@ -1514,7 +1514,7 @@ "kind": "property", "name": "sourceUrl", "serializedName": "sourceUrl", - "description": "url format", + "doc": "url format", "type": { "$id": "165", "kind": "url", @@ -1534,7 +1534,7 @@ "kind": "property", "name": "guid", "serializedName": "guid", - "description": "uuid format", + "doc": "uuid format", "type": { "$id": "167", "kind": "string", @@ -1564,7 +1564,7 @@ "name": "ProjectedModel", "crossLanguageDefinitionId": "FirstTestTypeSpec.ModelWithProjectedName", "usage": "Output,Spread,Json", - "description": "this is a model with a projected name", + "doc": "this is a model with a projected name", "decorators": [], "properties": [ { @@ -1572,7 +1572,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelWithProjectedName", + "doc": "name of the ModelWithProjectedName", "type": { "$id": "171", "kind": "string", @@ -1604,7 +1604,7 @@ "name": "Extension", "crossLanguageDefinitionId": "FirstTestTypeSpec.Extension", "usage": "Input,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "174", @@ -1612,7 +1612,7 @@ "name": "Element", "crossLanguageDefinitionId": "FirstTestTypeSpec.Element", "usage": "Input,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -1670,7 +1670,7 @@ "name": "Extendible", "crossLanguageDefinitionId": "FirstTestTypeSpec.Extendible", "usage": "Input,Json", - "description": "FHIR extendible element", + "doc": "FHIR extendible element", "decorators": [], "properties": [ { @@ -1678,7 +1678,7 @@ "kind": "property", "name": "extension", "serializedName": "extension", - "description": "Additional Content defined by implementations", + "doc": "Additional Content defined by implementations", "type": { "$id": "181", "kind": "array", @@ -1689,7 +1689,7 @@ "name": "ThereLevelExtension", "crossLanguageDefinitionId": "FirstTestTypeSpec.ThereLevelExtension", "usage": "Input,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "183", @@ -1697,7 +1697,7 @@ "name": "ThereLevelElement", "crossLanguageDefinitionId": "FirstTestTypeSpec.ThereLevelElement", "usage": "Input,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -1770,7 +1770,7 @@ "name": "ChildModel", "crossLanguageDefinitionId": "FirstTestTypeSpec.ChildModel", "usage": "Input,Json", - "description": "ChildModel", + "doc": "ChildModel", "decorators": [], "baseModel": { "$id": "189", @@ -1778,7 +1778,7 @@ "name": "BaseModel", "crossLanguageDefinitionId": "FirstTestTypeSpec.BaseModel", "usage": "Input,Json", - "description": "parenetModel", + "doc": "parenetModel", "decorators": [], "properties": [ { @@ -1836,7 +1836,7 @@ "name": "ContainSelf", "crossLanguageDefinitionId": "FirstTestTypeSpec.ContainSelf", "usage": "Input,Json", - "description": "containself", + "doc": "containself", "decorators": [], "properties": [ { @@ -1869,7 +1869,7 @@ "kind": "property", "name": "enumProperty", "serializedName": "enumProperty", - "description": "enum with projected name used in a model", + "doc": "enum with projected name used in a model", "type": { "$ref": "28" }, @@ -1972,7 +1972,7 @@ "name": "RoundTripModel", "crossLanguageDefinitionId": "FirstTestTypeSpec.RoundTripModel", "usage": "Input,Output,Json", - "description": "this is a roundtrip model", + "doc": "this is a roundtrip model", "decorators": [], "properties": [ { @@ -1980,7 +1980,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "Required string, illustrating a reference type property.", + "doc": "Required string, illustrating a reference type property.", "type": { "$id": "209", "kind": "string", @@ -2000,7 +2000,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int, illustrating a value type property.", + "doc": "Required int, illustrating a value type property.", "type": { "$id": "211", "kind": "int32", @@ -2020,7 +2020,7 @@ "kind": "property", "name": "requiredCollection", "serializedName": "requiredCollection", - "description": "Required collection of enums", + "doc": "Required collection of enums", "type": { "$id": "213", "kind": "array", @@ -2043,7 +2043,7 @@ "kind": "property", "name": "requiredDictionary", "serializedName": "requiredDictionary", - "description": "Required dictionary of enums", + "doc": "Required dictionary of enums", "type": { "$id": "215", "kind": "dict", @@ -2071,7 +2071,7 @@ "kind": "property", "name": "requiredModel", "serializedName": "requiredModel", - "description": "Required model", + "doc": "Required model", "type": { "$ref": "116" }, @@ -2087,7 +2087,7 @@ "kind": "property", "name": "intExtensibleEnum", "serializedName": "intExtensibleEnum", - "description": "this is an int based extensible enum", + "doc": "this is an int based extensible enum", "type": { "$ref": "52" }, @@ -2103,7 +2103,7 @@ "kind": "property", "name": "intExtensibleEnumCollection", "serializedName": "intExtensibleEnumCollection", - "description": "this is a collection of int based extensible enum", + "doc": "this is a collection of int based extensible enum", "type": { "$id": "220", "kind": "array", @@ -2126,7 +2126,7 @@ "kind": "property", "name": "floatExtensibleEnum", "serializedName": "floatExtensibleEnum", - "description": "this is a float based extensible enum", + "doc": "this is a float based extensible enum", "type": { "$ref": "60" }, @@ -2142,7 +2142,7 @@ "kind": "property", "name": "floatExtensibleEnumCollection", "serializedName": "floatExtensibleEnumCollection", - "description": "this is a collection of float based extensible enum", + "doc": "this is a collection of float based extensible enum", "type": { "$id": "223", "kind": "array", @@ -2165,7 +2165,7 @@ "kind": "property", "name": "floatFixedEnum", "serializedName": "floatFixedEnum", - "description": "this is a float based fixed enum", + "doc": "this is a float based fixed enum", "type": { "$ref": "68" }, @@ -2181,7 +2181,7 @@ "kind": "property", "name": "floatFixedEnumCollection", "serializedName": "floatFixedEnumCollection", - "description": "this is a collection of float based fixed enum", + "doc": "this is a collection of float based fixed enum", "type": { "$id": "226", "kind": "array", @@ -2204,7 +2204,7 @@ "kind": "property", "name": "intFixedEnum", "serializedName": "intFixedEnum", - "description": "this is a int based fixed enum", + "doc": "this is a int based fixed enum", "type": { "$ref": "76" }, @@ -2220,7 +2220,7 @@ "kind": "property", "name": "intFixedEnumCollection", "serializedName": "intFixedEnumCollection", - "description": "this is a collection of int based fixed enum", + "doc": "this is a collection of int based fixed enum", "type": { "$id": "229", "kind": "array", @@ -2243,7 +2243,7 @@ "kind": "property", "name": "stringFixedEnum", "serializedName": "stringFixedEnum", - "description": "this is a string based fixed enum", + "doc": "this is a string based fixed enum", "type": { "$ref": "36" }, @@ -2259,7 +2259,7 @@ "kind": "property", "name": "requiredUnknown", "serializedName": "requiredUnknown", - "description": "required unknown", + "doc": "required unknown", "type": { "$id": "232", "kind": "unknown", @@ -2279,7 +2279,7 @@ "kind": "property", "name": "optionalUnknown", "serializedName": "optionalUnknown", - "description": "optional unknown", + "doc": "optional unknown", "type": { "$id": "234", "kind": "unknown", @@ -2299,7 +2299,7 @@ "kind": "property", "name": "requiredRecordUnknown", "serializedName": "requiredRecordUnknown", - "description": "required record of unknown", + "doc": "required record of unknown", "type": { "$id": "236", "kind": "dict", @@ -2331,7 +2331,7 @@ "kind": "property", "name": "optionalRecordUnknown", "serializedName": "optionalRecordUnknown", - "description": "optional record of unknown", + "doc": "optional record of unknown", "type": { "$id": "240", "kind": "dict", @@ -2363,7 +2363,7 @@ "kind": "property", "name": "readOnlyRequiredRecordUnknown", "serializedName": "readOnlyRequiredRecordUnknown", - "description": "required readonly record of unknown", + "doc": "required readonly record of unknown", "type": { "$id": "244", "kind": "dict", @@ -2395,7 +2395,7 @@ "kind": "property", "name": "readOnlyOptionalRecordUnknown", "serializedName": "readOnlyOptionalRecordUnknown", - "description": "optional readonly record of unknown", + "doc": "optional readonly record of unknown", "type": { "$id": "248", "kind": "dict", @@ -2427,14 +2427,14 @@ "kind": "property", "name": "modelWithRequiredNullable", "serializedName": "modelWithRequiredNullable", - "description": "this is a model with required nullable properties", + "doc": "this is a model with required nullable properties", "type": { "$id": "252", "kind": "model", "name": "ModelWithRequiredNullableProperties", "crossLanguageDefinitionId": "FirstTestTypeSpec.ModelWithRequiredNullableProperties", "usage": "Input,Output,Json", - "description": "A model with a few required nullable properties", + "doc": "A model with a few required nullable properties", "decorators": [], "properties": [ { @@ -2442,7 +2442,7 @@ "kind": "property", "name": "requiredNullablePrimitive", "serializedName": "requiredNullablePrimitive", - "description": "required nullable primitive type", + "doc": "required nullable primitive type", "type": { "$id": "254", "kind": "nullable", @@ -2466,7 +2466,7 @@ "kind": "property", "name": "requiredExtensibleEnum", "serializedName": "requiredExtensibleEnum", - "description": "required nullable extensible enum type", + "doc": "required nullable extensible enum type", "type": { "$id": "257", "kind": "nullable", @@ -2486,7 +2486,7 @@ "kind": "property", "name": "requiredFixedEnum", "serializedName": "requiredFixedEnum", - "description": "required nullable fixed enum type", + "doc": "required nullable fixed enum type", "type": { "$id": "259", "kind": "nullable", @@ -2515,7 +2515,7 @@ "kind": "property", "name": "unionList", "serializedName": "unionList", - "description": "this is a list of union types", + "doc": "this is a list of union types", "type": { "$id": "261", "kind": "array", @@ -2545,7 +2545,7 @@ "name": "ModelForUnion", "crossLanguageDefinitionId": "FirstTestTypeSpec.ModelForUnion", "usage": "Input,Output,Json", - "description": "This is a model only used in union types, please do not use it anywhere else.", + "doc": "This is a model only used in union types, please do not use it anywhere else.", "decorators": [], "properties": [ { @@ -2553,7 +2553,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelForUnion", + "doc": "name of the ModelForUnion", "type": { "$id": "267", "kind": "string", @@ -2573,7 +2573,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "age of the ModelForUnion", + "doc": "age of the ModelForUnion", "type": { "$id": "269", "kind": "int32", @@ -2627,7 +2627,7 @@ "name": "ResourceOperationStatusResourceExportedResourceError", "crossLanguageDefinitionId": "Azure.Core.ResourceOperationStatus", "usage": "Json", - "description": "Provides status details for long running operations.", + "doc": "Provides status details for long running operations.", "decorators": [], "properties": [ { @@ -2635,7 +2635,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique ID of the operation.", + "doc": "The unique ID of the operation.", "type": { "$id": "273", "kind": "string", @@ -2655,7 +2655,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The status of the operation", + "doc": "The status of the operation", "type": { "$ref": "104" }, @@ -2671,14 +2671,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "Error object that describes the error when status is \"Failed\".", + "doc": "Error object that describes the error when status is \"Failed\".", "type": { "$id": "276", "kind": "model", "name": "Error", "crossLanguageDefinitionId": "Azure.Core.Foundations.Error", "usage": "Json", - "description": "The error object.", + "doc": "The error object.", "decorators": [], "properties": [ { @@ -2686,7 +2686,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "278", "kind": "string", @@ -2706,7 +2706,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A human-readable representation of the error.", + "doc": "A human-readable representation of the error.", "type": { "$id": "280", "kind": "string", @@ -2726,7 +2726,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The target of the error.", + "doc": "The target of the error.", "type": { "$id": "282", "kind": "string", @@ -2746,7 +2746,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "An array of details about specific errors that led to this reported error.", + "doc": "An array of details about specific errors that led to this reported error.", "type": { "$id": "284", "kind": "array", @@ -2769,14 +2769,14 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "An object containing more specific information than the current object about the error.", + "doc": "An object containing more specific information than the current object about the error.", "type": { "$id": "286", "kind": "model", "name": "InnerError", "crossLanguageDefinitionId": "Azure.Core.Foundations.InnerError", "usage": "Json", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "doc": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "decorators": [], "properties": [ { @@ -2784,7 +2784,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "One of a server-defined set of error codes.", + "doc": "One of a server-defined set of error codes.", "type": { "$id": "288", "kind": "string", @@ -2804,7 +2804,7 @@ "kind": "property", "name": "innererror", "serializedName": "innererror", - "description": "Inner error.", + "doc": "Inner error.", "type": { "$ref": "286" }, @@ -2838,7 +2838,7 @@ "kind": "property", "name": "result", "serializedName": "result", - "description": "The result of the operation.", + "doc": "The result of the operation.", "type": { "$ref": "202" }, @@ -2862,13 +2862,13 @@ { "$id": "291", "Name": "FirstTestTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "292", "Name": "topAction", "ResourceName": "FirstTestTypeSpec", - "Description": "top level method", + "Doc": "top level method", "Accessibility": "public", "Parameters": [ { @@ -2959,7 +2959,7 @@ "$id": "300", "Name": "topAction2", "ResourceName": "FirstTestTypeSpec", - "Description": "top level method2", + "Doc": "top level method2", "Accessibility": "public", "Parameters": [ { @@ -3021,14 +3021,14 @@ "$id": "305", "Name": "patchAction", "ResourceName": "FirstTestTypeSpec", - "Description": "top level patch", + "Doc": "top level patch", "Accessibility": "public", "Parameters": [ { "$id": "306", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "307", "kind": "constant", @@ -3131,14 +3131,14 @@ "$id": "314", "Name": "anonymousBody", "ResourceName": "FirstTestTypeSpec", - "Description": "body parameter without body decorator", + "Doc": "body parameter without body decorator", "Accessibility": "public", "Parameters": [ { "$id": "315", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "316", "kind": "constant", @@ -3241,14 +3241,14 @@ "$id": "323", "Name": "friendlyModel", "ResourceName": "FirstTestTypeSpec", - "Description": "Model can have its friendly name", + "Doc": "Model can have its friendly name", "Accessibility": "public", "Parameters": [ { "$id": "324", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "325", "kind": "constant", @@ -3408,7 +3408,7 @@ "$id": "337", "Name": "stringFormat", "ResourceName": "FirstTestTypeSpec", - "Description": "paramete has string format.", + "Doc": "paramete has string format.", "Accessibility": "public", "Parameters": [ { @@ -3443,7 +3443,7 @@ "$id": "341", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "342", "kind": "constant", @@ -3513,14 +3513,14 @@ "$id": "346", "Name": "projectedNameModel", "ResourceName": "FirstTestTypeSpec", - "Description": "Model can have its projected name", + "Doc": "Model can have its projected name", "Accessibility": "public", "Parameters": [ { "$id": "347", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "348", "kind": "constant", @@ -3623,7 +3623,7 @@ "$id": "355", "Name": "returnsAnonymousModel", "ResourceName": "FirstTestTypeSpec", - "Description": "return anonymous model", + "Doc": "return anonymous model", "Accessibility": "public", "Parameters": [ { @@ -3685,7 +3685,7 @@ "$id": "360", "Name": "headAsBoolean", "ResourceName": "FirstTestTypeSpec", - "Description": "head as boolean.", + "Doc": "head as boolean.", "Accessibility": "public", "Parameters": [ { @@ -3735,14 +3735,14 @@ "$id": "364", "Name": "stringBody", "ResourceName": "FirstTestTypeSpec", - "Description": "The body parameter type is string.", + "Doc": "The body parameter type is string.", "Accessibility": "public", "Parameters": [ { "$id": "365", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "366", "kind": "constant", @@ -3816,14 +3816,14 @@ "$id": "371", "Name": "boolBody", "ResourceName": "FirstTestTypeSpec", - "Description": "The body parameter type is bool.", + "Doc": "The body parameter type is bool.", "Accessibility": "public", "Parameters": [ { "$id": "372", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "373", "kind": "constant", @@ -3897,14 +3897,14 @@ "$id": "378", "Name": "dateTimeBody", "ResourceName": "FirstTestTypeSpec", - "Description": "The body parameter type is datetime.", + "Doc": "The body parameter type is datetime.", "Accessibility": "public", "Parameters": [ { "$id": "379", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "380", "kind": "constant", @@ -3986,7 +3986,7 @@ "$id": "386", "Name": "returnString", "ResourceName": "FirstTestTypeSpec", - "Description": "The return type is datetime.", + "Doc": "The return type is datetime.", "Accessibility": "public", "Parameters": [ { @@ -4117,14 +4117,14 @@ "$id": "398", "Name": "recursiveExtension", "ResourceName": "FirstTestTypeSpec", - "Description": "test parent reference child", + "Doc": "test parent reference child", "Accessibility": "public", "Parameters": [ { "$id": "399", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "400", "kind": "constant", @@ -4194,14 +4194,14 @@ "$id": "404", "Name": "threeLevelRecursive", "ResourceName": "FirstTestTypeSpec", - "Description": "test three level recursive extension", + "Doc": "test three level recursive extension", "Accessibility": "public", "Parameters": [ { "$id": "405", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "406", "kind": "constant", @@ -4271,14 +4271,14 @@ "$id": "410", "Name": "recursiveModels", "ResourceName": "FirstTestTypeSpec", - "Description": "test child reference parent", + "Doc": "test child reference parent", "Accessibility": "public", "Parameters": [ { "$id": "411", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "412", "kind": "constant", @@ -4348,14 +4348,14 @@ "$id": "416", "Name": "ContainSelfModels", "ResourceName": "FirstTestTypeSpec", - "Description": "test contain self models", + "Doc": "test contain self models", "Accessibility": "public", "Parameters": [ { "$id": "417", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "418", "kind": "constant", @@ -4425,7 +4425,7 @@ "$id": "422", "Name": "enumParameter", "ResourceName": "FirstTestTypeSpec", - "Description": "test enum parameter.", + "Doc": "test enum parameter.", "Accessibility": "public", "Parameters": [ { @@ -4471,14 +4471,14 @@ "$id": "425", "Name": "bodyIsModelWithProjectedEnum", "ResourceName": "FirstTestTypeSpec", - "Description": "test enum parameter.", + "Doc": "test enum parameter.", "Accessibility": "public", "Parameters": [ { "$id": "426", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "427", "kind": "constant", @@ -4548,14 +4548,14 @@ "$id": "431", "Name": "optionalDictionary", "ResourceName": "FirstTestTypeSpec", - "Description": "test optional dictionary.", + "Doc": "test optional dictionary.", "Accessibility": "public", "Parameters": [ { "$id": "432", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "433", "kind": "constant", @@ -4641,7 +4641,7 @@ "$id": "440", "Name": "azureLocationOp", "ResourceName": "FirstTestTypeSpec", - "Description": "test optional dictionary.", + "Doc": "test optional dictionary.", "Accessibility": "public", "Parameters": [ { @@ -4704,7 +4704,7 @@ "$id": "447", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "448", "kind": "constant", @@ -4833,13 +4833,13 @@ { "$id": "459", "Name": "HelloDemo", - "Description": "Hello world service", + "Doc": "Hello world service", "Operations": [ { "$id": "460", "Name": "sayHi", "ResourceName": "Demo", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -4997,7 +4997,7 @@ "$id": "475", "Name": "helloAgain", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -5148,7 +5148,7 @@ "$id": "488", "Name": "noContentType", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -5197,7 +5197,7 @@ "$id": "493", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "494", "kind": "constant", @@ -5300,7 +5300,7 @@ "$id": "501", "Name": "helloDemoAgain", "ResourceName": "Demo2", - "Description": "Return hi in demo2", + "Doc": "Return hi in demo2", "Accessibility": "public", "Parameters": [ { @@ -5362,14 +5362,14 @@ "$id": "506", "Name": "createLiteral", "ResourceName": "Demo2", - "Description": "Create with literal value", + "Doc": "Create with literal value", "Accessibility": "public", "Parameters": [ { "$id": "507", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "508", "kind": "constant", @@ -5472,7 +5472,7 @@ "$id": "515", "Name": "helloLiteral", "ResourceName": "Demo2", - "Description": "Send literal parameters", + "Doc": "Send literal parameters", "Accessibility": "public", "Parameters": [ { @@ -5648,14 +5648,14 @@ "$id": "533", "Name": "createUnknownValue", "ResourceName": "EnumTest", - "Description": "get extensible enum", + "Doc": "get extensible enum", "Accessibility": "public", "Parameters": [ { "$id": "534", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "535", "kind": "constant", @@ -5758,14 +5758,14 @@ "$id": "543", "Name": "internalProtocol", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, then the protocol method should be internal", + "Doc": "When set protocol false and convenient true, then the protocol method should be internal", "Accessibility": "public", "Parameters": [ { "$id": "544", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "545", "kind": "constant", @@ -5868,7 +5868,7 @@ "$id": "552", "Name": "stillConvenient", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", + "Doc": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -5929,7 +5929,7 @@ "$id": "558", "Name": "doSomething", "ResourceName": "Entity", - "Description": "doSomething for entity", + "Doc": "doSomething for entity", "Accessibility": "public", "Parameters": [ { @@ -6045,7 +6045,7 @@ "$id": "569", "Name": "doSomething", "ResourceName": "Glossary", - "Description": "doSomething for glossary", + "Doc": "doSomething for glossary", "Accessibility": "public", "Parameters": [ { @@ -6214,14 +6214,14 @@ "$id": "586", "Name": "export", "ResourceName": "VersioningOp", - "Description": "Long-running resource action operation template.", + "Doc": "Long-running resource action operation template.", "Accessibility": "public", "Parameters": [ { "$id": "587", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "588", "kind": "string", @@ -6334,7 +6334,7 @@ "$id": "599", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "600", "kind": "url", @@ -6386,14 +6386,14 @@ "$id": "604", "Name": "exportW", "ResourceName": "VersioningOp", - "Description": "Long-running resource action operation template.", + "Doc": "Long-running resource action operation template.", "Accessibility": "public", "Parameters": [ { "$id": "605", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "606", "kind": "string", @@ -6506,7 +6506,7 @@ "$id": "617", "Name": "operationLocation", "NameInResponse": "Operation-Location", - "Description": "The location for monitoring the operation state.", + "Doc": "The location for monitoring the operation state.", "Type": { "$id": "618", "kind": "url", diff --git a/test/TestProjects/MediaTypes-TypeSpec/tspCodeModel.json b/test/TestProjects/MediaTypes-TypeSpec/tspCodeModel.json index bb458c26728..d1702f9e4f4 100644 --- a/test/TestProjects/MediaTypes-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/MediaTypes-TypeSpec/tspCodeModel.json @@ -162,7 +162,7 @@ { "$id": "19", "Name": "MultipleMediaTypesClient", - "Description": "Play with produces/consumes and media-types in general.", + "Doc": "Play with produces/consumes and media-types in general.", "Operations": [ { "$id": "20", diff --git a/test/TestProjects/MgmtTypeSpec/tspCodeModel.json b/test/TestProjects/MgmtTypeSpec/tspCodeModel.json index 05a3476a3a2..6043b0bb9da 100644 --- a/test/TestProjects/MgmtTypeSpec/tspCodeModel.json +++ b/test/TestProjects/MgmtTypeSpec/tspCodeModel.json @@ -33,7 +33,7 @@ "enumType": { "$ref": "2" }, - "description": "Azure Edge Zones location type", + "doc": "Azure Edge Zones location type", "decorators": [] }, { @@ -51,11 +51,11 @@ "enumType": { "$ref": "2" }, - "description": "Azure Custom Locations type", + "doc": "Azure Custom Locations type", "decorators": [] } ], - "description": "The supported ExtendedLocation types.", + "doc": "The supported ExtendedLocation types.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -89,7 +89,7 @@ "enumType": { "$ref": "8" }, - "description": "The entity was created by a user.", + "doc": "The entity was created by a user.", "decorators": [] }, { @@ -107,7 +107,7 @@ "enumType": { "$ref": "8" }, - "description": "The entity was created by an application.", + "doc": "The entity was created by an application.", "decorators": [] }, { @@ -125,7 +125,7 @@ "enumType": { "$ref": "8" }, - "description": "The entity was created by a managed identity.", + "doc": "The entity was created by a managed identity.", "decorators": [] }, { @@ -143,11 +143,11 @@ "enumType": { "$ref": "8" }, - "description": "The entity was created by a key.", + "doc": "The entity was created by a key.", "decorators": [] } ], - "description": "The kind of entity that created the resource.", + "doc": "The kind of entity that created the resource.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -181,7 +181,7 @@ "enumType": { "$ref": "18" }, - "description": "No managed identity.", + "doc": "No managed identity.", "decorators": [] }, { @@ -199,7 +199,7 @@ "enumType": { "$ref": "18" }, - "description": "System assigned managed identity.", + "doc": "System assigned managed identity.", "decorators": [] }, { @@ -217,7 +217,7 @@ "enumType": { "$ref": "18" }, - "description": "User assigned managed identity.", + "doc": "User assigned managed identity.", "decorators": [] }, { @@ -235,11 +235,11 @@ "enumType": { "$ref": "18" }, - "description": "System and user assigned managed identity.", + "doc": "System and user assigned managed identity.", "decorators": [] } ], - "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "doc": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -273,7 +273,7 @@ "enumType": { "$ref": "28" }, - "description": "Indicates the operation is initiated by a user.", + "doc": "Indicates the operation is initiated by a user.", "decorators": [] }, { @@ -291,7 +291,7 @@ "enumType": { "$ref": "28" }, - "description": "Indicates the operation is initiated by a system.", + "doc": "Indicates the operation is initiated by a system.", "decorators": [] }, { @@ -309,11 +309,11 @@ "enumType": { "$ref": "28" }, - "description": "Indicates the operation is initiated by a user or system.", + "doc": "Indicates the operation is initiated by a user or system.", "decorators": [] } ], - "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "doc": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -347,11 +347,11 @@ "enumType": { "$ref": "36" }, - "description": "Actions are for internal-only APIs.", + "doc": "Actions are for internal-only APIs.", "decorators": [] } ], - "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "doc": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -385,11 +385,11 @@ "enumType": { "$ref": "40" }, - "description": "Azure Cosmos DB for Mongo vCore clusters api version 2024-03-01-preview.", + "doc": "Azure Cosmos DB for Mongo vCore clusters api version 2024-03-01-preview.", "decorators": [] } ], - "description": "The available API versions.", + "doc": "The available API versions.", "isFixed": true, "isFlags": false, "usage": "ApiVersionEnum", @@ -403,7 +403,7 @@ "name": "Foo", "crossLanguageDefinitionId": "MgmtTypeSpec.Foo", "usage": "Input,Output,Json", - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "doc": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "decorators": [], "baseModel": { "$id": "45", @@ -411,7 +411,7 @@ "name": "TrackedResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.TrackedResource", "usage": "Input,Output,Json", - "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "doc": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "decorators": [], "baseModel": { "$id": "46", @@ -419,7 +419,7 @@ "name": "Resource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.Resource", "usage": "Input,Output,Json", - "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "doc": "Common fields that are returned in the response for all Azure Resource Manager resources", "decorators": [], "properties": [ { @@ -427,7 +427,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "doc": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", "type": { "$id": "48", "kind": "string", @@ -454,7 +454,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the resource", + "doc": "The name of the resource", "type": { "$id": "51", "kind": "string", @@ -474,7 +474,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", + "doc": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"", "type": { "$id": "53", "kind": "string", @@ -494,14 +494,14 @@ "kind": "property", "name": "systemData", "serializedName": "systemData", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "doc": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", "type": { "$id": "55", "kind": "model", "name": "SystemData", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.SystemData", "usage": "Output,Json", - "description": "Metadata pertaining to creation and last modification of the resource.", + "doc": "Metadata pertaining to creation and last modification of the resource.", "decorators": [], "properties": [ { @@ -509,7 +509,7 @@ "kind": "property", "name": "createdBy", "serializedName": "createdBy", - "description": "The identity that created the resource.", + "doc": "The identity that created the resource.", "type": { "$id": "57", "kind": "string", @@ -529,7 +529,7 @@ "kind": "property", "name": "createdByType", "serializedName": "createdByType", - "description": "The type of identity that created the resource.", + "doc": "The type of identity that created the resource.", "type": { "$ref": "8" }, @@ -545,7 +545,7 @@ "kind": "property", "name": "createdAt", "serializedName": "createdAt", - "description": "The timestamp of resource creation (UTC).", + "doc": "The timestamp of resource creation (UTC).", "type": { "$id": "60", "kind": "utcDateTime", @@ -573,7 +573,7 @@ "kind": "property", "name": "lastModifiedBy", "serializedName": "lastModifiedBy", - "description": "The identity that last modified the resource.", + "doc": "The identity that last modified the resource.", "type": { "$id": "63", "kind": "string", @@ -593,7 +593,7 @@ "kind": "property", "name": "lastModifiedByType", "serializedName": "lastModifiedByType", - "description": "The type of identity that last modified the resource.", + "doc": "The type of identity that last modified the resource.", "type": { "$ref": "8" }, @@ -609,7 +609,7 @@ "kind": "property", "name": "lastModifiedAt", "serializedName": "lastModifiedAt", - "description": "The timestamp of resource last modification (UTC)", + "doc": "The timestamp of resource last modification (UTC)", "type": { "$id": "66", "kind": "utcDateTime", @@ -649,7 +649,7 @@ "kind": "property", "name": "tags", "serializedName": "tags", - "description": "Resource tags.", + "doc": "Resource tags.", "type": { "$id": "69", "kind": "dict", @@ -681,7 +681,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The geo-location where the resource lives", + "doc": "The geo-location where the resource lives", "type": { "$id": "73", "kind": "string", @@ -704,7 +704,7 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "75", "kind": "model", @@ -727,7 +727,7 @@ "kind": "property", "name": "serviceUrl", "serializedName": "serviceUrl", - "description": "the service url", + "doc": "the service url", "type": { "$id": "79", "kind": "url", @@ -747,7 +747,7 @@ "kind": "property", "name": "something", "serializedName": "something", - "description": "something", + "doc": "something", "type": { "$id": "81", "kind": "string", @@ -767,7 +767,7 @@ "kind": "property", "name": "boolValue", "serializedName": "boolValue", - "description": "boolean value", + "doc": "boolean value", "type": { "$id": "83", "kind": "boolean", @@ -787,7 +787,7 @@ "kind": "property", "name": "floatValue", "serializedName": "floatValue", - "description": "float value", + "doc": "float value", "type": { "$id": "85", "kind": "float32", @@ -807,7 +807,7 @@ "kind": "property", "name": "doubleValue", "serializedName": "doubleValue", - "description": "double value", + "doc": "double value", "type": { "$id": "87", "kind": "float64", @@ -842,7 +842,7 @@ "name": "ExtendedLocation", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ExtendedLocation", "usage": "Input,Output,Json", - "description": "The complex type of the extended location.", + "doc": "The complex type of the extended location.", "decorators": [], "properties": [ { @@ -850,7 +850,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the extended location.", + "doc": "The name of the extended location.", "type": { "$id": "91", "kind": "string", @@ -870,7 +870,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of the extended location.", + "doc": "The type of the extended location.", "type": { "$ref": "2" }, @@ -913,7 +913,7 @@ "name": "ErrorResponse", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorResponse", "usage": "Output,Error,Json", - "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "doc": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", "decorators": [], "properties": [ { @@ -921,14 +921,14 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "The error object.", + "doc": "The error object.", "type": { "$id": "95", "kind": "model", "name": "ErrorDetail", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorDetail", "usage": "Output,Json", - "description": "The error detail.", + "doc": "The error detail.", "decorators": [], "properties": [ { @@ -936,7 +936,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "The error code.", + "doc": "The error code.", "type": { "$id": "97", "kind": "string", @@ -956,7 +956,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "The error message.", + "doc": "The error message.", "type": { "$id": "99", "kind": "string", @@ -976,7 +976,7 @@ "kind": "property", "name": "target", "serializedName": "target", - "description": "The error target.", + "doc": "The error target.", "type": { "$id": "101", "kind": "string", @@ -996,7 +996,7 @@ "kind": "property", "name": "details", "serializedName": "details", - "description": "The error details.", + "doc": "The error details.", "type": { "$id": "103", "kind": "array", @@ -1019,7 +1019,7 @@ "kind": "property", "name": "additionalInfo", "serializedName": "additionalInfo", - "description": "The error additional info.", + "doc": "The error additional info.", "type": { "$id": "105", "kind": "array", @@ -1030,7 +1030,7 @@ "name": "ErrorAdditionalInfo", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo", "usage": "Output,Json", - "description": "The resource management error additional info.", + "doc": "The resource management error additional info.", "decorators": [], "properties": [ { @@ -1038,7 +1038,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The additional info type.", + "doc": "The additional info type.", "type": { "$id": "108", "kind": "string", @@ -1058,7 +1058,7 @@ "kind": "property", "name": "info", "serializedName": "info", - "description": "The additional info.", + "doc": "The additional info.", "type": { "$id": "110", "kind": "model", @@ -1113,7 +1113,7 @@ "name": "FooListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.ResourceListResult", "usage": "Output,Json", - "description": "The response of a Foo list operation.", + "doc": "The response of a Foo list operation.", "decorators": [], "properties": [ { @@ -1121,7 +1121,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The Foo items on this page", + "doc": "The Foo items on this page", "type": { "$id": "113", "kind": "array", @@ -1144,7 +1144,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "115", "kind": "url", @@ -1174,7 +1174,7 @@ "name": "PrivateLinkResourceListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.ResourceListResult", "usage": "Output,Json", - "description": "The response of a PrivateLinkResource list operation.", + "doc": "The response of a PrivateLinkResource list operation.", "decorators": [], "properties": [ { @@ -1182,7 +1182,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The PrivateLinkResource items on this page", + "doc": "The PrivateLinkResource items on this page", "type": { "$id": "119", "kind": "array", @@ -1193,7 +1193,7 @@ "name": "PrivateLinkResource", "crossLanguageDefinitionId": "MgmtTypeSpec.PrivateLinkResource", "usage": "Output,Json", - "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "doc": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "decorators": [], "baseModel": { "$id": "121", @@ -1201,7 +1201,7 @@ "name": "ProxyResource", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ProxyResource", "usage": "Output,Json", - "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "doc": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", "decorators": [], "baseModel": { "$ref": "46" @@ -1214,14 +1214,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The resource-specific properties for this resource.", + "doc": "The resource-specific properties for this resource.", "type": { "$id": "123", "kind": "model", "name": "PrivateLinkResourceProperties", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.PrivateLinkResourceProperties", "usage": "Output,Json", - "description": "Properties of a private link resource.", + "doc": "Properties of a private link resource.", "decorators": [], "properties": [ { @@ -1229,7 +1229,7 @@ "kind": "property", "name": "groupId", "serializedName": "groupId", - "description": "The private link resource group id.", + "doc": "The private link resource group id.", "type": { "$id": "125", "kind": "string", @@ -1249,7 +1249,7 @@ "kind": "property", "name": "requiredMembers", "serializedName": "requiredMembers", - "description": "The private link resource required member names.", + "doc": "The private link resource required member names.", "type": { "$id": "127", "kind": "array", @@ -1276,7 +1276,7 @@ "kind": "property", "name": "requiredZoneNames", "serializedName": "requiredZoneNames", - "description": "The private link resource private link DNS zone name.", + "doc": "The private link resource private link DNS zone name.", "type": { "$id": "130", "kind": "array", @@ -1312,14 +1312,14 @@ "kind": "property", "name": "identity", "serializedName": "identity", - "description": "The managed service identities assigned to this resource.", + "doc": "The managed service identities assigned to this resource.", "type": { "$id": "133", "kind": "model", "name": "ManagedServiceIdentity", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.ManagedServiceIdentity", "usage": "Output,Json", - "description": "Managed service identity (system assigned and/or user assigned identities)", + "doc": "Managed service identity (system assigned and/or user assigned identities)", "decorators": [], "properties": [ { @@ -1327,7 +1327,7 @@ "kind": "property", "name": "principalId", "serializedName": "principalId", - "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.", + "doc": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.", "type": { "$id": "135", "kind": "string", @@ -1354,7 +1354,7 @@ "kind": "property", "name": "tenantId", "serializedName": "tenantId", - "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.", + "doc": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.", "type": { "$id": "138", "kind": "string", @@ -1381,7 +1381,7 @@ "kind": "property", "name": "type", "serializedName": "type", - "description": "The type of managed identity assigned to this resource.", + "doc": "The type of managed identity assigned to this resource.", "type": { "$ref": "18" }, @@ -1397,7 +1397,7 @@ "kind": "property", "name": "userAssignedIdentities", "serializedName": "userAssignedIdentities", - "description": "The identities assigned to this resource by the user.", + "doc": "The identities assigned to this resource by the user.", "type": { "$id": "142", "kind": "dict", @@ -1417,7 +1417,7 @@ "name": "UserAssignedIdentity", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.UserAssignedIdentity", "usage": "Output,Json", - "description": "User assigned identity properties", + "doc": "User assigned identity properties", "decorators": [], "properties": [ { @@ -1425,7 +1425,7 @@ "kind": "property", "name": "principalId", "serializedName": "principalId", - "description": "The principal ID of the assigned identity.", + "doc": "The principal ID of the assigned identity.", "type": { "$id": "147", "kind": "string", @@ -1452,7 +1452,7 @@ "kind": "property", "name": "clientId", "serializedName": "clientId", - "description": "The client ID of the assigned identity.", + "doc": "The client ID of the assigned identity.", "type": { "$id": "150", "kind": "string", @@ -1512,7 +1512,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "153", "kind": "url", @@ -1557,7 +1557,7 @@ "name": "StartRequest", "crossLanguageDefinitionId": "MgmtTypeSpec.StartRequest", "usage": "Input,Json", - "description": "Start SAP instance(s) request body.", + "doc": "Start SAP instance(s) request body.", "decorators": [], "properties": [ { @@ -1565,7 +1565,7 @@ "kind": "property", "name": "startVm", "serializedName": "startVm", - "description": "The boolean value indicates whether to start the virtual machines before starting the SAP instances.", + "doc": "The boolean value indicates whether to start the virtual machines before starting the SAP instances.", "type": { "$id": "157", "kind": "boolean", @@ -1588,7 +1588,7 @@ "name": "OperationStatusResult", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.OperationStatusResult", "usage": "Output,Json", - "description": "The current status of an async operation.", + "doc": "The current status of an async operation.", "decorators": [], "properties": [ { @@ -1596,7 +1596,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "Fully qualified ID for the async operation.", + "doc": "Fully qualified ID for the async operation.", "type": { "$id": "160", "kind": "string", @@ -1616,7 +1616,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "Name of the async operation.", + "doc": "Name of the async operation.", "type": { "$id": "162", "kind": "string", @@ -1636,7 +1636,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "Operation status.", + "doc": "Operation status.", "type": { "$id": "164", "kind": "string", @@ -1656,7 +1656,7 @@ "kind": "property", "name": "percentComplete", "serializedName": "percentComplete", - "description": "Percent of the operation that is complete.", + "doc": "Percent of the operation that is complete.", "type": { "$id": "166", "kind": "float64", @@ -1676,7 +1676,7 @@ "kind": "property", "name": "startTime", "serializedName": "startTime", - "description": "The start time of the operation.", + "doc": "The start time of the operation.", "type": { "$id": "168", "kind": "utcDateTime", @@ -1704,7 +1704,7 @@ "kind": "property", "name": "endTime", "serializedName": "endTime", - "description": "The end time of the operation.", + "doc": "The end time of the operation.", "type": { "$id": "171", "kind": "utcDateTime", @@ -1732,7 +1732,7 @@ "kind": "property", "name": "operations", "serializedName": "operations", - "description": "The operations list.", + "doc": "The operations list.", "type": { "$id": "174", "kind": "array", @@ -1755,7 +1755,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "If present, details of the operation error.", + "doc": "If present, details of the operation error.", "type": { "$ref": "95" }, @@ -1774,7 +1774,7 @@ "name": "OperationListResult", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.OperationListResult", "usage": "Output,Json", - "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "doc": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", "decorators": [], "properties": [ { @@ -1782,7 +1782,7 @@ "kind": "property", "name": "value", "serializedName": "value", - "description": "The Operation items on this page", + "doc": "The Operation items on this page", "type": { "$id": "178", "kind": "array", @@ -1793,7 +1793,7 @@ "name": "Operation", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.Operation", "usage": "Output,Json", - "description": "Details of a REST API operation, returned from the Resource Provider Operations API", + "doc": "Details of a REST API operation, returned from the Resource Provider Operations API", "decorators": [], "properties": [ { @@ -1801,7 +1801,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", + "doc": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", "type": { "$id": "181", "kind": "string", @@ -1821,7 +1821,7 @@ "kind": "property", "name": "isDataAction", "serializedName": "isDataAction", - "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for Azure Resource Manager/control-plane operations.", + "doc": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for Azure Resource Manager/control-plane operations.", "type": { "$id": "183", "kind": "boolean", @@ -1841,14 +1841,14 @@ "kind": "property", "name": "display", "serializedName": "display", - "description": "Localized display information for this particular operation.", + "doc": "Localized display information for this particular operation.", "type": { "$id": "185", "kind": "model", "name": "OperationDisplay", "crossLanguageDefinitionId": "Azure.ResourceManager.CommonTypes.OperationDisplay", "usage": "Output,Json", - "description": "Localized display information for and operation.", + "doc": "Localized display information for and operation.", "decorators": [], "properties": [ { @@ -1856,7 +1856,7 @@ "kind": "property", "name": "provider", "serializedName": "provider", - "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "doc": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", "type": { "$id": "187", "kind": "string", @@ -1876,7 +1876,7 @@ "kind": "property", "name": "resource", "serializedName": "resource", - "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "doc": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", "type": { "$id": "189", "kind": "string", @@ -1896,7 +1896,7 @@ "kind": "property", "name": "operation", "serializedName": "operation", - "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "doc": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", "type": { "$id": "191", "kind": "string", @@ -1916,7 +1916,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "doc": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", "type": { "$id": "193", "kind": "string", @@ -1945,7 +1945,7 @@ "kind": "property", "name": "origin", "serializedName": "origin", - "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "doc": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", "type": { "$ref": "28" }, @@ -1961,7 +1961,7 @@ "kind": "property", "name": "actionType", "serializedName": "actionType", - "description": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "doc": "Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", "type": { "$ref": "36" }, @@ -1989,7 +1989,7 @@ "kind": "property", "name": "nextLink", "serializedName": "nextLink", - "description": "The link to the next page of items", + "doc": "The link to the next page of items", "type": { "$id": "197", "kind": "url", @@ -2033,7 +2033,7 @@ "$id": "201", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "202", "kind": "url", @@ -2071,14 +2071,14 @@ "$id": "206", "Name": "list", "ResourceName": "Operations", - "Description": "List the operations for the provider", + "Doc": "List the operations for the provider", "Accessibility": "public", "Parameters": [ { "$id": "207", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "208", "kind": "string", @@ -2176,7 +2176,7 @@ "$id": "217", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "218", "kind": "url", @@ -2214,14 +2214,14 @@ "$id": "222", "Name": "GetAllPrivateLinkResources", "ResourceName": "PrivateLinkResource", - "Description": "list private links on the given resource", + "Doc": "list private links on the given resource", "Accessibility": "public", "Parameters": [ { "$id": "223", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "224", "kind": "string", @@ -2253,7 +2253,7 @@ "$id": "227", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "228", "kind": "string", @@ -2282,7 +2282,7 @@ "$id": "230", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "231", "kind": "string", @@ -2364,14 +2364,14 @@ "$id": "237", "Name": "start", "ResourceName": "PrivateLinks", - "Description": "Starts the SAP Application Server Instance.", + "Doc": "Starts the SAP Application Server Instance.", "Accessibility": "public", "Parameters": [ { "$id": "238", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "239", "kind": "string", @@ -2403,7 +2403,7 @@ "$id": "242", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "243", "kind": "string", @@ -2432,7 +2432,7 @@ "$id": "245", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "246", "kind": "string", @@ -2454,7 +2454,7 @@ "$id": "247", "Name": "privateLinkResourcenName", "NameInRequest": "privateLinkResourcenName", - "Description": "The name of the private link associated with the Azure resource.", + "Doc": "The name of the private link associated with the Azure resource.", "Type": { "$id": "248", "kind": "string", @@ -2476,7 +2476,7 @@ "$id": "249", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "250", "kind": "constant", @@ -2531,7 +2531,7 @@ "$id": "255", "Name": "body", "NameInRequest": "body", - "Description": "SAP Application server instance start request body.", + "Doc": "SAP Application server instance start request body.", "Type": { "$ref": "155" }, @@ -2558,7 +2558,7 @@ "$id": "257", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "258", "kind": "string", @@ -2571,7 +2571,7 @@ "$id": "259", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "260", "kind": "int32", @@ -2636,7 +2636,7 @@ "$id": "265", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "266", "kind": "url", @@ -2674,14 +2674,14 @@ "$id": "270", "Name": "createOrUpdate", "ResourceName": "Foo", - "Description": "Create a Foo", + "Doc": "Create a Foo", "Accessibility": "public", "Parameters": [ { "$id": "271", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "272", "kind": "string", @@ -2713,7 +2713,7 @@ "$id": "275", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "276", "kind": "string", @@ -2742,7 +2742,7 @@ "$id": "278", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "279", "kind": "string", @@ -2764,7 +2764,7 @@ "$id": "280", "Name": "fooName", "NameInRequest": "fooName", - "Description": "The name of the Foo", + "Doc": "The name of the Foo", "Type": { "$id": "281", "kind": "string", @@ -2786,7 +2786,7 @@ "$id": "282", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "283", "kind": "constant", @@ -2841,7 +2841,7 @@ "$id": "288", "Name": "resource", "NameInRequest": "resource", - "Description": "Resource create parameters.", + "Doc": "Resource create parameters.", "Type": { "$ref": "44" }, @@ -2886,7 +2886,7 @@ "$id": "291", "Name": "azureAsyncOperation", "NameInResponse": "Azure-AsyncOperation", - "Description": "A link to the status monitor", + "Doc": "A link to the status monitor", "Type": { "$id": "292", "kind": "string", @@ -2899,7 +2899,7 @@ "$id": "293", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "294", "kind": "int32", @@ -3162,14 +3162,14 @@ "$id": "328", "Name": "get", "ResourceName": "Foo", - "Description": "Get a Foo", + "Doc": "Get a Foo", "Accessibility": "public", "Parameters": [ { "$id": "329", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "330", "kind": "string", @@ -3201,7 +3201,7 @@ "$id": "333", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "334", "kind": "string", @@ -3230,7 +3230,7 @@ "$id": "336", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "337", "kind": "string", @@ -3252,7 +3252,7 @@ "$id": "338", "Name": "fooName", "NameInRequest": "fooName", - "Description": "The name of the Foo", + "Doc": "The name of the Foo", "Type": { "$id": "339", "kind": "string", @@ -3451,14 +3451,14 @@ "$id": "361", "Name": "delete", "ResourceName": "Foo", - "Description": "Delete a Foo", + "Doc": "Delete a Foo", "Accessibility": "public", "Parameters": [ { "$id": "362", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "363", "kind": "string", @@ -3490,7 +3490,7 @@ "$id": "366", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "367", "kind": "string", @@ -3519,7 +3519,7 @@ "$id": "369", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "370", "kind": "string", @@ -3541,7 +3541,7 @@ "$id": "371", "Name": "fooName", "NameInRequest": "fooName", - "Description": "The name of the Foo", + "Doc": "The name of the Foo", "Type": { "$id": "372", "kind": "string", @@ -3599,7 +3599,7 @@ "$id": "377", "Name": "location", "NameInResponse": "Location", - "Description": "The Location header contains the URL where the status of the long running operation can be checked.", + "Doc": "The Location header contains the URL where the status of the long running operation can be checked.", "Type": { "$id": "378", "kind": "string", @@ -3612,7 +3612,7 @@ "$id": "379", "Name": "retryAfter", "NameInResponse": "Retry-After", - "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "Doc": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "Type": { "$id": "380", "kind": "int32", @@ -3659,14 +3659,14 @@ "$id": "384", "Name": "list", "ResourceName": "Foo", - "Description": "List Foo resources by resource group", + "Doc": "List Foo resources by resource group", "Accessibility": "public", "Parameters": [ { "$id": "385", "Name": "apiVersion", "NameInRequest": "api-version", - "Description": "The API version to use for this operation.", + "Doc": "The API version to use for this operation.", "Type": { "$id": "386", "kind": "string", @@ -3698,7 +3698,7 @@ "$id": "389", "Name": "subscriptionId", "NameInRequest": "subscriptionId", - "Description": "The ID of the target subscription. The value must be an UUID.", + "Doc": "The ID of the target subscription. The value must be an UUID.", "Type": { "$id": "390", "kind": "string", @@ -3727,7 +3727,7 @@ "$id": "392", "Name": "resourceGroupName", "NameInRequest": "resourceGroupName", - "Description": "The name of the resource group. The name is case insensitive.", + "Doc": "The name of the resource group. The name is case insensitive.", "Type": { "$id": "393", "kind": "string", @@ -3815,7 +3815,7 @@ "$id": "400", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "401", "kind": "url", diff --git a/test/TestProjects/ModelReaderWriterValidation-TypeSpec/tspCodeModel.json b/test/TestProjects/ModelReaderWriterValidation-TypeSpec/tspCodeModel.json index 62bcdbfaebb..4792abac377 100644 --- a/test/TestProjects/ModelReaderWriterValidation-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/ModelReaderWriterValidation-TypeSpec/tspCodeModel.json @@ -31,7 +31,7 @@ "enumType": { "$ref": "2" }, - "description": "NotSpecified is not allowed.", + "doc": "NotSpecified is not allowed.", "decorators": [] }, { @@ -49,11 +49,11 @@ "enumType": { "$ref": "2" }, - "description": "Extract is the only allowed value.", + "doc": "Extract is the only allowed value.", "decorators": [] } ], - "description": "The type of alias pattern.", + "doc": "The type of alias pattern.", "isFixed": true, "isFlags": false, "usage": "Output,Json", @@ -87,7 +87,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is not specified.", + "doc": "The token type is not specified.", "decorators": [] }, { @@ -105,7 +105,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type can be anything.", + "doc": "The token type can be anything.", "decorators": [] }, { @@ -123,7 +123,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is string.", + "doc": "The token type is string.", "decorators": [] }, { @@ -141,7 +141,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is object.", + "doc": "The token type is object.", "decorators": [] }, { @@ -159,7 +159,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is array.", + "doc": "The token type is array.", "decorators": [] }, { @@ -177,7 +177,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is integer.", + "doc": "The token type is integer.", "decorators": [] }, { @@ -195,7 +195,7 @@ "enumType": { "$ref": "8" }, - "description": "The token type is number.", + "doc": "The token type is number.", "decorators": [] }, { @@ -213,11 +213,11 @@ "enumType": { "$ref": "8" }, - "description": "The token type is boolean.", + "doc": "The token type is boolean.", "decorators": [] } ], - "description": "The type of the token that the alias path is referring to.", + "doc": "The type of the token that the alias path is referring to.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -251,7 +251,7 @@ "enumType": { "$ref": "26" }, - "description": "The token that the alias path is referring to has no attributes.", + "doc": "The token that the alias path is referring to has no attributes.", "decorators": [] }, { @@ -269,11 +269,11 @@ "enumType": { "$ref": "26" }, - "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect.", + "doc": "The token that the alias path is referring to is modifiable by policies with 'modify' effect.", "decorators": [] } ], - "description": "The attributes of the token that the alias path is referring to.", + "doc": "The attributes of the token that the alias path is referring to.", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -307,7 +307,7 @@ "enumType": { "$ref": "32" }, - "description": "Alias type is unknown (same as not providing alias type).", + "doc": "Alias type is unknown (same as not providing alias type).", "decorators": [] }, { @@ -325,7 +325,7 @@ "enumType": { "$ref": "32" }, - "description": "Alias value is not secret.", + "doc": "Alias value is not secret.", "decorators": [] }, { @@ -343,11 +343,11 @@ "enumType": { "$ref": "32" }, - "description": "Alias value is secret.", + "doc": "Alias value is secret.", "decorators": [] } ], - "description": "The type of the alias.", + "doc": "The type of the alias.", "isFixed": true, "isFlags": false, "usage": "Output,Json", @@ -381,7 +381,7 @@ "enumType": { "$ref": "40" }, - "description": "The provider authorization consent state is not specified.", + "doc": "The provider authorization consent state is not specified.", "decorators": [] }, { @@ -399,7 +399,7 @@ "enumType": { "$ref": "40" }, - "description": "The provider authorization consent state is required.", + "doc": "The provider authorization consent state is required.", "decorators": [] }, { @@ -417,7 +417,7 @@ "enumType": { "$ref": "40" }, - "description": "The provider authorization consent state is not required.", + "doc": "The provider authorization consent state is not required.", "decorators": [] }, { @@ -435,11 +435,11 @@ "enumType": { "$ref": "40" }, - "description": "The provider authorization consent state is consented.", + "doc": "The provider authorization consent state is consented.", "decorators": [] } ], - "description": "The provider authorization consent state.", + "doc": "The provider authorization consent state.", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -453,7 +453,7 @@ "name": "ModelAsStruct", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ModelAsStruct", "usage": "Input,Output,Json", - "description": "The model to change to struct.", + "doc": "The model to change to struct.", "decorators": [], "properties": [ { @@ -461,7 +461,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property.", + "doc": "The id property.", "type": { "$id": "52", "kind": "int32", @@ -491,7 +491,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name.", + "doc": "The name.", "type": { "$id": "55", "kind": "string", @@ -511,7 +511,7 @@ "kind": "property", "name": "fields", "serializedName": "fields", - "description": "The fields property.", + "doc": "The fields property.", "type": { "$id": "57", "kind": "array", @@ -538,7 +538,7 @@ "kind": "property", "name": "nullProperty", "serializedName": "nullProperty", - "description": "The nullable property.", + "doc": "The nullable property.", "type": { "$id": "60", "kind": "int32", @@ -558,7 +558,7 @@ "kind": "property", "name": "keyValuePairs", "serializedName": "keyValuePairs", - "description": "The key value pairs property.", + "doc": "The key value pairs property.", "type": { "$id": "62", "kind": "dict", @@ -590,7 +590,7 @@ "kind": "property", "name": "xProperty", "serializedName": "xProperty", - "description": "The x property.", + "doc": "The x property.", "type": { "$id": "66", "kind": "int32", @@ -613,14 +613,14 @@ "name": "BaseModel", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.BaseModel", "usage": "Input,Output,Json", - "description": "The BaseModel in the discriminated set", + "doc": "The BaseModel in the discriminated set", "decorators": [], "discriminatorProperty": { "$id": "68", "kind": "property", "name": "kind", "serializedName": "kind", - "description": "The kind", + "doc": "The kind", "type": { "$id": "69", "kind": "string", @@ -644,7 +644,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property.", + "doc": "The name property.", "type": { "$id": "71", "kind": "string", @@ -668,7 +668,7 @@ "name": "ModelX", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ModelX", "usage": "Input,Output,Json", - "description": "The ModelX in the discriminated set", + "doc": "The ModelX in the discriminated set", "discriminatorValue": "X", "decorators": [], "baseModel": { @@ -705,7 +705,7 @@ "kind": "property", "name": "fields", "serializedName": "fields", - "description": "Optional list.", + "doc": "Optional list.", "type": { "$id": "78", "kind": "array", @@ -732,7 +732,7 @@ "kind": "property", "name": "nullProperty", "serializedName": "nullProperty", - "description": "Nullable integer.", + "doc": "Nullable integer.", "type": { "$id": "81", "kind": "int32", @@ -752,7 +752,7 @@ "kind": "property", "name": "keyValuePairs", "serializedName": "keyValuePairs", - "description": "Optional dictionary.", + "doc": "Optional dictionary.", "type": { "$id": "83", "kind": "dict", @@ -784,7 +784,7 @@ "kind": "property", "name": "xProperty", "serializedName": "xProperty", - "description": "The XProperty property.", + "doc": "The XProperty property.", "type": { "$id": "87", "kind": "int32", @@ -807,7 +807,7 @@ "name": "ModelY", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ModelY", "usage": "Input,Output,Json", - "description": "The ModelY in the discriminated set", + "doc": "The ModelY in the discriminated set", "discriminatorValue": "Y", "decorators": [], "baseModel": { @@ -844,7 +844,7 @@ "kind": "property", "name": "yProperty", "serializedName": "yProperty", - "description": "The YProperty property.", + "doc": "The YProperty property.", "type": { "$id": "93", "kind": "string", @@ -875,7 +875,7 @@ "name": "AvailabilitySetData", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.AvailabilitySetData", "usage": "Input,Output,Json", - "description": "The availability set data", + "doc": "The availability set data", "decorators": [], "baseModel": { "$id": "95", @@ -883,7 +883,7 @@ "name": "TrackedResourceData", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.TrackedResourceData", "usage": "Input,Output,Json", - "description": "The tracked resource data", + "doc": "The tracked resource data", "decorators": [], "properties": [ { @@ -891,7 +891,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property.", + "doc": "The id property.", "type": { "$id": "97", "kind": "string", @@ -911,7 +911,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property.", + "doc": "The name property.", "type": { "$id": "99", "kind": "string", @@ -931,7 +931,7 @@ "kind": "property", "name": "resourceType", "serializedName": "type", - "description": "The resource type.", + "doc": "The resource type.", "type": { "$id": "101", "kind": "string", @@ -951,7 +951,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The location property.", + "doc": "The location property.", "type": { "$id": "103", "kind": "string", @@ -971,7 +971,7 @@ "kind": "property", "name": "tags", "serializedName": "tags", - "description": "The tags property.", + "doc": "The tags property.", "type": { "$id": "105", "kind": "dict", @@ -1006,7 +1006,7 @@ "kind": "property", "name": "sku", "serializedName": "sku", - "description": "The sku.", + "doc": "The sku.", "type": { "$id": "109", "kind": "model", @@ -1020,7 +1020,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The sku name.", + "doc": "The sku name.", "type": { "$id": "111", "kind": "string", @@ -1040,7 +1040,7 @@ "kind": "property", "name": "tier", "serializedName": "tier", - "description": "Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**.", + "doc": "Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br /> **Standard**<br /><br /> **Basic**.", "type": { "$id": "113", "kind": "string", @@ -1060,7 +1060,7 @@ "kind": "property", "name": "capacity", "serializedName": "capacity", - "description": "Specifies the number of virtual machines in the scale set.", + "doc": "Specifies the number of virtual machines in the scale set.", "type": { "$id": "115", "kind": "int64", @@ -1089,14 +1089,14 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The properties property.", + "doc": "The properties property.", "type": { "$id": "117", "kind": "model", "name": "AvailabilitySetProperties", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.AvailabilitySetProperties", "usage": "Input,Output,Json", - "description": "The availability set properties", + "doc": "The availability set properties", "decorators": [], "properties": [ { @@ -1104,7 +1104,7 @@ "kind": "property", "name": "virtualMachines", "serializedName": "virtualMachines", - "description": "The virtual machines.", + "doc": "The virtual machines.", "type": { "$id": "119", "kind": "array", @@ -1115,7 +1115,7 @@ "name": "WritableSubResource", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.WritableSubResource", "usage": "Input,Output,Json", - "description": "The writable sub resource", + "doc": "The writable sub resource", "decorators": [], "properties": [ { @@ -1123,7 +1123,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The resource id", + "doc": "The resource id", "type": { "$id": "122", "kind": "string", @@ -1155,7 +1155,7 @@ "kind": "property", "name": "platformFaultDomainCount", "serializedName": "platformFaultDomainCount", - "description": "The platform fault domain count property.", + "doc": "The platform fault domain count property.", "type": { "$id": "124", "kind": "int32", @@ -1175,7 +1175,7 @@ "kind": "property", "name": "platformUpdateDomainCount", "serializedName": "platformUpdateDomainCount", - "description": "The platform update domain count property.", + "doc": "The platform update domain count property.", "type": { "$id": "126", "kind": "int32", @@ -1219,7 +1219,7 @@ "name": "ResourceProviderData", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ResourceProviderData", "usage": "Output,Json", - "description": "A class representing the ResourceProvider data model.\nResource provider information.", + "doc": "A class representing the ResourceProvider data model.\nResource provider information.", "decorators": [], "properties": [ { @@ -1227,7 +1227,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The provider ID.", + "doc": "The provider ID.", "type": { "$id": "129", "kind": "string", @@ -1247,7 +1247,7 @@ "kind": "property", "name": "namespace", "serializedName": "namespace", - "description": "The namespace of the resource provider.", + "doc": "The namespace of the resource provider.", "type": { "$id": "131", "kind": "string", @@ -1267,7 +1267,7 @@ "kind": "property", "name": "registrationState", "serializedName": "registrationState", - "description": "The registration state of the resource provider.", + "doc": "The registration state of the resource provider.", "type": { "$id": "133", "kind": "string", @@ -1287,7 +1287,7 @@ "kind": "property", "name": "registrationPolicy", "serializedName": "registrationPolicy", - "description": "The registration policy of the resource provider.", + "doc": "The registration policy of the resource provider.", "type": { "$id": "135", "kind": "string", @@ -1307,7 +1307,7 @@ "kind": "property", "name": "resourceTypes", "serializedName": "resourceTypes", - "description": "The collection of provider resource types.", + "doc": "The collection of provider resource types.", "type": { "$id": "137", "kind": "array", @@ -1325,7 +1325,7 @@ "kind": "property", "name": "resourceType", "serializedName": "resourceType", - "description": "The resource type.", + "doc": "The resource type.", "type": { "$id": "140", "kind": "string", @@ -1345,7 +1345,7 @@ "kind": "property", "name": "locations", "serializedName": "locations", - "description": "The collection of locations where this resource type can be created.", + "doc": "The collection of locations where this resource type can be created.", "type": { "$id": "142", "kind": "array", @@ -1372,7 +1372,7 @@ "kind": "property", "name": "locationMappings", "serializedName": "locationMappings", - "description": "The location mappings that are supported by this resource type.", + "doc": "The location mappings that are supported by this resource type.", "type": { "$id": "145", "kind": "array", @@ -1383,7 +1383,7 @@ "name": "ProviderExtendedLocation", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ProviderExtendedLocation", "usage": "Output,Json", - "description": "The provider extended location.", + "doc": "The provider extended location.", "decorators": [], "properties": [ { @@ -1391,7 +1391,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The azure location.", + "doc": "The azure location.", "type": { "$id": "148", "kind": "string", @@ -1411,7 +1411,7 @@ "kind": "property", "name": "providerExtendedLocationType", "serializedName": "type", - "description": "The extended location type.", + "doc": "The extended location type.", "type": { "$id": "150", "kind": "string", @@ -1431,7 +1431,7 @@ "kind": "property", "name": "extendedLocations", "serializedName": "extendedLocations", - "description": "The extended locations for the azure location.", + "doc": "The extended locations for the azure location.", "type": { "$id": "152", "kind": "array", @@ -1470,7 +1470,7 @@ "kind": "property", "name": "aliases", "serializedName": "aliases", - "description": "The aliases that are supported by this resource type.", + "doc": "The aliases that are supported by this resource type.", "type": { "$id": "155", "kind": "array", @@ -1481,7 +1481,7 @@ "name": "ResourceTypeAlias", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ResourceTypeAlias", "usage": "Output,Json", - "description": "The alias type.", + "doc": "The alias type.", "decorators": [], "properties": [ { @@ -1489,7 +1489,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The alias name.", + "doc": "The alias name.", "type": { "$id": "158", "kind": "string", @@ -1509,7 +1509,7 @@ "kind": "property", "name": "paths", "serializedName": "paths", - "description": "The paths for an alias.", + "doc": "The paths for an alias.", "type": { "$id": "160", "kind": "array", @@ -1520,7 +1520,7 @@ "name": "ResourceTypeAliasPath", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ResourceTypeAliasPath", "usage": "Output,Json", - "description": "The type of the paths for alias.", + "doc": "The type of the paths for alias.", "decorators": [], "properties": [ { @@ -1528,7 +1528,7 @@ "kind": "property", "name": "path", "serializedName": "path", - "description": "The path of an alias.", + "doc": "The path of an alias.", "type": { "$id": "163", "kind": "string", @@ -1548,7 +1548,7 @@ "kind": "property", "name": "apiVersions", "serializedName": "apiVersions", - "description": "The API versions.", + "doc": "The API versions.", "type": { "$id": "165", "kind": "array", @@ -1575,14 +1575,14 @@ "kind": "property", "name": "pattern", "serializedName": "pattern", - "description": "The pattern for an alias path.", + "doc": "The pattern for an alias path.", "type": { "$id": "168", "kind": "model", "name": "ResourceTypeAliasPattern", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ResourceTypeAliasPattern", "usage": "Output,Json", - "description": "The type of the pattern for an alias path.", + "doc": "The type of the pattern for an alias path.", "decorators": [], "properties": [ { @@ -1590,7 +1590,7 @@ "kind": "property", "name": "phrase", "serializedName": "phrase", - "description": "The alias pattern phrase.", + "doc": "The alias pattern phrase.", "type": { "$id": "170", "kind": "string", @@ -1610,7 +1610,7 @@ "kind": "property", "name": "variable", "serializedName": "variable", - "description": "The alias pattern variable.", + "doc": "The alias pattern variable.", "type": { "$id": "172", "kind": "string", @@ -1630,7 +1630,7 @@ "kind": "property", "name": "patternType", "serializedName": "patternType", - "description": "The type of alias pattern.", + "doc": "The type of alias pattern.", "type": { "$ref": "2" }, @@ -1655,14 +1655,14 @@ "kind": "property", "name": "metadata", "serializedName": "metadata", - "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.", + "doc": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.", "type": { "$id": "175", "kind": "model", "name": "ResourceTypeAliasPathMetadata", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ResourceTypeAliasPathMetadata", "usage": "Input,Output,Json", - "description": "The ResourceTypeAliasPathMetadata.", + "doc": "The ResourceTypeAliasPathMetadata.", "decorators": [], "properties": [ { @@ -1670,7 +1670,7 @@ "kind": "property", "name": "tokenType", "serializedName": "tokenType", - "description": "The type of the token that the alias path is referring to.", + "doc": "The type of the token that the alias path is referring to.", "type": { "$ref": "8" }, @@ -1686,7 +1686,7 @@ "kind": "property", "name": "attributes", "serializedName": "attributes", - "description": "The attributes of the token that the alias path is referring to.", + "doc": "The attributes of the token that the alias path is referring to.", "type": { "$ref": "26" }, @@ -1723,7 +1723,7 @@ "kind": "property", "name": "aliasType", "serializedName": "aliasType", - "description": "The type of the alias.", + "doc": "The type of the alias.", "type": { "$ref": "32" }, @@ -1739,7 +1739,7 @@ "kind": "property", "name": "defaultPath", "serializedName": "defaultPath", - "description": "The default path for an alias.", + "doc": "The default path for an alias.", "type": { "$id": "180", "kind": "string", @@ -1759,7 +1759,7 @@ "kind": "property", "name": "defaultPattern", "serializedName": "defaultPattern", - "description": "The default pattern for an alias.", + "doc": "The default pattern for an alias.", "type": { "$ref": "168" }, @@ -1775,7 +1775,7 @@ "kind": "property", "name": "defaultMetadata", "serializedName": "defaultMetadata", - "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata.", + "doc": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata.", "type": { "$ref": "175" }, @@ -1803,7 +1803,7 @@ "kind": "property", "name": "apiVersions", "serializedName": "apiVersions", - "description": "The API version.", + "doc": "The API version.", "type": { "$id": "184", "kind": "array", @@ -1830,7 +1830,7 @@ "kind": "property", "name": "defaultApiVersion", "serializedName": "defaultApiVersion", - "description": "The default API version.", + "doc": "The default API version.", "type": { "$id": "187", "kind": "string", @@ -1850,7 +1850,7 @@ "kind": "property", "name": "zoneMappings", "serializedName": "zoneMappings", - "description": "Gets the zone mappings.", + "doc": "Gets the zone mappings.", "type": { "$id": "189", "kind": "array", @@ -1861,7 +1861,7 @@ "name": "ZoneMapping", "crossLanguageDefinitionId": "ModelReaderWriterValidationTypeSpec.ZoneMapping", "usage": "Output,Json", - "description": "The ZoneMapping.", + "doc": "The ZoneMapping.", "decorators": [], "properties": [ { @@ -1869,7 +1869,7 @@ "kind": "property", "name": "location", "serializedName": "location", - "description": "The location of the zone mapping.", + "doc": "The location of the zone mapping.", "type": { "$id": "192", "kind": "string", @@ -1889,7 +1889,7 @@ "kind": "property", "name": "zones", "serializedName": "zones", - "description": "The zones.", + "doc": "The zones.", "type": { "$id": "194", "kind": "array", @@ -1928,7 +1928,7 @@ "kind": "property", "name": "apiProfiles", "serializedName": "apiProfiles", - "description": "The API profiles for the resource provider.", + "doc": "The API profiles for the resource provider.", "type": { "$id": "197", "kind": "array", @@ -1946,7 +1946,7 @@ "kind": "property", "name": "profileVersion", "serializedName": "profileVersion", - "description": "The profile version.", + "doc": "The profile version.", "type": { "$id": "200", "kind": "string", @@ -1966,7 +1966,7 @@ "kind": "property", "name": "apiVersion", "serializedName": "apiVersion", - "description": "The API version.", + "doc": "The API version.", "type": { "$id": "202", "kind": "string", @@ -1998,7 +1998,7 @@ "kind": "property", "name": "capabilities", "serializedName": "capabilities", - "description": "The additional capabilities offered by this resource type.", + "doc": "The additional capabilities offered by this resource type.", "type": { "$id": "204", "kind": "string", @@ -2018,7 +2018,7 @@ "kind": "property", "name": "properties", "serializedName": "properties", - "description": "The properties.", + "doc": "The properties.", "type": { "$id": "206", "kind": "dict", @@ -2062,7 +2062,7 @@ "kind": "property", "name": "providerAuthorizationConsentState", "serializedName": "providerAuthorizationConsentState", - "description": "The provider authorization consent state.", + "doc": "The provider authorization consent state.", "type": { "$ref": "40" }, @@ -2119,7 +2119,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property.", + "doc": "The id property.", "type": { "$id": "213", "kind": "string", @@ -2139,7 +2139,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property.", + "doc": "The name property.", "type": { "$id": "215", "kind": "string", @@ -2159,7 +2159,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property.", + "doc": "The age property.", "type": { "$id": "217", "kind": "int32", @@ -2199,7 +2199,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property.", + "doc": "The id property.", "type": { "$id": "221", "kind": "string", @@ -2219,7 +2219,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property.", + "doc": "The name property.", "type": { "$id": "223", "kind": "string", @@ -2239,7 +2239,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property.", + "doc": "The age property.", "type": { "$id": "225", "kind": "int32", @@ -2276,7 +2276,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The id property.", + "doc": "The id property.", "type": { "$id": "229", "kind": "string", @@ -2296,7 +2296,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name property.", + "doc": "The name property.", "type": { "$id": "231", "kind": "string", @@ -2316,7 +2316,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "The age property.", + "doc": "The age property.", "type": { "$id": "233", "kind": "int32", @@ -2338,7 +2338,7 @@ { "$id": "234", "Name": "ModelReaderWriterValidationTypeSpecClient", - "Description": "This is a typespec project to validation the model reader writer functionalities.", + "Doc": "This is a typespec project to validation the model reader writer functionalities.", "Operations": [ { "$id": "235", @@ -2350,7 +2350,7 @@ "$id": "236", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "237", "kind": "constant", @@ -2459,7 +2459,7 @@ "$id": "245", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "246", "kind": "constant", @@ -2568,7 +2568,7 @@ "$id": "254", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "255", "kind": "constant", @@ -2677,7 +2677,7 @@ "$id": "263", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "264", "kind": "constant", @@ -2847,7 +2847,7 @@ "$id": "277", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "278", "kind": "constant", @@ -2956,7 +2956,7 @@ "$id": "286", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "287", "kind": "constant", @@ -3065,7 +3065,7 @@ "$id": "295", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "296", "kind": "constant", diff --git a/test/TestProjects/NoDocs-TypeSpec/tspCodeModel.json b/test/TestProjects/NoDocs-TypeSpec/tspCodeModel.json index 4a3c5de9381..6754d4e4fb7 100644 --- a/test/TestProjects/NoDocs-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/NoDocs-TypeSpec/tspCodeModel.json @@ -22,7 +22,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -32,7 +32,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -55,7 +55,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -65,7 +65,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -88,7 +88,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -98,7 +98,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -121,7 +121,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -131,7 +131,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -154,7 +154,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -164,7 +164,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -187,7 +187,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -197,7 +197,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -268,7 +268,7 @@ "decorators": [] } ], - "description": "enum with projected name", + "doc": "enum with projected name", "isFixed": true, "isFlags": false, "usage": "Input", @@ -339,7 +339,7 @@ "decorators": [] } ], - "description": "enum with projected name used in a model", + "doc": "enum with projected name used in a model", "isFixed": true, "isFlags": false, "usage": "Input,Json", @@ -410,7 +410,7 @@ "decorators": [] } ], - "description": "Simple enum", + "doc": "Simple enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -481,7 +481,7 @@ "decorators": [] } ], - "description": "Extensible enum", + "doc": "Extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -552,7 +552,7 @@ "decorators": [] } ], - "description": "Int based extensible enum", + "doc": "Int based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -623,7 +623,7 @@ "decorators": [] } ], - "description": "Float based extensible enum", + "doc": "Float based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -694,7 +694,7 @@ "decorators": [] } ], - "description": "float fixed enum", + "doc": "float fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -765,7 +765,7 @@ "decorators": [] } ], - "description": "int fixed enum", + "doc": "int fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -953,7 +953,7 @@ "name": "Thing", "crossLanguageDefinitionId": "NoDocsTypeSpec.Thing", "usage": "Input,Output,Spread,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -961,7 +961,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "106", "kind": "string", @@ -981,7 +981,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "108", "kind": "union", @@ -1030,7 +1030,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "114", "kind": "constant", @@ -1052,7 +1052,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "116", "kind": "constant", @@ -1074,7 +1074,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "118", "kind": "constant", @@ -1096,7 +1096,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "120", "kind": "constant", @@ -1122,7 +1122,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "123", "kind": "constant", @@ -1144,7 +1144,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "125", "kind": "constant", @@ -1166,7 +1166,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "127", "kind": "constant", @@ -1188,7 +1188,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "129", "kind": "constant", @@ -1214,7 +1214,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "132", "kind": "string", @@ -1234,7 +1234,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "134", "kind": "nullable", @@ -1265,7 +1265,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "138", "kind": "nullable", @@ -1299,7 +1299,7 @@ "name": "Friend", "crossLanguageDefinitionId": "NoDocsTypeSpec.NotFriend", "usage": "Output,Spread,Json", - "description": "this is not a friendly model but with a friendly name", + "doc": "this is not a friendly model but with a friendly name", "decorators": [], "properties": [ { @@ -1307,7 +1307,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the NotFriend", + "doc": "name of the NotFriend", "type": { "$id": "143", "kind": "string", @@ -1330,7 +1330,7 @@ "name": "ProjectedModel", "crossLanguageDefinitionId": "NoDocsTypeSpec.ModelWithProjectedName", "usage": "Output,Spread,Json", - "description": "this is a model with a projected name", + "doc": "this is a model with a projected name", "decorators": [], "properties": [ { @@ -1338,7 +1338,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelWithProjectedName", + "doc": "name of the ModelWithProjectedName", "type": { "$id": "146", "kind": "string", @@ -1370,7 +1370,7 @@ "name": "Extension", "crossLanguageDefinitionId": "NoDocsTypeSpec.Extension", "usage": "Input,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "149", @@ -1378,7 +1378,7 @@ "name": "Element", "crossLanguageDefinitionId": "NoDocsTypeSpec.Element", "usage": "Input,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -1436,7 +1436,7 @@ "name": "Extendible", "crossLanguageDefinitionId": "NoDocsTypeSpec.Extendible", "usage": "Input,Json", - "description": "FHIR extendible element", + "doc": "FHIR extendible element", "decorators": [], "properties": [ { @@ -1444,7 +1444,7 @@ "kind": "property", "name": "extension", "serializedName": "extension", - "description": "Additional Content defined by implementations", + "doc": "Additional Content defined by implementations", "type": { "$id": "156", "kind": "array", @@ -1455,7 +1455,7 @@ "name": "ThereLevelExtension", "crossLanguageDefinitionId": "NoDocsTypeSpec.ThereLevelExtension", "usage": "Input,Json", - "description": "extension", + "doc": "extension", "decorators": [], "baseModel": { "$id": "158", @@ -1463,7 +1463,7 @@ "name": "ThereLevelElement", "crossLanguageDefinitionId": "NoDocsTypeSpec.ThereLevelElement", "usage": "Input,Json", - "description": "element", + "doc": "element", "decorators": [], "properties": [ { @@ -1536,7 +1536,7 @@ "name": "ChildModel", "crossLanguageDefinitionId": "NoDocsTypeSpec.ChildModel", "usage": "Input,Json", - "description": "ChildModel", + "doc": "ChildModel", "decorators": [], "baseModel": { "$id": "164", @@ -1544,7 +1544,7 @@ "name": "BaseModel", "crossLanguageDefinitionId": "NoDocsTypeSpec.BaseModel", "usage": "Input,Json", - "description": "parenetModel", + "doc": "parenetModel", "decorators": [], "properties": [ { @@ -1602,7 +1602,7 @@ "name": "ContainSelf", "crossLanguageDefinitionId": "NoDocsTypeSpec.ContainSelf", "usage": "Input,Json", - "description": "containself", + "doc": "containself", "decorators": [], "properties": [ { @@ -1635,7 +1635,7 @@ "kind": "property", "name": "enumProperty", "serializedName": "enumProperty", - "description": "enum with projected name used in a model", + "doc": "enum with projected name used in a model", "type": { "$ref": "28" }, @@ -1690,7 +1690,7 @@ "name": "RoundTripModel", "crossLanguageDefinitionId": "NoDocsTypeSpec.RoundTripModel", "usage": "Input,Output,Json", - "description": "this is a roundtrip model", + "doc": "this is a roundtrip model", "decorators": [], "properties": [ { @@ -1698,7 +1698,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "Required string, illustrating a reference type property.", + "doc": "Required string, illustrating a reference type property.", "type": { "$id": "179", "kind": "string", @@ -1718,7 +1718,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int, illustrating a value type property.", + "doc": "Required int, illustrating a value type property.", "type": { "$id": "181", "kind": "int32", @@ -1738,7 +1738,7 @@ "kind": "property", "name": "requiredCollection", "serializedName": "requiredCollection", - "description": "Required collection of enums", + "doc": "Required collection of enums", "type": { "$id": "183", "kind": "array", @@ -1761,7 +1761,7 @@ "kind": "property", "name": "requiredDictionary", "serializedName": "requiredDictionary", - "description": "Required dictionary of enums", + "doc": "Required dictionary of enums", "type": { "$id": "185", "kind": "dict", @@ -1789,7 +1789,7 @@ "kind": "property", "name": "requiredModel", "serializedName": "requiredModel", - "description": "Required model", + "doc": "Required model", "type": { "$ref": "104" }, @@ -1805,7 +1805,7 @@ "kind": "property", "name": "intExtensibleEnum", "serializedName": "intExtensibleEnum", - "description": "this is an int based extensible enum", + "doc": "this is an int based extensible enum", "type": { "$ref": "52" }, @@ -1821,7 +1821,7 @@ "kind": "property", "name": "intExtensibleEnumCollection", "serializedName": "intExtensibleEnumCollection", - "description": "this is a collection of int based extensible enum", + "doc": "this is a collection of int based extensible enum", "type": { "$id": "190", "kind": "array", @@ -1844,7 +1844,7 @@ "kind": "property", "name": "floatExtensibleEnum", "serializedName": "floatExtensibleEnum", - "description": "this is a float based extensible enum", + "doc": "this is a float based extensible enum", "type": { "$ref": "60" }, @@ -1860,7 +1860,7 @@ "kind": "property", "name": "floatExtensibleEnumCollection", "serializedName": "floatExtensibleEnumCollection", - "description": "this is a collection of float based extensible enum", + "doc": "this is a collection of float based extensible enum", "type": { "$id": "193", "kind": "array", @@ -1883,7 +1883,7 @@ "kind": "property", "name": "floatFixedEnum", "serializedName": "floatFixedEnum", - "description": "this is a float based fixed enum", + "doc": "this is a float based fixed enum", "type": { "$ref": "68" }, @@ -1899,7 +1899,7 @@ "kind": "property", "name": "floatFixedEnumCollection", "serializedName": "floatFixedEnumCollection", - "description": "this is a collection of float based fixed enum", + "doc": "this is a collection of float based fixed enum", "type": { "$id": "196", "kind": "array", @@ -1922,7 +1922,7 @@ "kind": "property", "name": "intFixedEnum", "serializedName": "intFixedEnum", - "description": "this is a int based fixed enum", + "doc": "this is a int based fixed enum", "type": { "$ref": "76" }, @@ -1938,7 +1938,7 @@ "kind": "property", "name": "intFixedEnumCollection", "serializedName": "intFixedEnumCollection", - "description": "this is a collection of int based fixed enum", + "doc": "this is a collection of int based fixed enum", "type": { "$id": "199", "kind": "array", @@ -1961,7 +1961,7 @@ "kind": "property", "name": "stringFixedEnum", "serializedName": "stringFixedEnum", - "description": "this is a string based fixed enum", + "doc": "this is a string based fixed enum", "type": { "$ref": "36" }, @@ -1977,7 +1977,7 @@ "kind": "property", "name": "requiredUnknown", "serializedName": "requiredUnknown", - "description": "required unknown", + "doc": "required unknown", "type": { "$id": "202", "kind": "unknown", @@ -1997,7 +1997,7 @@ "kind": "property", "name": "optionalUnknown", "serializedName": "optionalUnknown", - "description": "optional unknown", + "doc": "optional unknown", "type": { "$id": "204", "kind": "unknown", @@ -2017,7 +2017,7 @@ "kind": "property", "name": "requiredRecordUnknown", "serializedName": "requiredRecordUnknown", - "description": "required record of unknown", + "doc": "required record of unknown", "type": { "$id": "206", "kind": "dict", @@ -2049,7 +2049,7 @@ "kind": "property", "name": "optionalRecordUnknown", "serializedName": "optionalRecordUnknown", - "description": "optional record of unknown", + "doc": "optional record of unknown", "type": { "$id": "210", "kind": "dict", @@ -2081,7 +2081,7 @@ "kind": "property", "name": "readOnlyRequiredRecordUnknown", "serializedName": "readOnlyRequiredRecordUnknown", - "description": "required readonly record of unknown", + "doc": "required readonly record of unknown", "type": { "$id": "214", "kind": "dict", @@ -2113,7 +2113,7 @@ "kind": "property", "name": "readOnlyOptionalRecordUnknown", "serializedName": "readOnlyOptionalRecordUnknown", - "description": "optional readonly record of unknown", + "doc": "optional readonly record of unknown", "type": { "$id": "218", "kind": "dict", @@ -2145,14 +2145,14 @@ "kind": "property", "name": "modelWithRequiredNullable", "serializedName": "modelWithRequiredNullable", - "description": "this is a model with required nullable properties", + "doc": "this is a model with required nullable properties", "type": { "$id": "222", "kind": "model", "name": "ModelWithRequiredNullableProperties", "crossLanguageDefinitionId": "NoDocsTypeSpec.ModelWithRequiredNullableProperties", "usage": "Input,Output,Json", - "description": "A model with a few required nullable properties", + "doc": "A model with a few required nullable properties", "decorators": [], "properties": [ { @@ -2160,7 +2160,7 @@ "kind": "property", "name": "requiredNullablePrimitive", "serializedName": "requiredNullablePrimitive", - "description": "required nullable primitive type", + "doc": "required nullable primitive type", "type": { "$id": "224", "kind": "nullable", @@ -2184,7 +2184,7 @@ "kind": "property", "name": "requiredExtensibleEnum", "serializedName": "requiredExtensibleEnum", - "description": "required nullable extensible enum type", + "doc": "required nullable extensible enum type", "type": { "$id": "227", "kind": "nullable", @@ -2204,7 +2204,7 @@ "kind": "property", "name": "requiredFixedEnum", "serializedName": "requiredFixedEnum", - "description": "required nullable fixed enum type", + "doc": "required nullable fixed enum type", "type": { "$id": "229", "kind": "nullable", @@ -2233,7 +2233,7 @@ "kind": "property", "name": "unionList", "serializedName": "unionList", - "description": "this is a list of union types", + "doc": "this is a list of union types", "type": { "$id": "231", "kind": "array", @@ -2263,7 +2263,7 @@ "name": "ModelForUnion", "crossLanguageDefinitionId": "NoDocsTypeSpec.ModelForUnion", "usage": "Input,Output,Json", - "description": "This is a model only used in union types, please do not use it anywhere else.", + "doc": "This is a model only used in union types, please do not use it anywhere else.", "decorators": [], "properties": [ { @@ -2271,7 +2271,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelForUnion", + "doc": "name of the ModelForUnion", "type": { "$id": "237", "kind": "string", @@ -2291,7 +2291,7 @@ "kind": "property", "name": "age", "serializedName": "age", - "description": "age of the ModelForUnion", + "doc": "age of the ModelForUnion", "type": { "$id": "239", "kind": "int32", @@ -2344,13 +2344,13 @@ { "$id": "241", "Name": "NoDocsTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "242", "Name": "topAction", "ResourceName": "NoDocsTypeSpec", - "Description": "top level method", + "Doc": "top level method", "Accessibility": "public", "Parameters": [ { @@ -2412,14 +2412,14 @@ "$id": "247", "Name": "patchAction", "ResourceName": "NoDocsTypeSpec", - "Description": "top level patch", + "Doc": "top level patch", "Accessibility": "public", "Parameters": [ { "$id": "248", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "249", "kind": "constant", @@ -2522,14 +2522,14 @@ "$id": "256", "Name": "anonymousBody", "ResourceName": "NoDocsTypeSpec", - "Description": "body parameter without body decorator", + "Doc": "body parameter without body decorator", "Accessibility": "public", "Parameters": [ { "$id": "257", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "258", "kind": "constant", @@ -2632,14 +2632,14 @@ "$id": "265", "Name": "friendlyModel", "ResourceName": "NoDocsTypeSpec", - "Description": "Model can have its friendly name", + "Doc": "Model can have its friendly name", "Accessibility": "public", "Parameters": [ { "$id": "266", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "267", "kind": "constant", @@ -2799,14 +2799,14 @@ "$id": "279", "Name": "projectedNameModel", "ResourceName": "NoDocsTypeSpec", - "Description": "Model can have its projected name", + "Doc": "Model can have its projected name", "Accessibility": "public", "Parameters": [ { "$id": "280", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "281", "kind": "constant", @@ -2909,7 +2909,7 @@ "$id": "288", "Name": "returnsAnonymousModel", "ResourceName": "NoDocsTypeSpec", - "Description": "return anonymous model", + "Doc": "return anonymous model", "Accessibility": "public", "Parameters": [ { @@ -2971,7 +2971,7 @@ "$id": "293", "Name": "headAsBoolean", "ResourceName": "NoDocsTypeSpec", - "Description": "head as boolean.", + "Doc": "head as boolean.", "Accessibility": "public", "Parameters": [ { @@ -3021,14 +3021,14 @@ "$id": "297", "Name": "stringBody", "ResourceName": "NoDocsTypeSpec", - "Description": "The body parameter type is string.", + "Doc": "The body parameter type is string.", "Accessibility": "public", "Parameters": [ { "$id": "298", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "299", "kind": "constant", @@ -3102,14 +3102,14 @@ "$id": "304", "Name": "boolBody", "ResourceName": "NoDocsTypeSpec", - "Description": "The body parameter type is bool.", + "Doc": "The body parameter type is bool.", "Accessibility": "public", "Parameters": [ { "$id": "305", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "306", "kind": "constant", @@ -3183,14 +3183,14 @@ "$id": "311", "Name": "dateTimeBody", "ResourceName": "NoDocsTypeSpec", - "Description": "The body parameter type is datetime.", + "Doc": "The body parameter type is datetime.", "Accessibility": "public", "Parameters": [ { "$id": "312", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "313", "kind": "constant", @@ -3272,7 +3272,7 @@ "$id": "319", "Name": "returnString", "ResourceName": "NoDocsTypeSpec", - "Description": "The return type is datetime.", + "Doc": "The return type is datetime.", "Accessibility": "public", "Parameters": [ { @@ -3403,14 +3403,14 @@ "$id": "331", "Name": "recursiveExtension", "ResourceName": "NoDocsTypeSpec", - "Description": "test parent reference child", + "Doc": "test parent reference child", "Accessibility": "public", "Parameters": [ { "$id": "332", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "333", "kind": "constant", @@ -3480,14 +3480,14 @@ "$id": "337", "Name": "threeLevelRecursive", "ResourceName": "NoDocsTypeSpec", - "Description": "test three level recursive extension", + "Doc": "test three level recursive extension", "Accessibility": "public", "Parameters": [ { "$id": "338", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "339", "kind": "constant", @@ -3557,14 +3557,14 @@ "$id": "343", "Name": "recursiveModels", "ResourceName": "NoDocsTypeSpec", - "Description": "test child reference parent", + "Doc": "test child reference parent", "Accessibility": "public", "Parameters": [ { "$id": "344", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "345", "kind": "constant", @@ -3634,14 +3634,14 @@ "$id": "349", "Name": "ContainSelfModels", "ResourceName": "NoDocsTypeSpec", - "Description": "test contain self models", + "Doc": "test contain self models", "Accessibility": "public", "Parameters": [ { "$id": "350", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "351", "kind": "constant", @@ -3711,7 +3711,7 @@ "$id": "355", "Name": "enumParameter", "ResourceName": "NoDocsTypeSpec", - "Description": "test enum parameter.", + "Doc": "test enum parameter.", "Accessibility": "public", "Parameters": [ { @@ -3757,14 +3757,14 @@ "$id": "358", "Name": "bodyIsModelWithProjectedEnum", "ResourceName": "NoDocsTypeSpec", - "Description": "test enum parameter.", + "Doc": "test enum parameter.", "Accessibility": "public", "Parameters": [ { "$id": "359", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "360", "kind": "constant", @@ -3834,14 +3834,14 @@ "$id": "364", "Name": "optionalDictionary", "ResourceName": "NoDocsTypeSpec", - "Description": "test optional dictionary.", + "Doc": "test optional dictionary.", "Accessibility": "public", "Parameters": [ { "$id": "365", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "366", "kind": "constant", @@ -3927,7 +3927,7 @@ "$id": "373", "Name": "azureLocationOp", "ResourceName": "NoDocsTypeSpec", - "Description": "test optional dictionary.", + "Doc": "test optional dictionary.", "Accessibility": "public", "Parameters": [ { @@ -3990,7 +3990,7 @@ "$id": "380", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "381", "kind": "constant", @@ -4119,13 +4119,13 @@ { "$id": "392", "Name": "HelloDemo", - "Description": "Hello world service", + "Doc": "Hello world service", "Operations": [ { "$id": "393", "Name": "sayHi", "ResourceName": "Demo", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -4283,7 +4283,7 @@ "$id": "408", "Name": "helloAgain", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -4434,7 +4434,7 @@ "$id": "421", "Name": "noContentType", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -4483,7 +4483,7 @@ "$id": "426", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "427", "kind": "constant", @@ -4586,7 +4586,7 @@ "$id": "434", "Name": "helloDemoAgain", "ResourceName": "Demo2", - "Description": "Return hi in demo2", + "Doc": "Return hi in demo2", "Accessibility": "public", "Parameters": [ { @@ -4648,14 +4648,14 @@ "$id": "439", "Name": "createLiteral", "ResourceName": "Demo2", - "Description": "Create with literal value", + "Doc": "Create with literal value", "Accessibility": "public", "Parameters": [ { "$id": "440", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "441", "kind": "constant", @@ -4758,7 +4758,7 @@ "$id": "448", "Name": "helloLiteral", "ResourceName": "Demo2", - "Description": "Send literal parameters", + "Doc": "Send literal parameters", "Accessibility": "public", "Parameters": [ { @@ -4934,14 +4934,14 @@ "$id": "466", "Name": "createUnknownValue", "ResourceName": "EnumTest", - "Description": "get extensible enum", + "Doc": "get extensible enum", "Accessibility": "public", "Parameters": [ { "$id": "467", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "468", "kind": "constant", @@ -5044,14 +5044,14 @@ "$id": "476", "Name": "internalProtocol", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, then the protocol method should be internal", + "Doc": "When set protocol false and convenient true, then the protocol method should be internal", "Accessibility": "public", "Parameters": [ { "$id": "477", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "478", "kind": "constant", @@ -5154,7 +5154,7 @@ "$id": "485", "Name": "stillConvenient", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", + "Doc": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -5215,7 +5215,7 @@ "$id": "491", "Name": "doSomething", "ResourceName": "Entity", - "Description": "doSomething for entity", + "Doc": "doSomething for entity", "Accessibility": "public", "Parameters": [ { @@ -5331,7 +5331,7 @@ "$id": "502", "Name": "doSomething", "ResourceName": "Glossary", - "Description": "doSomething for glossary", + "Doc": "doSomething for glossary", "Accessibility": "public", "Parameters": [ { diff --git a/test/TestProjects/Parameters-TypeSpec/tspCodeModel.json b/test/TestProjects/Parameters-TypeSpec/tspCodeModel.json index 0105a5e7ee6..b2149f6dbde 100644 --- a/test/TestProjects/Parameters-TypeSpec/tspCodeModel.json +++ b/test/TestProjects/Parameters-TypeSpec/tspCodeModel.json @@ -86,7 +86,7 @@ "$id": "11", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "12", "kind": "url", @@ -357,7 +357,7 @@ "$id": "37", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "38", "kind": "url", diff --git a/test/TestProjects/sdk/newprojecttypespec/Azure.NewProject.TypeSpec/tspCodeModel.json b/test/TestProjects/sdk/newprojecttypespec/Azure.NewProject.TypeSpec/tspCodeModel.json index d627838d008..38918d5589e 100644 --- a/test/TestProjects/sdk/newprojecttypespec/Azure.NewProject.TypeSpec/tspCodeModel.json +++ b/test/TestProjects/sdk/newprojecttypespec/Azure.NewProject.TypeSpec/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -119,7 +119,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -129,7 +129,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -152,7 +152,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -162,7 +162,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -185,7 +185,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -195,7 +195,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -266,7 +266,7 @@ "decorators": [] } ], - "description": "Simple enum", + "doc": "Simple enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -337,7 +337,7 @@ "decorators": [] } ], - "description": "Extensible enum", + "doc": "Extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -408,7 +408,7 @@ "decorators": [] } ], - "description": "Int based extensible enum", + "doc": "Int based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -479,7 +479,7 @@ "decorators": [] } ], - "description": "Float based extensible enum", + "doc": "Float based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -550,7 +550,7 @@ "decorators": [] } ], - "description": "float fixed enum", + "doc": "float fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -621,7 +621,7 @@ "decorators": [] } ], - "description": "int fixed enum", + "doc": "int fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -773,7 +773,7 @@ "name": "Thing", "crossLanguageDefinitionId": "NewProjectTypeSpec.Thing", "usage": "Input,Output,Spread,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -781,7 +781,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "86", "kind": "string", @@ -801,7 +801,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "88", "kind": "union", @@ -850,7 +850,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "94", "kind": "constant", @@ -872,7 +872,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "96", "kind": "constant", @@ -894,7 +894,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "98", "kind": "constant", @@ -916,7 +916,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "100", "kind": "constant", @@ -942,7 +942,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "103", "kind": "constant", @@ -964,7 +964,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "105", "kind": "constant", @@ -986,7 +986,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "107", "kind": "constant", @@ -1008,7 +1008,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "109", "kind": "constant", @@ -1034,7 +1034,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "112", "kind": "string", @@ -1057,7 +1057,7 @@ "name": "Friend", "crossLanguageDefinitionId": "NewProjectTypeSpec.NotFriend", "usage": "Output,Spread,Json", - "description": "this is not a friendly model but with a friendly name", + "doc": "this is not a friendly model but with a friendly name", "decorators": [], "properties": [ { @@ -1065,7 +1065,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the NotFriend", + "doc": "name of the NotFriend", "type": { "$id": "115", "kind": "string", @@ -1088,7 +1088,7 @@ "name": "RoundTripModel", "crossLanguageDefinitionId": "NewProjectTypeSpec.RoundTripModel", "usage": "Input,Output,Json", - "description": "this is a roundtrip model", + "doc": "this is a roundtrip model", "decorators": [], "properties": [ { @@ -1096,7 +1096,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "Required string, illustrating a reference type property.", + "doc": "Required string, illustrating a reference type property.", "type": { "$id": "118", "kind": "string", @@ -1116,7 +1116,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int, illustrating a value type property.", + "doc": "Required int, illustrating a value type property.", "type": { "$id": "120", "kind": "int32", @@ -1136,7 +1136,7 @@ "kind": "property", "name": "requiredCollection", "serializedName": "requiredCollection", - "description": "Required collection of enums", + "doc": "Required collection of enums", "type": { "$id": "122", "kind": "array", @@ -1159,7 +1159,7 @@ "kind": "property", "name": "requiredDictionary", "serializedName": "requiredDictionary", - "description": "Required dictionary of enums", + "doc": "Required dictionary of enums", "type": { "$id": "124", "kind": "dict", @@ -1187,7 +1187,7 @@ "kind": "property", "name": "requiredModel", "serializedName": "requiredModel", - "description": "Required model", + "doc": "Required model", "type": { "$ref": "84" }, @@ -1203,7 +1203,7 @@ "kind": "property", "name": "intExtensibleEnum", "serializedName": "intExtensibleEnum", - "description": "this is an int based extensible enum", + "doc": "this is an int based extensible enum", "type": { "$ref": "36" }, @@ -1219,7 +1219,7 @@ "kind": "property", "name": "intExtensibleEnumCollection", "serializedName": "intExtensibleEnumCollection", - "description": "this is a collection of int based extensible enum", + "doc": "this is a collection of int based extensible enum", "type": { "$id": "129", "kind": "array", @@ -1242,7 +1242,7 @@ "kind": "property", "name": "floatExtensibleEnum", "serializedName": "floatExtensibleEnum", - "description": "this is a float based extensible enum", + "doc": "this is a float based extensible enum", "type": { "$ref": "44" }, @@ -1258,7 +1258,7 @@ "kind": "property", "name": "floatExtensibleEnumCollection", "serializedName": "floatExtensibleEnumCollection", - "description": "this is a collection of float based extensible enum", + "doc": "this is a collection of float based extensible enum", "type": { "$id": "132", "kind": "array", @@ -1281,7 +1281,7 @@ "kind": "property", "name": "floatFixedEnum", "serializedName": "floatFixedEnum", - "description": "this is a float based fixed enum", + "doc": "this is a float based fixed enum", "type": { "$ref": "52" }, @@ -1297,7 +1297,7 @@ "kind": "property", "name": "floatFixedEnumCollection", "serializedName": "floatFixedEnumCollection", - "description": "this is a collection of float based fixed enum", + "doc": "this is a collection of float based fixed enum", "type": { "$id": "135", "kind": "array", @@ -1320,7 +1320,7 @@ "kind": "property", "name": "intFixedEnum", "serializedName": "intFixedEnum", - "description": "this is a int based fixed enum", + "doc": "this is a int based fixed enum", "type": { "$ref": "60" }, @@ -1336,7 +1336,7 @@ "kind": "property", "name": "intFixedEnumCollection", "serializedName": "intFixedEnumCollection", - "description": "this is a collection of int based fixed enum", + "doc": "this is a collection of int based fixed enum", "type": { "$id": "138", "kind": "array", @@ -1359,7 +1359,7 @@ "kind": "property", "name": "stringFixedEnum", "serializedName": "stringFixedEnum", - "description": "this is a string based fixed enum", + "doc": "this is a string based fixed enum", "type": { "$ref": "20" }, @@ -1375,7 +1375,7 @@ "kind": "property", "name": "requiredUnknown", "serializedName": "requiredUnknown", - "description": "required unknown", + "doc": "required unknown", "type": { "$id": "141", "kind": "unknown", @@ -1395,7 +1395,7 @@ "kind": "property", "name": "optionalUnknown", "serializedName": "optionalUnknown", - "description": "optional unknown", + "doc": "optional unknown", "type": { "$id": "143", "kind": "unknown", @@ -1415,7 +1415,7 @@ "kind": "property", "name": "requiredRecordUnknown", "serializedName": "requiredRecordUnknown", - "description": "required record of unknown", + "doc": "required record of unknown", "type": { "$id": "145", "kind": "dict", @@ -1447,7 +1447,7 @@ "kind": "property", "name": "optionalRecordUnknown", "serializedName": "optionalRecordUnknown", - "description": "optional record of unknown", + "doc": "optional record of unknown", "type": { "$id": "149", "kind": "dict", @@ -1479,7 +1479,7 @@ "kind": "property", "name": "readOnlyRequiredRecordUnknown", "serializedName": "readOnlyRequiredRecordUnknown", - "description": "required readonly record of unknown", + "doc": "required readonly record of unknown", "type": { "$id": "153", "kind": "dict", @@ -1511,7 +1511,7 @@ "kind": "property", "name": "readOnlyOptionalRecordUnknown", "serializedName": "readOnlyOptionalRecordUnknown", - "description": "optional readonly record of unknown", + "doc": "optional readonly record of unknown", "type": { "$id": "157", "kind": "dict", @@ -1545,13 +1545,13 @@ { "$id": "160", "Name": "NewProjectTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "161", "Name": "topAction", "ResourceName": "NewProjectTypeSpec", - "Description": "top level method", + "Doc": "top level method", "Accessibility": "public", "Parameters": [ { @@ -1642,7 +1642,7 @@ "$id": "169", "Name": "topAction2", "ResourceName": "NewProjectTypeSpec", - "Description": "top level method2", + "Doc": "top level method2", "Accessibility": "public", "Parameters": [ { @@ -1704,14 +1704,14 @@ "$id": "174", "Name": "patchAction", "ResourceName": "NewProjectTypeSpec", - "Description": "top level patch", + "Doc": "top level patch", "Accessibility": "public", "Parameters": [ { "$id": "175", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "176", "kind": "constant", @@ -1814,14 +1814,14 @@ "$id": "183", "Name": "anonymousBody", "ResourceName": "NewProjectTypeSpec", - "Description": "body parameter without body decorator", + "Doc": "body parameter without body decorator", "Accessibility": "public", "Parameters": [ { "$id": "184", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "185", "kind": "constant", @@ -1924,14 +1924,14 @@ "$id": "192", "Name": "friendlyModel", "ResourceName": "NewProjectTypeSpec", - "Description": "Model can have its friendly name", + "Doc": "Model can have its friendly name", "Accessibility": "public", "Parameters": [ { "$id": "193", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "194", "kind": "constant", @@ -2150,13 +2150,13 @@ { "$id": "213", "Name": "HelloDemo", - "Description": "Hello world service", + "Doc": "Hello world service", "Operations": [ { "$id": "214", "Name": "sayHi", "ResourceName": "Demo", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -2314,7 +2314,7 @@ "$id": "229", "Name": "helloAgain", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -2465,7 +2465,7 @@ "$id": "242", "Name": "noContentType", "ResourceName": "Demo2", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -2514,7 +2514,7 @@ "$id": "247", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "248", "kind": "constant", @@ -2617,14 +2617,14 @@ "$id": "255", "Name": "createLiteral", "ResourceName": "Demo2", - "Description": "Create with literal value", + "Doc": "Create with literal value", "Accessibility": "public", "Parameters": [ { "$id": "256", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "257", "kind": "constant", @@ -2727,7 +2727,7 @@ "$id": "264", "Name": "helloLiteral", "ResourceName": "Demo2", - "Description": "Send literal parameters", + "Doc": "Send literal parameters", "Accessibility": "public", "Parameters": [ { @@ -2903,14 +2903,14 @@ "$id": "282", "Name": "getUnknownValue", "ResourceName": "EnumTest", - "Description": "create extensible enum", + "Doc": "create extensible enum", "Accessibility": "public", "Parameters": [ { "$id": "283", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "284", "kind": "constant", @@ -3013,14 +3013,14 @@ "$id": "292", "Name": "internalProtocol", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, then the protocol method should be internal", + "Doc": "When set protocol false and convenient true, then the protocol method should be internal", "Accessibility": "public", "Parameters": [ { "$id": "293", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "294", "kind": "constant", @@ -3123,7 +3123,7 @@ "$id": "301", "Name": "stillConvenient", "ResourceName": "ProtocolAndConvenient", - "Description": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", + "Doc": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", "Accessibility": "public", "Parameters": [], "Responses": [ diff --git a/test/UnbrandedProjects/Customized-TypeSpec/tspCodeModel.json b/test/UnbrandedProjects/Customized-TypeSpec/tspCodeModel.json index 766a06714d7..cbb5f13085a 100644 --- a/test/UnbrandedProjects/Customized-TypeSpec/tspCodeModel.json +++ b/test/UnbrandedProjects/Customized-TypeSpec/tspCodeModel.json @@ -22,7 +22,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -32,7 +32,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -55,7 +55,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -65,7 +65,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -88,7 +88,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -98,7 +98,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -121,7 +121,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -131,7 +131,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -154,7 +154,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -164,7 +164,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -187,7 +187,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -197,7 +197,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -247,7 +247,7 @@ "name": "Thing", "crossLanguageDefinitionId": "CustomizedTypeSpec.Thing", "usage": "Input,Output,Spread,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -255,7 +255,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "26", "kind": "string", @@ -275,7 +275,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "28", "kind": "union", @@ -324,7 +324,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "34", "kind": "constant", @@ -346,7 +346,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "36", "kind": "constant", @@ -368,7 +368,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "38", "kind": "constant", @@ -390,7 +390,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "40", "kind": "constant", @@ -416,7 +416,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "43", "kind": "constant", @@ -438,7 +438,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "45", "kind": "constant", @@ -460,7 +460,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "47", "kind": "constant", @@ -482,7 +482,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "49", "kind": "constant", @@ -508,7 +508,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "52", "kind": "string", @@ -528,7 +528,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "54", "kind": "nullable", @@ -559,7 +559,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "58", "kind": "nullable", @@ -593,7 +593,7 @@ "name": "RoundTripModel", "crossLanguageDefinitionId": "CustomizedTypeSpec.RoundTripModel", "usage": "Input,Output,Json", - "description": "this is a roundtrip model", + "doc": "this is a roundtrip model", "decorators": [], "properties": [ { @@ -601,7 +601,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "Required string, illustrating a reference type property.", + "doc": "Required string, illustrating a reference type property.", "type": { "$id": "63", "kind": "string", @@ -621,7 +621,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int, illustrating a value type property.", + "doc": "Required int, illustrating a value type property.", "type": { "$id": "65", "kind": "int32", @@ -641,7 +641,7 @@ "kind": "property", "name": "requiredReadonlyInt", "serializedName": "requiredReadonlyInt", - "description": "Required readonly int", + "doc": "Required readonly int", "type": { "$id": "67", "kind": "int32", @@ -671,7 +671,7 @@ "kind": "property", "name": "sourceUrl", "serializedName": "sourceUrl", - "description": "url format", + "doc": "url format", "type": { "$id": "70", "kind": "url", @@ -691,7 +691,7 @@ "kind": "property", "name": "guid", "serializedName": "guid", - "description": "uuid format", + "doc": "uuid format", "type": { "$id": "72", "kind": "string", @@ -721,7 +721,7 @@ "name": "Friend", "crossLanguageDefinitionId": "CustomizedTypeSpec.NotFriend", "usage": "Output,Spread,Json", - "description": "this is not a friendly model but with a friendly name", + "doc": "this is not a friendly model but with a friendly name", "decorators": [], "properties": [ { @@ -729,7 +729,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the NotFriend", + "doc": "name of the NotFriend", "type": { "$id": "76", "kind": "string", @@ -767,7 +767,7 @@ "name": "ProjectedModel", "crossLanguageDefinitionId": "CustomizedTypeSpec.ModelWithProjectedName", "usage": "Output,Spread,Json", - "description": "this is a model with a projected name", + "doc": "this is a model with a projected name", "decorators": [], "properties": [ { @@ -775,7 +775,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelWithProjectedName", + "doc": "name of the ModelWithProjectedName", "type": { "$id": "80", "kind": "string", @@ -806,13 +806,13 @@ { "$id": "82", "Name": "CustomizedTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "83", "Name": "sayHi", "ResourceName": "CustomizedTypeSpec", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -937,7 +937,7 @@ "$id": "94", "Name": "helloAgain", "ResourceName": "CustomizedTypeSpec", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -1088,7 +1088,7 @@ "$id": "107", "Name": "noContentType", "ResourceName": "CustomizedTypeSpec", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -1137,7 +1137,7 @@ "$id": "112", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "113", "kind": "constant", @@ -1240,7 +1240,7 @@ "$id": "120", "Name": "helloDemo2", "ResourceName": "CustomizedTypeSpec", - "Description": "Return hi in demo2", + "Doc": "Return hi in demo2", "Accessibility": "public", "Parameters": [ { @@ -1302,14 +1302,14 @@ "$id": "125", "Name": "createLiteral", "ResourceName": "CustomizedTypeSpec", - "Description": "Create with literal value", + "Doc": "Create with literal value", "Accessibility": "public", "Parameters": [ { "$id": "126", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "127", "kind": "constant", @@ -1412,7 +1412,7 @@ "$id": "134", "Name": "helloLiteral", "ResourceName": "CustomizedTypeSpec", - "Description": "Send literal parameters", + "Doc": "Send literal parameters", "Accessibility": "public", "Parameters": [ { @@ -1555,7 +1555,7 @@ "$id": "148", "Name": "topAction", "ResourceName": "CustomizedTypeSpec", - "Description": "top level method", + "Doc": "top level method", "Accessibility": "public", "Parameters": [ { @@ -1646,7 +1646,7 @@ "$id": "156", "Name": "topAction2", "ResourceName": "CustomizedTypeSpec", - "Description": "top level method2", + "Doc": "top level method2", "Accessibility": "public", "Parameters": [ { @@ -1708,14 +1708,14 @@ "$id": "161", "Name": "patchAction", "ResourceName": "CustomizedTypeSpec", - "Description": "top level patch", + "Doc": "top level patch", "Accessibility": "public", "Parameters": [ { "$id": "162", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "163", "kind": "constant", @@ -1818,14 +1818,14 @@ "$id": "170", "Name": "anonymousBody", "ResourceName": "CustomizedTypeSpec", - "Description": "body parameter without body decorator", + "Doc": "body parameter without body decorator", "Accessibility": "public", "Parameters": [ { "$id": "171", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "172", "kind": "constant", @@ -1928,14 +1928,14 @@ "$id": "179", "Name": "friendlyModel", "ResourceName": "CustomizedTypeSpec", - "Description": "Model can have its friendly name", + "Doc": "Model can have its friendly name", "Accessibility": "public", "Parameters": [ { "$id": "180", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "181", "kind": "constant", @@ -2095,14 +2095,14 @@ "$id": "193", "Name": "projectedNameModel", "ResourceName": "CustomizedTypeSpec", - "Description": "Model can have its projected name", + "Doc": "Model can have its projected name", "Accessibility": "public", "Parameters": [ { "$id": "194", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "195", "kind": "constant", @@ -2205,7 +2205,7 @@ "$id": "202", "Name": "returnsAnonymousModel", "ResourceName": "CustomizedTypeSpec", - "Description": "return anonymous model", + "Doc": "return anonymous model", "Accessibility": "public", "Parameters": [ { @@ -2267,7 +2267,7 @@ "$id": "207", "Name": "getUnknownValue", "ResourceName": "CustomizedTypeSpec", - "Description": "get extensible enum", + "Doc": "get extensible enum", "Accessibility": "public", "Parameters": [ { @@ -2340,14 +2340,14 @@ "$id": "213", "Name": "internalProtocol", "ResourceName": "CustomizedTypeSpec", - "Description": "When set protocol false and convenient true, then the protocol method should be internal", + "Doc": "When set protocol false and convenient true, then the protocol method should be internal", "Accessibility": "public", "Parameters": [ { "$id": "214", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "215", "kind": "constant", @@ -2450,7 +2450,7 @@ "$id": "222", "Name": "stillConvenient", "ResourceName": "CustomizedTypeSpec", - "Description": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", + "Doc": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -2478,7 +2478,7 @@ "$id": "224", "Name": "headAsBoolean", "ResourceName": "CustomizedTypeSpec", - "Description": "head as boolean.", + "Doc": "head as boolean.", "Accessibility": "public", "Parameters": [ { diff --git a/test/UnbrandedProjects/NoDocsUnbranded-TypeSpec/tspCodeModel.json b/test/UnbrandedProjects/NoDocsUnbranded-TypeSpec/tspCodeModel.json index 017f753162e..5063d2f9e28 100644 --- a/test/UnbrandedProjects/NoDocsUnbranded-TypeSpec/tspCodeModel.json +++ b/test/UnbrandedProjects/NoDocsUnbranded-TypeSpec/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -119,7 +119,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -129,7 +129,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -152,7 +152,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -162,7 +162,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -185,7 +185,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -195,7 +195,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -209,7 +209,7 @@ "name": "Thing", "crossLanguageDefinitionId": "NoDocsUnbrandedTypeSpec.Thing", "usage": "Output,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -217,7 +217,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "22", "kind": "string", @@ -237,7 +237,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "24", "kind": "union", @@ -286,7 +286,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "30", "kind": "constant", @@ -308,7 +308,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "32", "kind": "constant", @@ -330,7 +330,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "34", "kind": "constant", @@ -352,7 +352,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "36", "kind": "constant", @@ -378,7 +378,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "39", "kind": "constant", @@ -400,7 +400,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "41", "kind": "constant", @@ -422,7 +422,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "43", "kind": "constant", @@ -444,7 +444,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "45", "kind": "constant", @@ -470,7 +470,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "48", "kind": "string", @@ -490,7 +490,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "50", "kind": "nullable", @@ -521,7 +521,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "54", "kind": "nullable", @@ -554,13 +554,13 @@ { "$id": "57", "Name": "NoDocsUnbrandedTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "58", "Name": "sayHi", "ResourceName": "NoDocsUnbrandedTypeSpec", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { diff --git a/test/UnbrandedProjects/NoTest-TypeSpec/tspCodeModel.json b/test/UnbrandedProjects/NoTest-TypeSpec/tspCodeModel.json index 4377d16a586..6920afd337e 100644 --- a/test/UnbrandedProjects/NoTest-TypeSpec/tspCodeModel.json +++ b/test/UnbrandedProjects/NoTest-TypeSpec/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -119,7 +119,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -129,7 +129,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -152,7 +152,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -162,7 +162,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -185,7 +185,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -195,7 +195,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -209,7 +209,7 @@ "name": "Thing", "crossLanguageDefinitionId": "NoTestTypeSpec.Thing", "usage": "Input,Output,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -217,7 +217,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "22", "kind": "string", @@ -237,7 +237,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "24", "kind": "union", @@ -286,7 +286,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "30", "kind": "constant", @@ -308,7 +308,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "32", "kind": "constant", @@ -330,7 +330,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "34", "kind": "constant", @@ -352,7 +352,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "36", "kind": "constant", @@ -378,7 +378,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "39", "kind": "constant", @@ -400,7 +400,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "41", "kind": "constant", @@ -422,7 +422,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "43", "kind": "constant", @@ -444,7 +444,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "45", "kind": "constant", @@ -470,7 +470,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "48", "kind": "string", @@ -490,7 +490,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "50", "kind": "nullable", @@ -521,7 +521,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "54", "kind": "nullable", @@ -586,13 +586,13 @@ { "$id": "60", "Name": "NoTestTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "61", "Name": "sayHi", "ResourceName": "NoTestTypeSpec", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -717,14 +717,14 @@ "$id": "72", "Name": "sayHello", "ResourceName": "NoTestTypeSpec", - "Description": "Return hello", + "Doc": "Return hello", "Accessibility": "public", "Parameters": [ { "$id": "73", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "74", "kind": "constant", diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs index 7de93f2f9da..72dfb7f2824 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs @@ -42,7 +42,6 @@ internal AudioTranscriptions(ClientPipeline pipeline, ApiKeyCredential keyCreden /// Transcribes audio into the input language. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateTranscriptionRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); @@ -55,7 +54,6 @@ public virtual async Task> CreateAsync /// Transcribes audio into the input language. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateTranscriptionRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs index 6d8da547d59..27941739cdc 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs @@ -42,7 +42,6 @@ internal AudioTranslations(ClientPipeline pipeline, ApiKeyCredential keyCredenti /// Transcribes audio into the input language. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateTranslationRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); @@ -55,7 +54,6 @@ public virtual async Task> CreateAsync(C /// Transcribes audio into the input language. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateTranslationRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs index 5c656692549..a700362fcda 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs @@ -42,7 +42,6 @@ internal Embeddings(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// Creates an embedding vector representing the input text. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateEmbeddingRequest embedding) { Argument.AssertNotNull(embedding, nameof(embedding)); @@ -55,7 +54,6 @@ public virtual async Task> CreateAsync(Cre /// Creates an embedding vector representing the input text. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateEmbeddingRequest embedding) { Argument.AssertNotNull(embedding, nameof(embedding)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs index 419c2282615..86a8487034d 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs @@ -40,7 +40,6 @@ internal Files(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri endp } /// Returns a list of files that belong to the user's organization. - /// List. public virtual async Task> GetFilesAsync() { ClientResult result = await GetFilesAsync(null).ConfigureAwait(false); @@ -48,7 +47,6 @@ public virtual async Task> GetFilesAsync() } /// Returns a list of files that belong to the user's organization. - /// List. public virtual ClientResult GetFiles() { ClientResult result = GetFiles(null); @@ -106,7 +104,6 @@ public virtual ClientResult GetFiles(RequestOptions options) /// Returns a list of files that belong to the user's organization. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateFileRequest file) { Argument.AssertNotNull(file, nameof(file)); @@ -119,7 +116,6 @@ public virtual async Task> CreateAsync(CreateFileReques /// Returns a list of files that belong to the user's organization. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateFileRequest file) { Argument.AssertNotNull(file, nameof(file)); @@ -191,7 +187,6 @@ public virtual ClientResult Create(BinaryContent content, string contentType, Re /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual async Task> RetrieveAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -204,7 +199,6 @@ public virtual async Task> RetrieveAsync(string fileId) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual ClientResult Retrieve(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -275,7 +269,6 @@ public virtual ClientResult Retrieve(string fileId, RequestOptions options) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Delete. public virtual async Task> DeleteAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -288,7 +281,6 @@ public virtual async Task> DeleteAsync(string f /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Delete. public virtual ClientResult Delete(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -359,7 +351,6 @@ public virtual ClientResult Delete(string fileId, RequestOptions options) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Download. public virtual async Task> DownloadAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -372,7 +363,6 @@ public virtual async Task> DownloadAsync(string fileId) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Download. public virtual ClientResult Download(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs index 3d11301ce87..ebee9f3d3e1 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs @@ -48,7 +48,6 @@ internal FineTunes(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// /// The to use. /// is null. - /// Create. [Obsolete("deprecated")] public virtual async Task> CreateAsync(CreateFineTuneRequest fineTune) { @@ -68,7 +67,6 @@ public virtual async Task> CreateAsync(CreateFineTuneRequ /// /// The to use. /// is null. - /// Create. [Obsolete("deprecated")] public virtual ClientResult Create(CreateFineTuneRequest fineTune) { @@ -146,7 +144,6 @@ public virtual ClientResult Create(BinaryContent content, RequestOptions options } /// List your organization's fine-tuning jobs. - /// List. [Obsolete("deprecated")] public virtual async Task> GetFineTunesAsync() { @@ -155,7 +152,6 @@ public virtual async Task> GetFineTunesAsync } /// List your organization's fine-tuning jobs. - /// List. [Obsolete("deprecated")] public virtual ClientResult GetFineTunes() { @@ -221,7 +217,6 @@ public virtual ClientResult GetFineTunes(RequestOptions options) /// The ID of the fine-tune job. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. [Obsolete("deprecated")] public virtual async Task> RetrieveAsync(string fineTuneId) { @@ -239,7 +234,6 @@ public virtual async Task> RetrieveAsync(string fineTuneI /// The ID of the fine-tune job. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. [Obsolete("deprecated")] public virtual ClientResult Retrieve(string fineTuneId) { @@ -326,7 +320,6 @@ public virtual ClientResult Retrieve(string fineTuneId, RequestOptions options) /// /// is null. /// is an empty string, and was expected to be non-empty. - /// List events. [Obsolete("deprecated")] public virtual async Task> GetEventsAsync(string fineTuneId, bool? stream = null) { @@ -349,7 +342,6 @@ public virtual async Task> GetEventsAsy /// /// is null. /// is an empty string, and was expected to be non-empty. - /// List events. [Obsolete("deprecated")] public virtual ClientResult GetEvents(string fineTuneId, bool? stream = null) { @@ -441,7 +433,6 @@ public virtual ClientResult GetEvents(string fineTuneId, bool? stream, RequestOp /// The ID of the fine-tune job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. - /// Cancel. [Obsolete("deprecated")] public virtual async Task> CancelAsync(string fineTuneId) { @@ -455,7 +446,6 @@ public virtual async Task> CancelAsync(string fineTuneId) /// The ID of the fine-tune job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. - /// Cancel. [Obsolete("deprecated")] public virtual ClientResult Cancel(string fineTuneId) { diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs index 6d46735da37..906b560d413 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs @@ -221,7 +221,6 @@ public virtual ClientResult GetPaginateds(string after, long? limit, RequestOpti /// The to use. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual async Task> RetrieveAsync(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -238,7 +237,6 @@ public virtual async Task> RetrieveAsync(string fine /// The to use. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual ClientResult Retrieve(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -315,7 +313,6 @@ public virtual ClientResult Retrieve(string fineTuningJobId, RequestOptions opti /// Number of events to retrieve. /// is null. /// is an empty string, and was expected to be non-empty. - /// List events. public virtual async Task> GetEventsAsync(string fineTuningJobId, string after = null, long? limit = null) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -330,7 +327,6 @@ public virtual async Task> GetEven /// Number of events to retrieve. /// is null. /// is an empty string, and was expected to be non-empty. - /// List events. public virtual ClientResult GetEvents(string fineTuningJobId, string after = null, long? limit = null) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -405,7 +401,6 @@ public virtual ClientResult GetEvents(string fineTuningJobId, string after, long /// The ID of the fine-tuning job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. - /// Cancel. public virtual async Task> CancelAsync(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -418,7 +413,6 @@ public virtual async Task> CancelAsync(string fineTu /// The ID of the fine-tuning job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. - /// Cancel. public virtual ClientResult Cancel(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs index da64ab3cbfb..e4f52b64145 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs @@ -42,7 +42,6 @@ internal Images(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri end /// Creates an image given a prompt. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateImageRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -55,7 +54,6 @@ public virtual async Task> CreateAsync(CreateImageR /// Creates an image given a prompt. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateImageRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -124,7 +122,6 @@ public virtual ClientResult Create(BinaryContent content, RequestOptions options /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. - /// Create edit. public virtual async Task> CreateEditAsync(CreateImageEditRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -137,7 +134,6 @@ public virtual async Task> CreateEditAsync(CreateIm /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. - /// Create edit. public virtual ClientResult CreateEdit(CreateImageEditRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -208,7 +204,6 @@ public virtual ClientResult CreateEdit(BinaryContent content, string contentType /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. - /// Create variation. public virtual async Task> CreateVariationAsync(CreateImageVariationRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -221,7 +216,6 @@ public virtual async Task> CreateVariationAsync(Cre /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. - /// Create variation. public virtual ClientResult CreateVariation(CreateImageVariationRequest image) { Argument.AssertNotNull(image, nameof(image)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs index 951f320383c..01b89980664 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs @@ -43,7 +43,6 @@ internal ModelsOps(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// Lists the currently available models, and provides basic information about each one such as the /// owner and availability. /// - /// List. public virtual async Task> GetModelsAsync() { ClientResult result = await GetModelsAsync(null).ConfigureAwait(false); @@ -54,7 +53,6 @@ public virtual async Task> GetModelsAsync() /// Lists the currently available models, and provides basic information about each one such as the /// owner and availability. /// - /// List. public virtual ClientResult GetModels() { ClientResult result = GetModels(null); @@ -118,7 +116,6 @@ public virtual ClientResult GetModels(RequestOptions options) /// The ID of the model to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual async Task> RetrieveAsync(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -134,7 +131,6 @@ public virtual async Task> RetrieveAsync(string model) /// The ID of the model to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. - /// Retrieve. public virtual ClientResult Retrieve(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -207,7 +203,6 @@ public virtual ClientResult Retrieve(string model, RequestOptions options) /// The model to delete. /// is null. /// is an empty string, and was expected to be non-empty. - /// Delete. public virtual async Task> DeleteAsync(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -220,7 +215,6 @@ public virtual async Task> DeleteAsync(string /// The model to delete. /// is null. /// is an empty string, and was expected to be non-empty. - /// Delete. public virtual ClientResult Delete(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs index 1e9336287e9..fc4149a9821 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs @@ -42,7 +42,6 @@ internal Moderations(ClientPipeline pipeline, ApiKeyCredential keyCredential, Ur /// Classifies if text violates OpenAI's Content Policy. /// The to use. /// is null. - /// Create. public virtual async Task> CreateAsync(CreateModerationRequest content) { Argument.AssertNotNull(content, nameof(content)); @@ -55,7 +54,6 @@ public virtual async Task> CreateAsync(Cr /// Classifies if text violates OpenAI's Content Policy. /// The to use. /// is null. - /// Create. public virtual ClientResult Create(CreateModerationRequest content) { Argument.AssertNotNull(content, nameof(content)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/tspCodeModel.json b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/tspCodeModel.json index b79f3acdb4a..43e6ac9615f 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/tspCodeModel.json +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/tspCodeModel.json @@ -196,7 +196,7 @@ "kind": "enumvalue", "name": "model", "value": "model", - "description": "model", + "doc": "model", "valueType": { "$ref": "23" }, @@ -206,7 +206,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Model_object", + "doc": "The Model_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -316,7 +316,7 @@ "kind": "enumvalue", "name": "fine-tune", "value": "fine-tune", - "description": "fine-tune", + "doc": "fine-tune", "valueType": { "$ref": "36" }, @@ -326,7 +326,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FineTune_object", + "doc": "The FineTune_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -453,7 +453,7 @@ "kind": "enumvalue", "name": "file", "value": "file", - "description": "file", + "doc": "file", "valueType": { "$ref": "51" }, @@ -463,7 +463,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The OpenAIFile_object", + "doc": "The OpenAIFile_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -643,7 +643,7 @@ "kind": "enumvalue", "name": "embedding", "value": "embedding", - "description": "embedding", + "doc": "embedding", "valueType": { "$ref": "72" }, @@ -653,7 +653,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The CreateEmbeddingResponse_object", + "doc": "The CreateEmbeddingResponse_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -676,7 +676,7 @@ "kind": "enumvalue", "name": "embedding", "value": "embedding", - "description": "embedding", + "doc": "embedding", "valueType": { "$ref": "75" }, @@ -686,7 +686,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Embedding_object", + "doc": "The Embedding_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -762,7 +762,7 @@ "kind": "enumvalue", "name": "edit", "value": "edit", - "description": "edit", + "doc": "edit", "valueType": { "$ref": "84" }, @@ -772,7 +772,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The CreateEditResponse_object", + "doc": "The CreateEditResponse_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -1160,7 +1160,7 @@ "kind": "enumvalue", "name": "fine_tuning.job", "value": "fine_tuning.job", - "description": "fine_tuning.job", + "doc": "fine_tuning.job", "valueType": { "$ref": "129" }, @@ -1170,7 +1170,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The FineTuningJob_object", + "doc": "The FineTuningJob_object", "isFixed": false, "isFlags": false, "usage": "Output,Json", @@ -2129,7 +2129,7 @@ "kind": "property", "name": "input", "serializedName": "input", - "description": "The input text to classify", + "doc": "The input text to classify", "type": { "$id": "241", "kind": "union", @@ -2171,7 +2171,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "Two content moderations models are available: `text-moderation-stable` and\n`text-moderation-latest`. The default is `text-moderation-latest` which will be automatically\nupgraded over time. This ensures you are always using our most accurate model. If you use\n`text-moderation-stable`, we will provide advanced notice before updating the model. Accuracy\nof `text-moderation-stable` may be slightly lower than for `text-moderation-latest`.", + "doc": "Two content moderations models are available: `text-moderation-stable` and\n`text-moderation-latest`. The default is `text-moderation-latest` which will be automatically\nupgraded over time. This ensures you are always using our most accurate model. If you use\n`text-moderation-stable`, we will provide advanced notice before updating the model. Accuracy\nof `text-moderation-stable` may be slightly lower than for `text-moderation-latest`.", "type": { "$ref": "2" }, @@ -2197,7 +2197,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The unique identifier for the moderation request.", + "doc": "The unique identifier for the moderation request.", "type": { "$id": "248", "kind": "string", @@ -2217,7 +2217,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The model used to generate the moderation results.", + "doc": "The model used to generate the moderation results.", "type": { "$id": "250", "kind": "string", @@ -2237,7 +2237,7 @@ "kind": "property", "name": "results", "serializedName": "results", - "description": "A list of moderation objects.", + "doc": "A list of moderation objects.", "type": { "$id": "252", "kind": "array", @@ -2255,7 +2255,7 @@ "kind": "property", "name": "flagged", "serializedName": "flagged", - "description": "Whether the content violates [OpenAI's usage policies](/policies/usage-policies).", + "doc": "Whether the content violates [OpenAI's usage policies](/policies/usage-policies).", "type": { "$id": "255", "kind": "boolean", @@ -2275,7 +2275,7 @@ "kind": "property", "name": "categories", "serializedName": "categories", - "description": "A list of the categories, and whether they are flagged or not.", + "doc": "A list of the categories, and whether they are flagged or not.", "type": { "$id": "257", "kind": "model", @@ -2289,7 +2289,7 @@ "kind": "property", "name": "hate", "serializedName": "hate", - "description": "Content that expresses, incites, or promotes hate based on race, gender, ethnicity,\nreligion, nationality, sexual orientation, disability status, or caste. Hateful content\naimed at non-protected groups (e.g., chess players) is harrassment.", + "doc": "Content that expresses, incites, or promotes hate based on race, gender, ethnicity,\nreligion, nationality, sexual orientation, disability status, or caste. Hateful content\naimed at non-protected groups (e.g., chess players) is harrassment.", "type": { "$id": "259", "kind": "boolean", @@ -2309,7 +2309,7 @@ "kind": "property", "name": "hate/threatening", "serializedName": "hate/threatening", - "description": "Hateful content that also includes violence or serious harm towards the targeted group\nbased on race, gender, ethnicity, religion, nationality, sexual orientation, disability\nstatus, or caste.", + "doc": "Hateful content that also includes violence or serious harm towards the targeted group\nbased on race, gender, ethnicity, religion, nationality, sexual orientation, disability\nstatus, or caste.", "type": { "$id": "261", "kind": "boolean", @@ -2329,7 +2329,7 @@ "kind": "property", "name": "harassment", "serializedName": "harassment", - "description": "Content that expresses, incites, or promotes harassing language towards any target.", + "doc": "Content that expresses, incites, or promotes harassing language towards any target.", "type": { "$id": "263", "kind": "boolean", @@ -2349,7 +2349,7 @@ "kind": "property", "name": "harassment/threatening", "serializedName": "harassment/threatening", - "description": "Harassment content that also includes violence or serious harm towards any target.", + "doc": "Harassment content that also includes violence or serious harm towards any target.", "type": { "$id": "265", "kind": "boolean", @@ -2369,7 +2369,7 @@ "kind": "property", "name": "self-harm", "serializedName": "self-harm", - "description": "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting,\nand eating disorders.", + "doc": "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting,\nand eating disorders.", "type": { "$id": "267", "kind": "boolean", @@ -2389,7 +2389,7 @@ "kind": "property", "name": "self-harm/intent", "serializedName": "self-harm/intent", - "description": "Content where the speaker expresses that they are engaging or intend to engage in acts of\nself-harm, such as suicide, cutting, and eating disorders.", + "doc": "Content where the speaker expresses that they are engaging or intend to engage in acts of\nself-harm, such as suicide, cutting, and eating disorders.", "type": { "$id": "269", "kind": "boolean", @@ -2409,7 +2409,7 @@ "kind": "property", "name": "self-harm/instructive", "serializedName": "self-harm/instructive", - "description": "Content that encourages performing acts of self-harm, such as suicide, cutting, and eating\ndisorders, or that gives instructions or advice on how to commit such acts.", + "doc": "Content that encourages performing acts of self-harm, such as suicide, cutting, and eating\ndisorders, or that gives instructions or advice on how to commit such acts.", "type": { "$id": "271", "kind": "boolean", @@ -2429,7 +2429,7 @@ "kind": "property", "name": "sexual", "serializedName": "sexual", - "description": "Content meant to arouse sexual excitement, such as the description of sexual activity, or\nthat promotes sexual services (excluding sex education and wellness).", + "doc": "Content meant to arouse sexual excitement, such as the description of sexual activity, or\nthat promotes sexual services (excluding sex education and wellness).", "type": { "$id": "273", "kind": "boolean", @@ -2449,7 +2449,7 @@ "kind": "property", "name": "sexual/minors", "serializedName": "sexual/minors", - "description": "Sexual content that includes an individual who is under 18 years old.", + "doc": "Sexual content that includes an individual who is under 18 years old.", "type": { "$id": "275", "kind": "boolean", @@ -2469,7 +2469,7 @@ "kind": "property", "name": "violence", "serializedName": "violence", - "description": "Content that depicts death, violence, or physical injury.", + "doc": "Content that depicts death, violence, or physical injury.", "type": { "$id": "277", "kind": "boolean", @@ -2489,7 +2489,7 @@ "kind": "property", "name": "violence/graphic", "serializedName": "violence/graphic", - "description": "Content that depicts death, violence, or physical injury in graphic detail.", + "doc": "Content that depicts death, violence, or physical injury in graphic detail.", "type": { "$id": "279", "kind": "boolean", @@ -2518,7 +2518,7 @@ "kind": "property", "name": "category_scores", "serializedName": "category_scores", - "description": "A list of the categories along with their scores as predicted by model.", + "doc": "A list of the categories along with their scores as predicted by model.", "type": { "$id": "281", "kind": "model", @@ -2532,7 +2532,7 @@ "kind": "property", "name": "hate", "serializedName": "hate", - "description": "The score for the category 'hate'.", + "doc": "The score for the category 'hate'.", "type": { "$id": "283", "kind": "float64", @@ -2552,7 +2552,7 @@ "kind": "property", "name": "hate/threatening", "serializedName": "hate/threatening", - "description": "The score for the category 'hate/threatening'.", + "doc": "The score for the category 'hate/threatening'.", "type": { "$id": "285", "kind": "float64", @@ -2572,7 +2572,7 @@ "kind": "property", "name": "harassment", "serializedName": "harassment", - "description": "The score for the category 'harassment'.", + "doc": "The score for the category 'harassment'.", "type": { "$id": "287", "kind": "float64", @@ -2592,7 +2592,7 @@ "kind": "property", "name": "harassment/threatening", "serializedName": "harassment/threatening", - "description": "The score for the category 'harassment/threatening'.", + "doc": "The score for the category 'harassment/threatening'.", "type": { "$id": "289", "kind": "float64", @@ -2612,7 +2612,7 @@ "kind": "property", "name": "self-harm", "serializedName": "self-harm", - "description": "The score for the category 'self-harm'.", + "doc": "The score for the category 'self-harm'.", "type": { "$id": "291", "kind": "float64", @@ -2632,7 +2632,7 @@ "kind": "property", "name": "self-harm/intent", "serializedName": "self-harm/intent", - "description": "The score for the category 'self-harm/intent'.", + "doc": "The score for the category 'self-harm/intent'.", "type": { "$id": "293", "kind": "float64", @@ -2652,7 +2652,7 @@ "kind": "property", "name": "self-harm/instructive", "serializedName": "self-harm/instructive", - "description": "The score for the category 'self-harm/instructive'.", + "doc": "The score for the category 'self-harm/instructive'.", "type": { "$id": "295", "kind": "float64", @@ -2672,7 +2672,7 @@ "kind": "property", "name": "sexual", "serializedName": "sexual", - "description": "The score for the category 'sexual'.", + "doc": "The score for the category 'sexual'.", "type": { "$id": "297", "kind": "float64", @@ -2692,7 +2692,7 @@ "kind": "property", "name": "sexual/minors", "serializedName": "sexual/minors", - "description": "The score for the category 'sexual/minors'.", + "doc": "The score for the category 'sexual/minors'.", "type": { "$id": "299", "kind": "float64", @@ -2712,7 +2712,7 @@ "kind": "property", "name": "violence", "serializedName": "violence", - "description": "The score for the category 'violence'.", + "doc": "The score for the category 'violence'.", "type": { "$id": "301", "kind": "float64", @@ -2732,7 +2732,7 @@ "kind": "property", "name": "violence/graphic", "serializedName": "violence/graphic", - "description": "The score for the category 'violence/graphic'.", + "doc": "The score for the category 'violence/graphic'.", "type": { "$id": "303", "kind": "float64", @@ -2911,7 +2911,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "A text description of the desired image(s). The maximum length is 1000 characters.", + "doc": "A text description of the desired image(s). The maximum length is 1000 characters.", "type": { "$id": "319", "kind": "string", @@ -2931,7 +2931,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "The number of images to generate. Must be between 1 and 10.", + "doc": "The number of images to generate. Must be between 1 and 10.", "type": { "$id": "321", "kind": "nullable", @@ -2962,7 +2962,7 @@ "kind": "property", "name": "size", "serializedName": "size", - "description": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", + "doc": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", "type": { "$id": "325", "kind": "nullable", @@ -2982,7 +2982,7 @@ "kind": "property", "name": "response_format", "serializedName": "response_format", - "description": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", + "doc": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", "type": { "$id": "327", "kind": "nullable", @@ -3075,7 +3075,7 @@ "name": "Image", "crossLanguageDefinitionId": "OpenAI.Image", "usage": "Output,Json", - "description": "Represents the url or the content of an image generated by the OpenAI API.", + "doc": "Represents the url or the content of an image generated by the OpenAI API.", "decorators": [], "properties": [ { @@ -3083,7 +3083,7 @@ "kind": "property", "name": "url", "serializedName": "url", - "description": "The URL of the generated image, if `response_format` is `url` (default).", + "doc": "The URL of the generated image, if `response_format` is `url` (default).", "type": { "$id": "339", "kind": "url", @@ -3103,7 +3103,7 @@ "kind": "property", "name": "b64_json", "serializedName": "b64_json", - "description": "The base64-encoded JSON of the generated image, if `response_format` is `b64_json`.", + "doc": "The base64-encoded JSON of the generated image, if `response_format` is `b64_json`.", "type": { "$id": "341", "kind": "bytes", @@ -3149,7 +3149,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "A text description of the desired image(s). The maximum length is 1000 characters.", + "doc": "A text description of the desired image(s). The maximum length is 1000 characters.", "type": { "$id": "344", "kind": "string", @@ -3169,7 +3169,7 @@ "kind": "property", "name": "image", "serializedName": "image", - "description": "The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not\nprovided, image must have transparency, which will be used as the mask.", + "doc": "The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not\nprovided, image must have transparency, which will be used as the mask.", "type": { "$id": "346", "kind": "bytes", @@ -3190,7 +3190,7 @@ "kind": "property", "name": "mask", "serializedName": "mask", - "description": "An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where\n`image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions\nas `image`.", + "doc": "An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where\n`image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions\nas `image`.", "type": { "$id": "348", "kind": "bytes", @@ -3211,7 +3211,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "The number of images to generate. Must be between 1 and 10.", + "doc": "The number of images to generate. Must be between 1 and 10.", "type": { "$ref": "321" }, @@ -3227,7 +3227,7 @@ "kind": "property", "name": "size", "serializedName": "size", - "description": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", + "doc": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", "type": { "$ref": "325" }, @@ -3243,7 +3243,7 @@ "kind": "property", "name": "response_format", "serializedName": "response_format", - "description": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", + "doc": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", "type": { "$ref": "327" }, @@ -3295,7 +3295,7 @@ "kind": "property", "name": "image", "serializedName": "image", - "description": "The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB,\nand square.", + "doc": "The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB,\nand square.", "type": { "$id": "357", "kind": "bytes", @@ -3316,7 +3316,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "The number of images to generate. Must be between 1 and 10.", + "doc": "The number of images to generate. Must be between 1 and 10.", "type": { "$ref": "321" }, @@ -3332,7 +3332,7 @@ "kind": "property", "name": "size", "serializedName": "size", - "description": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", + "doc": "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.", "type": { "$ref": "325" }, @@ -3348,7 +3348,7 @@ "kind": "property", "name": "response_format", "serializedName": "response_format", - "description": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", + "doc": "The format in which the generated images are returned. Must be one of `url` or `b64_json`.", "type": { "$ref": "327" }, @@ -3429,7 +3429,7 @@ "name": "Model", "crossLanguageDefinitionId": "OpenAI.Model", "usage": "Output,Json", - "description": "Describes an OpenAI model offering that can be used with the API.", + "doc": "Describes an OpenAI model offering that can be used with the API.", "decorators": [], "properties": [ { @@ -3437,7 +3437,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The model identifier, which can be referenced in the API endpoints.", + "doc": "The model identifier, which can be referenced in the API endpoints.", "type": { "$id": "371", "kind": "string", @@ -3457,7 +3457,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"model\".", + "doc": "The object type, which is always \"model\".", "type": { "$id": "373", "kind": "constant", @@ -3479,7 +3479,7 @@ "kind": "property", "name": "created", "serializedName": "created", - "description": "The Unix timestamp (in seconds) when the model was created.", + "doc": "The Unix timestamp (in seconds) when the model was created.", "type": { "$id": "375", "kind": "utcDateTime", @@ -3507,7 +3507,7 @@ "kind": "property", "name": "owned_by", "serializedName": "owned_by", - "description": "The organization that owns the model.", + "doc": "The organization that owns the model.", "type": { "$id": "378", "kind": "string", @@ -3619,7 +3619,7 @@ "kind": "property", "name": "training_file", "serializedName": "training_file", - "description": "The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/upload) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file, where each training example is a JSON object\nwith the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the\npurpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/legacy-fine-tuning/creating-training-data) for more\ndetails.", + "doc": "The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/upload) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file, where each training example is a JSON object\nwith the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the\npurpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/legacy-fine-tuning/creating-training-data) for more\ndetails.", "type": { "$id": "388", "kind": "string", @@ -3639,7 +3639,7 @@ "kind": "property", "name": "validation_file", "serializedName": "validation_file", - "description": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation metrics periodically during\nfine-tuning. These metrics can be viewed in the\n[fine-tuning results file](/docs/guides/legacy-fine-tuning/analyzing-your-fine-tuned-model).\nYour train and validation data should be mutually exclusive.\n\nYour dataset must be formatted as a JSONL file, where each validation example is a JSON object\nwith the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the\npurpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/legacy-fine-tuning/creating-training-data) for more\ndetails.", + "doc": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation metrics periodically during\nfine-tuning. These metrics can be viewed in the\n[fine-tuning results file](/docs/guides/legacy-fine-tuning/analyzing-your-fine-tuned-model).\nYour train and validation data should be mutually exclusive.\n\nYour dataset must be formatted as a JSONL file, where each validation example is a JSON object\nwith the keys \"prompt\" and \"completion\". Additionally, you must upload your file with the\npurpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/legacy-fine-tuning/creating-training-data) for more\ndetails.", "type": { "$id": "390", "kind": "nullable", @@ -3663,7 +3663,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The name of the base model to fine-tune. You can select one of \"ada\", \"babbage\", \"curie\",\n\"davinci\", or a fine-tuned model created after 2022-04-21 and before 2023-08-22. To learn more\nabout these models, see the [Models](/docs/models) documentation.", + "doc": "The name of the base model to fine-tune. You can select one of \"ada\", \"babbage\", \"curie\",\n\"davinci\", or a fine-tuned model created after 2022-04-21 and before 2023-08-22. To learn more\nabout these models, see the [Models](/docs/models) documentation.", "type": { "$id": "393", "kind": "nullable", @@ -3683,7 +3683,7 @@ "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", - "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", + "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", "type": { "$id": "395", "kind": "nullable", @@ -3707,7 +3707,7 @@ "kind": "property", "name": "batch_size", "serializedName": "batch_size", - "description": "The batch size to use for training. The batch size is the number of training examples used to\ntrain a single forward and backward pass.\n\nBy default, the batch size will be dynamically configured to be ~0.2% of the number of examples\nin the training set, capped at 256 - in general, we've found that larger batch sizes tend to\nwork better for larger datasets.", + "doc": "The batch size to use for training. The batch size is the number of training examples used to\ntrain a single forward and backward pass.\n\nBy default, the batch size will be dynamically configured to be ~0.2% of the number of examples\nin the training set, capped at 256 - in general, we've found that larger batch sizes tend to\nwork better for larger datasets.", "type": { "$id": "398", "kind": "nullable", @@ -3731,7 +3731,7 @@ "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", - "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original\nlearning rate used for pretraining multiplied by this value.\n\nBy default, the learning rate multiplier is the 0.05, 0.1, or 0.2 depending on final\n`batch_size` (larger learning rates tend to perform better with larger batch sizes). We\nrecommend experimenting with values in the range 0.02 to 0.2 to see what produces the best\nresults.", + "doc": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original\nlearning rate used for pretraining multiplied by this value.\n\nBy default, the learning rate multiplier is the 0.05, 0.1, or 0.2 depending on final\n`batch_size` (larger learning rates tend to perform better with larger batch sizes). We\nrecommend experimenting with values in the range 0.02 to 0.2 to see what produces the best\nresults.", "type": { "$id": "401", "kind": "nullable", @@ -3755,7 +3755,7 @@ "kind": "property", "name": "prompt_loss_rate", "serializedName": "prompt_loss_rate", - "description": "The weight to use for loss on the prompt tokens. This controls how much the model tries to\nlearn to generate the prompt (as compared to the completion which always has a weight of 1.0),\nand can add a stabilizing effect to training when completions are short.\n\nIf prompts are extremely long (relative to completions), it may make sense to reduce this\nweight so as to avoid over-prioritizing learning the prompt.", + "doc": "The weight to use for loss on the prompt tokens. This controls how much the model tries to\nlearn to generate the prompt (as compared to the completion which always has a weight of 1.0),\nand can add a stabilizing effect to training when completions are short.\n\nIf prompts are extremely long (relative to completions), it may make sense to reduce this\nweight so as to avoid over-prioritizing learning the prompt.", "type": { "$id": "404", "kind": "nullable", @@ -3779,7 +3779,7 @@ "kind": "property", "name": "compute_classification_metrics", "serializedName": "compute_classification_metrics", - "description": "If set, we calculate classification-specific metrics such as accuracy and F-1 score using the\nvalidation set at the end of every epoch. These metrics can be viewed in the\n[results file](/docs/guides/legacy-fine-tuning/analyzing-your-fine-tuned-model).\n\nIn order to compute classification metrics, you must provide a `validation_file`. Additionally,\nyou must specify `classification_n_classes` for multiclass classification or\n`classification_positive_class` for binary classification.", + "doc": "If set, we calculate classification-specific metrics such as accuracy and F-1 score using the\nvalidation set at the end of every epoch. These metrics can be viewed in the\n[results file](/docs/guides/legacy-fine-tuning/analyzing-your-fine-tuned-model).\n\nIn order to compute classification metrics, you must provide a `validation_file`. Additionally,\nyou must specify `classification_n_classes` for multiclass classification or\n`classification_positive_class` for binary classification.", "type": { "$id": "407", "kind": "nullable", @@ -3803,7 +3803,7 @@ "kind": "property", "name": "classification_n_classes", "serializedName": "classification_n_classes", - "description": "The number of classes in a classification task.\n\nThis parameter is required for multiclass classification.", + "doc": "The number of classes in a classification task.\n\nThis parameter is required for multiclass classification.", "type": { "$id": "410", "kind": "nullable", @@ -3827,7 +3827,7 @@ "kind": "property", "name": "classification_positive_class", "serializedName": "classification_positive_class", - "description": "The positive class in binary classification.\n\nThis parameter is needed to generate precision, recall, and F1 metrics when doing binary\nclassification.", + "doc": "The positive class in binary classification.\n\nThis parameter is needed to generate precision, recall, and F1 metrics when doing binary\nclassification.", "type": { "$id": "413", "kind": "nullable", @@ -3851,7 +3851,7 @@ "kind": "property", "name": "classification_betas", "serializedName": "classification_betas", - "description": "If this is provided, we calculate F-beta scores at the specified beta values. The F-beta score\nis a generalization of F-1 score. This is only used for binary classification.\n\nWith a beta of 1 (i.e. the F-1 score), precision and recall are given the same weight. A larger\nbeta score puts more weight on recall and less on precision. A smaller beta score puts more\nweight on precision and less on recall.", + "doc": "If this is provided, we calculate F-beta scores at the specified beta values. The F-beta score\nis a generalization of F-1 score. This is only used for binary classification.\n\nWith a beta of 1 (i.e. the F-1 score), precision and recall are given the same weight. A larger\nbeta score puts more weight on recall and less on precision. A smaller beta score puts more\nweight on precision and less on recall.", "type": { "$id": "416", "kind": "nullable", @@ -3882,7 +3882,7 @@ "kind": "property", "name": "suffix", "serializedName": "suffix", - "description": "A string of up to 18 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like\n`ada:ft-your-org:custom-model-name-2022-02-15-04-21-04`.", + "doc": "A string of up to 18 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like\n`ada:ft-your-org:custom-model-name-2022-02-15-04-21-04`.", "type": { "$id": "420", "kind": "nullable", @@ -3917,7 +3917,7 @@ "crossLanguageDefinitionId": "OpenAI.FineTune", "usage": "Output,Json", "deprecation": "deprecated", - "description": "The `FineTune` object represents a legacy fine-tune job that has been created through the API.", + "doc": "The `FineTune` object represents a legacy fine-tune job that has been created through the API.", "decorators": [], "properties": [ { @@ -3925,7 +3925,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The object identifier, which can be referenced in the API endpoints.", + "doc": "The object identifier, which can be referenced in the API endpoints.", "type": { "$id": "425", "kind": "string", @@ -3945,7 +3945,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"fine-tune\".", + "doc": "The object type, which is always \"fine-tune\".", "type": { "$id": "427", "kind": "constant", @@ -3967,7 +3967,7 @@ "kind": "property", "name": "created_at", "serializedName": "created_at", - "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", + "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", "type": { "$id": "429", "kind": "utcDateTime", @@ -3995,7 +3995,7 @@ "kind": "property", "name": "updated_at", "serializedName": "updated_at", - "description": "The Unix timestamp (in seconds) for when the fine-tuning job was last updated.", + "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was last updated.", "type": { "$id": "432", "kind": "utcDateTime", @@ -4023,7 +4023,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The base model that is being fine-tuned.", + "doc": "The base model that is being fine-tuned.", "type": { "$id": "435", "kind": "string", @@ -4043,7 +4043,7 @@ "kind": "property", "name": "fine_tuned_model", "serializedName": "fine_tuned_model", - "description": "The name of the fine-tuned model that is being created.", + "doc": "The name of the fine-tuned model that is being created.", "type": { "$id": "437", "kind": "nullable", @@ -4067,7 +4067,7 @@ "kind": "property", "name": "organization_id", "serializedName": "organization_id", - "description": "The organization that owns the fine-tuning job.", + "doc": "The organization that owns the fine-tuning job.", "type": { "$id": "440", "kind": "string", @@ -4087,7 +4087,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The current status of the fine-tuning job, which can be either `created`, `running`,\n`succeeded`, `failed`, or `cancelled`.", + "doc": "The current status of the fine-tuning job, which can be either `created`, `running`,\n`succeeded`, `failed`, or `cancelled`.", "type": { "$ref": "38" }, @@ -4103,7 +4103,7 @@ "kind": "property", "name": "hyperparams", "serializedName": "hyperparams", - "description": "The hyperparameters used for the fine-tuning job. See the\n[fine-tuning guide](/docs/guides/legacy-fine-tuning/hyperparameters) for more details.", + "doc": "The hyperparameters used for the fine-tuning job. See the\n[fine-tuning guide](/docs/guides/legacy-fine-tuning/hyperparameters) for more details.", "type": { "$id": "443", "kind": "model", @@ -4117,7 +4117,7 @@ "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", - "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", + "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", "type": { "$id": "445", "kind": "safeint", @@ -4137,7 +4137,7 @@ "kind": "property", "name": "batch_size", "serializedName": "batch_size", - "description": "The batch size to use for training. The batch size is the number of training examples used to\ntrain a single forward and backward pass.", + "doc": "The batch size to use for training. The batch size is the number of training examples used to\ntrain a single forward and backward pass.", "type": { "$id": "447", "kind": "safeint", @@ -4157,7 +4157,7 @@ "kind": "property", "name": "prompt_loss_weight", "serializedName": "prompt_loss_weight", - "description": "The weight to use for loss on the prompt tokens.", + "doc": "The weight to use for loss on the prompt tokens.", "type": { "$id": "449", "kind": "float64", @@ -4177,7 +4177,7 @@ "kind": "property", "name": "learning_rate_multiplier", "serializedName": "learning_rate_multiplier", - "description": "The learning rate multiplier to use for training.", + "doc": "The learning rate multiplier to use for training.", "type": { "$id": "451", "kind": "float64", @@ -4197,7 +4197,7 @@ "kind": "property", "name": "compute_classification_metrics", "serializedName": "compute_classification_metrics", - "description": "The classification metrics to compute using the validation dataset at the end of every epoch.", + "doc": "The classification metrics to compute using the validation dataset at the end of every epoch.", "type": { "$id": "453", "kind": "boolean", @@ -4217,7 +4217,7 @@ "kind": "property", "name": "classification_positive_class", "serializedName": "classification_positive_class", - "description": "The positive class to use for computing classification metrics.", + "doc": "The positive class to use for computing classification metrics.", "type": { "$id": "455", "kind": "string", @@ -4237,7 +4237,7 @@ "kind": "property", "name": "classification_n_classes", "serializedName": "classification_n_classes", - "description": "The number of classes to use for computing classification metrics.", + "doc": "The number of classes to use for computing classification metrics.", "type": { "$id": "457", "kind": "safeint", @@ -4266,7 +4266,7 @@ "kind": "property", "name": "training_files", "serializedName": "training_files", - "description": "The list of files used for training.", + "doc": "The list of files used for training.", "type": { "$id": "459", "kind": "array", @@ -4277,7 +4277,7 @@ "name": "OpenAIFile", "crossLanguageDefinitionId": "OpenAI.OpenAIFile", "usage": "Output,Json", - "description": "The `File` object represents a document that has been uploaded to OpenAI.", + "doc": "The `File` object represents a document that has been uploaded to OpenAI.", "decorators": [], "properties": [ { @@ -4285,7 +4285,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The file identifier, which can be referenced in the API endpoints.", + "doc": "The file identifier, which can be referenced in the API endpoints.", "type": { "$id": "462", "kind": "string", @@ -4305,7 +4305,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"file\".", + "doc": "The object type, which is always \"file\".", "type": { "$id": "464", "kind": "constant", @@ -4327,7 +4327,7 @@ "kind": "property", "name": "bytes", "serializedName": "bytes", - "description": "The size of the file in bytes.", + "doc": "The size of the file in bytes.", "type": { "$id": "466", "kind": "safeint", @@ -4347,7 +4347,7 @@ "kind": "property", "name": "createdAt", "serializedName": "createdAt", - "description": "The Unix timestamp (in seconds) for when the file was created.", + "doc": "The Unix timestamp (in seconds) for when the file was created.", "type": { "$id": "468", "kind": "utcDateTime", @@ -4375,7 +4375,7 @@ "kind": "property", "name": "filename", "serializedName": "filename", - "description": "The name of the file.", + "doc": "The name of the file.", "type": { "$id": "471", "kind": "string", @@ -4395,7 +4395,7 @@ "kind": "property", "name": "purpose", "serializedName": "purpose", - "description": "The intended purpose of the file. Currently, only \"fine-tune\" is supported.", + "doc": "The intended purpose of the file. Currently, only \"fine-tune\" is supported.", "type": { "$id": "473", "kind": "string", @@ -4415,7 +4415,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The current status of the file, which can be either `uploaded`, `processed`, `pending`,\n`error`, `deleting` or `deleted`.", + "doc": "The current status of the file, which can be either `uploaded`, `processed`, `pending`,\n`error`, `deleting` or `deleted`.", "type": { "$ref": "53" }, @@ -4431,7 +4431,7 @@ "kind": "property", "name": "status_details", "serializedName": "status_details", - "description": "Additional details about the status of the file. If the file is in the `error` state, this will\ninclude a message describing the error.", + "doc": "Additional details about the status of the file. If the file is in the `error` state, this will\ninclude a message describing the error.", "type": { "$id": "476", "kind": "nullable", @@ -4467,7 +4467,7 @@ "kind": "property", "name": "validation_files", "serializedName": "validation_files", - "description": "The list of files used for validation.", + "doc": "The list of files used for validation.", "type": { "$id": "479", "kind": "array", @@ -4490,7 +4490,7 @@ "kind": "property", "name": "result_files", "serializedName": "result_files", - "description": "The compiled results files for the fine-tuning job.", + "doc": "The compiled results files for the fine-tuning job.", "type": { "$id": "481", "kind": "array", @@ -4513,7 +4513,7 @@ "kind": "property", "name": "events", "serializedName": "events", - "description": "The list of events that have been observed in the lifecycle of the FineTune job.", + "doc": "The list of events that have been observed in the lifecycle of the FineTune job.", "type": { "$id": "483", "kind": "array", @@ -4799,7 +4799,7 @@ "kind": "property", "name": "file", "serializedName": "file", - "description": "Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\n\nIf the `purpose` is set to \"fine-tune\", the file will be used for fine-tuning.", + "doc": "Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\n\nIf the `purpose` is set to \"fine-tune\", the file will be used for fine-tuning.", "type": { "$id": "511", "kind": "bytes", @@ -4820,7 +4820,7 @@ "kind": "property", "name": "purpose", "serializedName": "purpose", - "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\n[fine-tuning](/docs/api-reference/fine-tuning). This allows us to validate the format of the\nuploaded file.", + "doc": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\n[fine-tuning](/docs/api-reference/fine-tuning). This allows us to validate the format of the\nuploaded file.", "type": { "$id": "513", "kind": "string", @@ -4917,7 +4917,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.", + "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.", "type": { "$ref": "67" }, @@ -4933,7 +4933,7 @@ "kind": "property", "name": "input", "serializedName": "input", - "description": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a\nsingle request, pass an array of strings or array of token arrays. Each input must not exceed\nthe max input tokens for the model (8191 tokens for `text-embedding-ada-002`) and cannot be an empty string.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", + "doc": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a\nsingle request, pass an array of strings or array of token arrays. Each input must not exceed\nthe max input tokens for the model (8191 tokens for `text-embedding-ada-002`) and cannot be an empty string.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", "type": { "$id": "524", "kind": "union", @@ -5046,7 +5046,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"embedding\".", + "doc": "The object type, which is always \"embedding\".", "type": { "$id": "538", "kind": "constant", @@ -5068,7 +5068,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The name of the model used to generate the embedding.", + "doc": "The name of the model used to generate the embedding.", "type": { "$id": "540", "kind": "string", @@ -5088,7 +5088,7 @@ "kind": "property", "name": "data", "serializedName": "data", - "description": "The list of embeddings generated by the model.", + "doc": "The list of embeddings generated by the model.", "type": { "$id": "542", "kind": "array", @@ -5099,7 +5099,7 @@ "name": "Embedding", "crossLanguageDefinitionId": "OpenAI.Embedding", "usage": "Output,Json", - "description": "Represents an embedding vector returned by embedding endpoint.", + "doc": "Represents an embedding vector returned by embedding endpoint.", "decorators": [], "properties": [ { @@ -5107,7 +5107,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index of the embedding in the list of embeddings.", + "doc": "The index of the embedding in the list of embeddings.", "type": { "$id": "545", "kind": "safeint", @@ -5127,7 +5127,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"embedding\".", + "doc": "The object type, which is always \"embedding\".", "type": { "$id": "547", "kind": "constant", @@ -5149,7 +5149,7 @@ "kind": "property", "name": "embedding", "serializedName": "embedding", - "description": "The embedding vector, which is a list of floats. The length of vector depends on the model as\\\nlisted in the [embedding guide](/docs/guides/embeddings).", + "doc": "The embedding vector, which is a list of floats. The length of vector depends on the model as\\\nlisted in the [embedding guide](/docs/guides/embeddings).", "type": { "$id": "549", "kind": "array", @@ -5188,7 +5188,7 @@ "kind": "property", "name": "usage", "serializedName": "usage", - "description": "The usage information for the request.", + "doc": "The usage information for the request.", "type": { "$id": "552", "kind": "model", @@ -5202,7 +5202,7 @@ "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", - "description": "The number of tokens used by the prompt.", + "doc": "The number of tokens used by the prompt.", "type": { "$id": "554", "kind": "safeint", @@ -5222,7 +5222,7 @@ "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", - "description": "The total number of tokens used by the request.", + "doc": "The total number of tokens used by the request.", "type": { "$id": "556", "kind": "safeint", @@ -5267,7 +5267,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. You can use the `text-davinci-edit-001` or `code-davinci-edit-001`\nmodel with this endpoint.", + "doc": "ID of the model to use. You can use the `text-davinci-edit-001` or `code-davinci-edit-001`\nmodel with this endpoint.", "type": { "$ref": "77" }, @@ -5283,7 +5283,7 @@ "kind": "property", "name": "input", "serializedName": "input", - "description": "The input text to use as a starting point for the edit.", + "doc": "The input text to use as a starting point for the edit.", "type": { "$id": "560", "kind": "nullable", @@ -5307,7 +5307,7 @@ "kind": "property", "name": "instruction", "serializedName": "instruction", - "description": "The instruction that tells the model how to edit the prompt.", + "doc": "The instruction that tells the model how to edit the prompt.", "type": { "$id": "563", "kind": "string", @@ -5327,7 +5327,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "How many edits to generate for the input and instruction.", + "doc": "How many edits to generate for the input and instruction.", "type": { "$id": "565", "kind": "nullable", @@ -5358,7 +5358,7 @@ "kind": "property", "name": "temperature", "serializedName": "temperature", - "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", + "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", "type": { "$id": "569", "kind": "nullable", @@ -5389,7 +5389,7 @@ "kind": "property", "name": "top_p", "serializedName": "top_p", - "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", + "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$id": "573", "kind": "nullable", @@ -5431,7 +5431,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always `edit`.", + "doc": "The object type, which is always `edit`.", "type": { "$id": "578", "kind": "constant", @@ -5453,7 +5453,7 @@ "kind": "property", "name": "created", "serializedName": "created", - "description": "The Unix timestamp (in seconds) of when the edit was created.", + "doc": "The Unix timestamp (in seconds) of when the edit was created.", "type": { "$id": "580", "kind": "utcDateTime", @@ -5481,7 +5481,7 @@ "kind": "property", "name": "choices", "serializedName": "choices", - "description": "description: A list of edit choices. Can be more than one if `n` is greater than 1.", + "doc": "description: A list of edit choices. Can be more than one if `n` is greater than 1.", "type": { "$id": "583", "kind": "array", @@ -5499,7 +5499,7 @@ "kind": "property", "name": "text", "serializedName": "text", - "description": "The edited result.", + "doc": "The edited result.", "type": { "$id": "586", "kind": "string", @@ -5519,7 +5519,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index of the choice in the list of choices.", + "doc": "The index of the choice in the list of choices.", "type": { "$id": "588", "kind": "safeint", @@ -5539,7 +5539,7 @@ "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", - "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, or `length` if the maximum number of tokens\nspecified in the request was reached.", + "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, or `length` if the maximum number of tokens\nspecified in the request was reached.", "type": { "$ref": "86" }, @@ -5573,7 +5573,7 @@ "name": "CompletionUsage", "crossLanguageDefinitionId": "OpenAI.CompletionUsage", "usage": "Output,Json", - "description": "Usage statistics for the completion request.", + "doc": "Usage statistics for the completion request.", "decorators": [], "properties": [ { @@ -5581,7 +5581,7 @@ "kind": "property", "name": "prompt_tokens", "serializedName": "prompt_tokens", - "description": "Number of tokens in the prompt.", + "doc": "Number of tokens in the prompt.", "type": { "$id": "593", "kind": "safeint", @@ -5601,7 +5601,7 @@ "kind": "property", "name": "completion_tokens", "serializedName": "completion_tokens", - "description": "Number of tokens in the generated completion", + "doc": "Number of tokens in the generated completion", "type": { "$id": "595", "kind": "safeint", @@ -5621,7 +5621,7 @@ "kind": "property", "name": "total_tokens", "serializedName": "total_tokens", - "description": "Total number of tokens used in the request (prompt + completion).", + "doc": "Total number of tokens used in the request (prompt + completion).", "type": { "$id": "597", "kind": "safeint", @@ -5666,7 +5666,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to\nsee all of your available models, or see our [Model overview](/docs/models/overview) for\ndescriptions of them.", + "doc": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to\nsee all of your available models, or see our [Model overview](/docs/models/overview) for\ndescriptions of them.", "type": { "$ref": "92" }, @@ -5682,7 +5682,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of\ntokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a\nprompt is not specified the model will generate as if from the beginning of a new document.", + "doc": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of\ntokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a\nprompt is not specified the model will generate as if from the beginning of a new document.", "type": { "$id": "601", "kind": "nullable", @@ -5763,7 +5763,7 @@ "kind": "property", "name": "suffix", "serializedName": "suffix", - "description": "The suffix that comes after a completion of inserted text.", + "doc": "The suffix that comes after a completion of inserted text.", "type": { "$id": "612", "kind": "nullable", @@ -5787,7 +5787,7 @@ "kind": "property", "name": "temperature", "serializedName": "temperature", - "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", + "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", "type": { "$id": "615", "kind": "nullable", @@ -5818,7 +5818,7 @@ "kind": "property", "name": "top_p", "serializedName": "top_p", - "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", + "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$id": "619", "kind": "nullable", @@ -5849,7 +5849,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "How many completions to generate for each prompt.\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", + "doc": "How many completions to generate for each prompt.\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", "type": { "$id": "623", "kind": "nullable", @@ -5880,7 +5880,7 @@ "kind": "property", "name": "max_tokens", "serializedName": "max_tokens", - "description": "The maximum number of [tokens](/tokenizer) to generate in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", + "doc": "The maximum number of [tokens](/tokenizer) to generate in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", "type": { "$id": "627", "kind": "nullable", @@ -5911,7 +5911,7 @@ "kind": "property", "name": "stop", "serializedName": "stop", - "description": "Up to 4 sequences where the API will stop generating further tokens.", + "doc": "Up to 4 sequences where the API will stop generating further tokens.", "type": { "$id": "631", "kind": "nullable", @@ -5957,7 +5957,7 @@ "kind": "property", "name": "presence_penalty", "serializedName": "presence_penalty", - "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear\nin the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", + "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear\nin the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", "type": { "$id": "637", "kind": "nullable", @@ -5988,7 +5988,7 @@ "kind": "property", "name": "frequency_penalty", "serializedName": "frequency_penalty", - "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing\nfrequency in the text so far, decreasing the model's likelihood to repeat the same line\nverbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", + "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing\nfrequency in the text so far, decreasing the model's likelihood to repeat the same line\nverbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", "type": { "$id": "641", "kind": "nullable", @@ -6019,7 +6019,7 @@ "kind": "property", "name": "logit_bias", "serializedName": "logit_bias", - "description": "Modify the likelihood of specified tokens appearing in the completion.\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an\nassociated bias value from -100 to 100. Mathematically, the bias is added to the logits\ngenerated by the model prior to sampling. The exact effect will vary per model, but values\nbetween -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.", + "doc": "Modify the likelihood of specified tokens appearing in the completion.\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an\nassociated bias value from -100 to 100. Mathematically, the bias is added to the logits\ngenerated by the model prior to sampling. The exact effect will vary per model, but values\nbetween -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.", "type": { "$id": "645", "kind": "nullable", @@ -6055,7 +6055,7 @@ "kind": "property", "name": "user", "serializedName": "user", - "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect\nabuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).", + "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect\nabuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).", "type": { "$id": "650", "kind": "string", @@ -6082,7 +6082,7 @@ "kind": "property", "name": "stream", "serializedName": "stream", - "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available, with the stream terminated by a `data: [DONE]` message.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).", + "doc": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available, with the stream terminated by a `data: [DONE]` message.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).", "type": { "$id": "653", "kind": "nullable", @@ -6106,7 +6106,7 @@ "kind": "property", "name": "logprobs", "serializedName": "logprobs", - "description": "Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens.\nFor example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The\nAPI will always return the `logprob` of the sampled token, so there may be up to `logprobs+1`\nelements in the response.\n\nThe maximum value for `logprobs` is 5.", + "doc": "Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens.\nFor example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The\nAPI will always return the `logprob` of the sampled token, so there may be up to `logprobs+1`\nelements in the response.\n\nThe maximum value for `logprobs` is 5.", "type": { "$id": "656", "kind": "nullable", @@ -6130,7 +6130,7 @@ "kind": "property", "name": "echo", "serializedName": "echo", - "description": "Echo back the prompt in addition to the completion", + "doc": "Echo back the prompt in addition to the completion", "type": { "$id": "659", "kind": "nullable", @@ -6154,7 +6154,7 @@ "kind": "property", "name": "best_of", "serializedName": "best_of", - "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest\nlog probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies\nhow many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", + "doc": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest\nlog probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies\nhow many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", "type": { "$id": "662", "kind": "nullable", @@ -6181,7 +6181,7 @@ "name": "CreateCompletionResponse", "crossLanguageDefinitionId": "OpenAI.CreateCompletionResponse", "usage": "Output,Json", - "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response\nobjects share the same shape (unlike the chat endpoint).", + "doc": "Represents a completion response from the API. Note: both the streamed and non-streamed response\nobjects share the same shape (unlike the chat endpoint).", "decorators": [], "properties": [ { @@ -6189,7 +6189,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "A unique identifier for the completion.", + "doc": "A unique identifier for the completion.", "type": { "$id": "666", "kind": "string", @@ -6209,7 +6209,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always `text_completion`.", + "doc": "The object type, which is always `text_completion`.", "type": { "$id": "668", "kind": "string", @@ -6229,7 +6229,7 @@ "kind": "property", "name": "created", "serializedName": "created", - "description": "The Unix timestamp (in seconds) of when the completion was created.", + "doc": "The Unix timestamp (in seconds) of when the completion was created.", "type": { "$id": "670", "kind": "utcDateTime", @@ -6257,7 +6257,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The model used for the completion.", + "doc": "The model used for the completion.", "type": { "$id": "673", "kind": "string", @@ -6277,7 +6277,7 @@ "kind": "property", "name": "choices", "serializedName": "choices", - "description": "The list of completion choices the model generated for the input.", + "doc": "The list of completion choices the model generated for the input.", "type": { "$id": "675", "kind": "array", @@ -6475,7 +6475,7 @@ "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", - "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, or `content_filter` if content was omitted\ndue to a flag from our content filters, `length` if the maximum number of tokens specified\nin the request was reached, or `content_filter` if content was omitted due to a flag from our\ncontent filters.", + "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, or `content_filter` if content was omitted\ndue to a flag from our content filters, `length` if the maximum number of tokens specified\nin the request was reached, or `content_filter` if content was omitted due to a flag from our\ncontent filters.", "type": { "$ref": "112" }, @@ -6534,7 +6534,7 @@ "kind": "property", "name": "training_file", "serializedName": "training_file", - "description": "The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/upload) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with\nthe purpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/fine-tuning) for more details.", + "doc": "The ID of an uploaded file that contains training data.\n\nSee [upload file](/docs/api-reference/files/upload) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with\nthe purpose `fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/fine-tuning) for more details.", "type": { "$id": "702", "kind": "string", @@ -6554,7 +6554,7 @@ "kind": "property", "name": "validation_file", "serializedName": "validation_file", - "description": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation metrics periodically during\nfine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should\nnot be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose\n`fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/fine-tuning) for more details.", + "doc": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation metrics periodically during\nfine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should\nnot be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose\n`fine-tune`.\n\nSee the [fine-tuning guide](/docs/guides/fine-tuning) for more details.", "type": { "$id": "704", "kind": "nullable", @@ -6578,7 +6578,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The name of the model to fine-tune. You can select one of the\n[supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).", + "doc": "The name of the model to fine-tune. You can select one of the\n[supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).", "type": { "$ref": "120" }, @@ -6594,7 +6594,7 @@ "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", - "description": "The hyperparameters used for the fine-tuning job.", + "doc": "The hyperparameters used for the fine-tuning job.", "type": { "$id": "708", "kind": "model", @@ -6608,7 +6608,7 @@ "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", - "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", + "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.", "type": { "$id": "710", "kind": "union", @@ -6665,7 +6665,7 @@ "kind": "property", "name": "suffix", "serializedName": "suffix", - "description": "A string of up to 18 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like\n`ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.", + "doc": "A string of up to 18 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like\n`ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.", "type": { "$id": "716", "kind": "nullable", @@ -6709,7 +6709,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "The object identifier, which can be referenced in the API endpoints.", + "doc": "The object identifier, which can be referenced in the API endpoints.", "type": { "$id": "721", "kind": "string", @@ -6729,7 +6729,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always \"fine_tuning.job\".", + "doc": "The object type, which is always \"fine_tuning.job\".", "type": { "$id": "723", "kind": "constant", @@ -6751,7 +6751,7 @@ "kind": "property", "name": "created_at", "serializedName": "created_at", - "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", + "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was created.", "type": { "$id": "725", "kind": "utcDateTime", @@ -6779,7 +6779,7 @@ "kind": "property", "name": "finished_at", "serializedName": "finished_at", - "description": "The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be\nnull if the fine-tuning job is still running.", + "doc": "The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be\nnull if the fine-tuning job is still running.", "type": { "$id": "728", "kind": "nullable", @@ -6811,7 +6811,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The base model that is being fine-tuned.", + "doc": "The base model that is being fine-tuned.", "type": { "$id": "732", "kind": "string", @@ -6831,7 +6831,7 @@ "kind": "property", "name": "fine_tuned_model", "serializedName": "fine_tuned_model", - "description": "The name of the fine-tuned model that is being created. The value will be null if the\nfine-tuning job is still running.", + "doc": "The name of the fine-tuned model that is being created. The value will be null if the\nfine-tuning job is still running.", "type": { "$id": "734", "kind": "nullable", @@ -6855,7 +6855,7 @@ "kind": "property", "name": "organization_id", "serializedName": "organization_id", - "description": "The organization that owns the fine-tuning job.", + "doc": "The organization that owns the fine-tuning job.", "type": { "$id": "737", "kind": "string", @@ -6875,7 +6875,7 @@ "kind": "property", "name": "status", "serializedName": "status", - "description": "The current status of the fine-tuning job, which can be either `created`, `pending`, `running`,\n`succeeded`, `failed`, or `cancelled`.", + "doc": "The current status of the fine-tuning job, which can be either `created`, `pending`, `running`,\n`succeeded`, `failed`, or `cancelled`.", "type": { "$ref": "131" }, @@ -6891,7 +6891,7 @@ "kind": "property", "name": "hyperparameters", "serializedName": "hyperparameters", - "description": "The hyperparameters used for the fine-tuning job. See the\n[fine-tuning guide](/docs/guides/fine-tuning) for more details.", + "doc": "The hyperparameters used for the fine-tuning job. See the\n[fine-tuning guide](/docs/guides/fine-tuning) for more details.", "type": { "$id": "740", "kind": "model", @@ -6905,7 +6905,7 @@ "kind": "property", "name": "n_epochs", "serializedName": "n_epochs", - "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.\n\n\"Auto\" decides the optimal number of epochs based on the size of the dataset. If setting the\nnumber manually, we support any number between 1 and 50 epochs.", + "doc": "The number of epochs to train the model for. An epoch refers to one full cycle through the\ntraining dataset.\n\n\"Auto\" decides the optimal number of epochs based on the size of the dataset. If setting the\nnumber manually, we support any number between 1 and 50 epochs.", "type": { "$id": "742", "kind": "union", @@ -6962,7 +6962,7 @@ "kind": "property", "name": "training_file", "serializedName": "training_file", - "description": "The file ID used for training. You can retrieve the training data with the\n[Files API](/docs/api-reference/files/retrieve-contents).", + "doc": "The file ID used for training. You can retrieve the training data with the\n[Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$id": "748", "kind": "string", @@ -6982,7 +6982,7 @@ "kind": "property", "name": "validation_file", "serializedName": "validation_file", - "description": "The file ID used for validation. You can retrieve the validation results with the\n[Files API](/docs/api-reference/files/retrieve-contents).", + "doc": "The file ID used for validation. You can retrieve the validation results with the\n[Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$id": "750", "kind": "nullable", @@ -7006,7 +7006,7 @@ "kind": "property", "name": "result_files", "serializedName": "result_files", - "description": "The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the\n[Files API](/docs/api-reference/files/retrieve-contents).", + "doc": "The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the\n[Files API](/docs/api-reference/files/retrieve-contents).", "type": { "$id": "753", "kind": "array", @@ -7033,7 +7033,7 @@ "kind": "property", "name": "trained_tokens", "serializedName": "trained_tokens", - "description": "The total number of billable tokens processed by this fine tuning job. The value will be null\nif the fine-tuning job is still running.", + "doc": "The total number of billable tokens processed by this fine tuning job. The value will be null\nif the fine-tuning job is still running.", "type": { "$id": "756", "kind": "nullable", @@ -7057,7 +7057,7 @@ "kind": "property", "name": "error", "serializedName": "error", - "description": "For fine-tuning jobs that have `failed`, this will contain more information on the cause of the\nfailure.", + "doc": "For fine-tuning jobs that have `failed`, this will contain more information on the cause of the\nfailure.", "type": { "$id": "759", "kind": "nullable", @@ -7074,7 +7074,7 @@ "kind": "property", "name": "message", "serializedName": "message", - "description": "A human-readable error message.", + "doc": "A human-readable error message.", "type": { "$id": "762", "kind": "string", @@ -7094,7 +7094,7 @@ "kind": "property", "name": "code", "serializedName": "code", - "description": "A machine-readable error code.", + "doc": "A machine-readable error code.", "type": { "$id": "764", "kind": "string", @@ -7114,7 +7114,7 @@ "kind": "property", "name": "param", "serializedName": "param", - "description": "The parameter that was invalid, usually `training_file` or `validation_file`. This field\nwill be null if the failure was not parameter-specific.", + "doc": "The parameter that was invalid, usually `training_file` or `validation_file`. This field\nwill be null if the failure was not parameter-specific.", "type": { "$id": "766", "kind": "nullable", @@ -7394,7 +7394,7 @@ "kind": "property", "name": "role", "serializedName": "role", - "description": "The role of the messages author. One of `system`, `user`, `assistant`, or `function`.", + "doc": "The role of the messages author. One of `system`, `user`, `assistant`, or `function`.", "type": { "$ref": "177" }, @@ -7410,7 +7410,7 @@ "kind": "property", "name": "content", "serializedName": "content", - "description": "The contents of the message. `content` is required for all messages, and may be null for\nassistant messages with function calls.", + "doc": "The contents of the message. `content` is required for all messages, and may be null for\nassistant messages with function calls.", "type": { "$id": "794", "kind": "nullable", @@ -7434,7 +7434,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the author of this message. `name` is required if role is `function`, and it\nshould be the name of the function whose response is in the `content`. May contain a-z,\nA-Z, 0-9, and underscores, with a maximum length of 64 characters.", + "doc": "The name of the author of this message. `name` is required if role is `function`, and it\nshould be the name of the function whose response is in the `content`. May contain a-z,\nA-Z, 0-9, and underscores, with a maximum length of 64 characters.", "type": { "$id": "797", "kind": "string", @@ -7454,7 +7454,7 @@ "kind": "property", "name": "function_call", "serializedName": "function_call", - "description": "The name and arguments of a function that should be called, as generated by the model.", + "doc": "The name and arguments of a function that should be called, as generated by the model.", "type": { "$id": "799", "kind": "model", @@ -7468,7 +7468,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the function to call.", + "doc": "The name of the function to call.", "type": { "$id": "801", "kind": "string", @@ -7488,7 +7488,7 @@ "kind": "property", "name": "arguments", "serializedName": "arguments", - "description": "The arguments to call the function with, as generated by the model in JSON format. Note that\nthe model does not always generate valid JSON, and may hallucinate parameters not defined by\nyour function schema. Validate the arguments in your code before calling your function.", + "doc": "The arguments to call the function with, as generated by the model in JSON format. Note that\nthe model does not always generate valid JSON, and may hallucinate parameters not defined by\nyour function schema. Validate the arguments in your code before calling your function.", "type": { "$id": "803", "kind": "string", @@ -7530,7 +7530,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and\ndashes, with a maximum length of 64.", + "doc": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and\ndashes, with a maximum length of 64.", "type": { "$id": "806", "kind": "string", @@ -7550,7 +7550,7 @@ "kind": "property", "name": "description", "serializedName": "description", - "description": "A description of what the function does, used by the model to choose when and how to call the\nfunction.", + "doc": "A description of what the function does, used by the model to choose when and how to call the\nfunction.", "type": { "$id": "808", "kind": "string", @@ -7570,7 +7570,7 @@ "kind": "property", "name": "parameters", "serializedName": "parameters", - "description": "The parameters the functions accepts, described as a JSON Schema object. See the\n[guide](/docs/guides/gpt/function-calling) for examples, and the\n[JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation\nabout the format.\\n\\nTo describe a function that accepts no parameters, provide the value\n`{\\\"type\\\": \\\"object\\\", \\\"properties\\\": {}}`.", + "doc": "The parameters the functions accepts, described as a JSON Schema object. See the\n[guide](/docs/guides/gpt/function-calling) for examples, and the\n[JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation\nabout the format.\\n\\nTo describe a function that accepts no parameters, provide the value\n`{\\\"type\\\": \\\"object\\\", \\\"properties\\\": {}}`.", "type": { "$id": "810", "kind": "model", @@ -7612,7 +7612,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the function to call.", + "doc": "The name of the function to call.", "type": { "$id": "814", "kind": "string", @@ -7642,7 +7642,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility)\ntable for details on which models work with the Chat API.", + "doc": "ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility)\ntable for details on which models work with the Chat API.", "type": { "$ref": "153" }, @@ -7658,7 +7658,7 @@ "kind": "property", "name": "messages", "serializedName": "messages", - "description": "A list of messages comprising the conversation so far.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "doc": "A list of messages comprising the conversation so far.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", "type": { "$id": "818", "kind": "array", @@ -7681,7 +7681,7 @@ "kind": "property", "name": "functions", "serializedName": "functions", - "description": "A list of functions the model may generate JSON inputs for.", + "doc": "A list of functions the model may generate JSON inputs for.", "type": { "$id": "820", "kind": "array", @@ -7704,7 +7704,7 @@ "kind": "property", "name": "function_call", "serializedName": "function_call", - "description": "Controls how the model responds to function calls. `none` means the model does not call a\nfunction, and responds to the end-user. `auto` means the model can pick between an end-user or\ncalling a function. Specifying a particular function via `{\\\"name\":\\ \\\"my_function\\\"}` forces the\nmodel to call that function. `none` is the default when no functions are present. `auto` is the\ndefault if functions are present.", + "doc": "Controls how the model responds to function calls. `none` means the model does not call a\nfunction, and responds to the end-user. `auto` means the model can pick between an end-user or\ncalling a function. Specifying a particular function via `{\\\"name\":\\ \\\"my_function\\\"}` forces the\nmodel to call that function. `none` is the default when no functions are present. `auto` is the\ndefault if functions are present.", "type": { "$id": "822", "kind": "union", @@ -7754,7 +7754,7 @@ "kind": "property", "name": "temperature", "serializedName": "temperature", - "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", + "doc": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output\nmore random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.", "type": { "$ref": "615" }, @@ -7770,7 +7770,7 @@ "kind": "property", "name": "top_p", "serializedName": "top_p", - "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", + "doc": "An alternative to sampling with temperature, called nucleus sampling, where the model considers\nthe results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising\nthe top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.", "type": { "$ref": "619" }, @@ -7786,7 +7786,7 @@ "kind": "property", "name": "n", "serializedName": "n", - "description": "How many completions to generate for each prompt.\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", + "doc": "How many completions to generate for each prompt.\n**Note:** Because this parameter generates many completions, it can quickly consume your token\nquota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.", "type": { "$ref": "623" }, @@ -7802,7 +7802,7 @@ "kind": "property", "name": "max_tokens", "serializedName": "max_tokens", - "description": "The maximum number of [tokens](/tokenizer) to generate in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", + "doc": "The maximum number of [tokens](/tokenizer) to generate in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)\nfor counting tokens.", "type": { "$ref": "627" }, @@ -7818,7 +7818,7 @@ "kind": "property", "name": "stop", "serializedName": "stop", - "description": "Up to 4 sequences where the API will stop generating further tokens.", + "doc": "Up to 4 sequences where the API will stop generating further tokens.", "type": { "$ref": "631" }, @@ -7834,7 +7834,7 @@ "kind": "property", "name": "presence_penalty", "serializedName": "presence_penalty", - "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear\nin the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", + "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear\nin the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", "type": { "$ref": "637" }, @@ -7850,7 +7850,7 @@ "kind": "property", "name": "frequency_penalty", "serializedName": "frequency_penalty", - "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing\nfrequency in the text so far, decreasing the model's likelihood to repeat the same line\nverbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", + "doc": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing\nfrequency in the text so far, decreasing the model's likelihood to repeat the same line\nverbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/gpt/parameter-details)", "type": { "$ref": "641" }, @@ -7866,7 +7866,7 @@ "kind": "property", "name": "logit_bias", "serializedName": "logit_bias", - "description": "Modify the likelihood of specified tokens appearing in the completion.\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an\nassociated bias value from -100 to 100. Mathematically, the bias is added to the logits\ngenerated by the model prior to sampling. The exact effect will vary per model, but values\nbetween -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.", + "doc": "Modify the likelihood of specified tokens appearing in the completion.\nAccepts a json object that maps tokens (specified by their token ID in the tokenizer) to an\nassociated bias value from -100 to 100. Mathematically, the bias is added to the logits\ngenerated by the model prior to sampling. The exact effect will vary per model, but values\nbetween -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.", "type": { "$ref": "645" }, @@ -7882,7 +7882,7 @@ "kind": "property", "name": "user", "serializedName": "user", - "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect\nabuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).", + "doc": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect\nabuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).", "type": { "$id": "836", "kind": "string", @@ -7909,7 +7909,7 @@ "kind": "property", "name": "stream", "serializedName": "stream", - "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available, with the stream terminated by a `data: [DONE]` message.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).", + "doc": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available, with the stream terminated by a `data: [DONE]` message.\n[Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb).", "type": { "$ref": "653" }, @@ -7928,7 +7928,7 @@ "name": "CreateChatCompletionResponse", "crossLanguageDefinitionId": "OpenAI.CreateChatCompletionResponse", "usage": "Output,Json", - "description": "Represents a chat completion response returned by model, based on the provided input.", + "doc": "Represents a chat completion response returned by model, based on the provided input.", "decorators": [], "properties": [ { @@ -7936,7 +7936,7 @@ "kind": "property", "name": "id", "serializedName": "id", - "description": "A unique identifier for the chat completion.", + "doc": "A unique identifier for the chat completion.", "type": { "$id": "841", "kind": "string", @@ -7956,7 +7956,7 @@ "kind": "property", "name": "object", "serializedName": "object", - "description": "The object type, which is always `chat.completion`.", + "doc": "The object type, which is always `chat.completion`.", "type": { "$id": "843", "kind": "string", @@ -7976,7 +7976,7 @@ "kind": "property", "name": "created", "serializedName": "created", - "description": "The Unix timestamp (in seconds) of when the chat completion was created.", + "doc": "The Unix timestamp (in seconds) of when the chat completion was created.", "type": { "$id": "845", "kind": "utcDateTime", @@ -8004,7 +8004,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "The model used for the chat completion.", + "doc": "The model used for the chat completion.", "type": { "$id": "848", "kind": "string", @@ -8024,7 +8024,7 @@ "kind": "property", "name": "choices", "serializedName": "choices", - "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", + "doc": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", "type": { "$id": "850", "kind": "array", @@ -8042,7 +8042,7 @@ "kind": "property", "name": "index", "serializedName": "index", - "description": "The index of the choice in the list of choices.", + "doc": "The index of the choice in the list of choices.", "type": { "$id": "853", "kind": "safeint", @@ -8075,7 +8075,7 @@ "kind": "property", "name": "role", "serializedName": "role", - "description": "The role of the author of this message.", + "doc": "The role of the author of this message.", "type": { "$ref": "187" }, @@ -8091,7 +8091,7 @@ "kind": "property", "name": "content", "serializedName": "content", - "description": "The contents of the message.", + "doc": "The contents of the message.", "type": { "$id": "858", "kind": "nullable", @@ -8115,7 +8115,7 @@ "kind": "property", "name": "function_call", "serializedName": "function_call", - "description": "The name and arguments of a function that should be called, as generated by the model.", + "doc": "The name and arguments of a function that should be called, as generated by the model.", "type": { "$id": "861", "kind": "model", @@ -8129,7 +8129,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "The name of the function to call.", + "doc": "The name of the function to call.", "type": { "$id": "863", "kind": "string", @@ -8149,7 +8149,7 @@ "kind": "property", "name": "arguments", "serializedName": "arguments", - "description": "The arguments to call the function with, as generated by the model in JSON format. Note that\nthe model does not always generate valid JSON, and may hallucinate parameters not defined by\nyour function schema. Validate the arguments in your code before calling your function.", + "doc": "The arguments to call the function with, as generated by the model in JSON format. Note that\nthe model does not always generate valid JSON, and may hallucinate parameters not defined by\nyour function schema. Validate the arguments in your code before calling your function.", "type": { "$id": "865", "kind": "string", @@ -8187,7 +8187,7 @@ "kind": "property", "name": "finish_reason", "serializedName": "finish_reason", - "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, `length` if the maximum number of tokens\nspecified in the request was reached, `content_filter` if the content was omitted due to\na flag from our content filters, or `function_call` if the model called a function.", + "doc": "The reason the model stopped generating tokens. This will be `stop` if the model hit a\nnatural stop point or a provided stop sequence, `length` if the maximum number of tokens\nspecified in the request was reached, `content_filter` if the content was omitted due to\na flag from our content filters, or `function_call` if the model called a function.", "type": { "$ref": "197" }, @@ -8249,7 +8249,7 @@ "kind": "property", "name": "file", "serializedName": "file", - "description": "The audio file object (not file name) to translate, in one of these formats: flac, mp3, mp4,\nmpeg, mpga, m4a, ogg, wav, or webm.", + "doc": "The audio file object (not file name) to translate, in one of these formats: flac, mp3, mp4,\nmpeg, mpga, m4a, ogg, wav, or webm.", "type": { "$id": "870", "kind": "bytes", @@ -8270,7 +8270,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. Only `whisper-1` is currently available.", + "doc": "ID of the model to use. Only `whisper-1` is currently available.", "type": { "$ref": "207" }, @@ -8286,7 +8286,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "An optional text to guide the model's style or continue a previous audio segment. The\n[prompt](/docs/guides/speech-to-text/prompting) should match the audio language.", + "doc": "An optional text to guide the model's style or continue a previous audio segment. The\n[prompt](/docs/guides/speech-to-text/prompting) should match the audio language.", "type": { "$id": "873", "kind": "string", @@ -8306,7 +8306,7 @@ "kind": "property", "name": "response_format", "serializedName": "response_format", - "description": "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or\nvtt.", + "doc": "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or\nvtt.", "type": { "$ref": "211" }, @@ -8322,7 +8322,7 @@ "kind": "property", "name": "temperature", "serializedName": "temperature", - "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more\nrandom, while lower values like 0.2 will make it more focused and deterministic. If set to 0,\nthe model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to\nautomatically increase the temperature until certain thresholds are hit.", + "doc": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more\nrandom, while lower values like 0.2 will make it more focused and deterministic. If set to 0,\nthe model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to\nautomatically increase the temperature until certain thresholds are hit.", "type": { "$id": "876", "kind": "float64", @@ -8381,7 +8381,7 @@ "kind": "property", "name": "file", "serializedName": "file", - "description": "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4,\nmpeg, mpga, m4a, ogg, wav, or webm.", + "doc": "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4,\nmpeg, mpga, m4a, ogg, wav, or webm.", "type": { "$id": "882", "kind": "bytes", @@ -8402,7 +8402,7 @@ "kind": "property", "name": "model", "serializedName": "model", - "description": "ID of the model to use. Only `whisper-1` is currently available.", + "doc": "ID of the model to use. Only `whisper-1` is currently available.", "type": { "$ref": "223" }, @@ -8418,7 +8418,7 @@ "kind": "property", "name": "prompt", "serializedName": "prompt", - "description": "An optional text to guide the model's style or continue a previous audio segment. The\n[prompt](/docs/guides/speech-to-text/prompting) should match the audio language.", + "doc": "An optional text to guide the model's style or continue a previous audio segment. The\n[prompt](/docs/guides/speech-to-text/prompting) should match the audio language.", "type": { "$id": "885", "kind": "string", @@ -8438,7 +8438,7 @@ "kind": "property", "name": "response_format", "serializedName": "response_format", - "description": "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or\nvtt.", + "doc": "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or\nvtt.", "type": { "$ref": "227" }, @@ -8454,7 +8454,7 @@ "kind": "property", "name": "temperature", "serializedName": "temperature", - "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more\nrandom, while lower values like 0.2 will make it more focused and deterministic. If set to 0,\nthe model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to\nautomatically increase the temperature until certain thresholds are hit.", + "doc": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more\nrandom, while lower values like 0.2 will make it more focused and deterministic. If set to 0,\nthe model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to\nautomatically increase the temperature until certain thresholds are hit.", "type": { "$id": "888", "kind": "float64", @@ -8474,7 +8474,7 @@ "kind": "property", "name": "language", "serializedName": "language", - "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy\nand latency.", + "doc": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy\nand latency.", "type": { "$id": "890", "kind": "string", @@ -8525,7 +8525,7 @@ { "$id": "894", "Name": "OpenAIClient", - "Description": "The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.", + "Doc": "The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.", "Operations": [], "Protocol": { "$id": "895" @@ -8535,7 +8535,7 @@ "$id": "896", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "897", "kind": "url", @@ -8578,7 +8578,7 @@ "$id": "902", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "903", "kind": "url", @@ -8731,7 +8731,7 @@ "$id": "917", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "918", "kind": "url", @@ -8884,7 +8884,7 @@ "$id": "932", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "933", "kind": "url", @@ -8927,7 +8927,7 @@ "$id": "938", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "939", "kind": "url", @@ -8971,7 +8971,7 @@ "$id": "944", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "945", "kind": "constant", @@ -9080,7 +9080,7 @@ "$id": "953", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "954", "kind": "url", @@ -9123,7 +9123,7 @@ "$id": "959", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "960", "kind": "url", @@ -9161,14 +9161,14 @@ "$id": "964", "Name": "create", "ResourceName": "Jobs", - "Description": "Creates a job that fine-tunes a specified model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the\nfine-tuned models once complete.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", + "Doc": "Creates a job that fine-tunes a specified model from a given dataset.\n\nResponse includes details of the enqueued job including job status and the name of the\nfine-tuned models once complete.\n\n[Learn more about fine-tuning](/docs/guides/fine-tuning)", "Accessibility": "public", "Parameters": [ { "$id": "965", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "966", "kind": "constant", @@ -9277,7 +9277,7 @@ "$id": "974", "Name": "after", "NameInRequest": "after", - "Description": "Identifier for the last job from the previous pagination request.", + "Doc": "Identifier for the last job from the previous pagination request.", "Type": { "$id": "975", "kind": "string", @@ -9299,7 +9299,7 @@ "$id": "976", "Name": "limit", "NameInRequest": "limit", - "Description": "Number of fine-tuning jobs to retrieve.", + "Doc": "Number of fine-tuning jobs to retrieve.", "Type": { "$id": "977", "kind": "safeint", @@ -9466,7 +9466,7 @@ "$id": "990", "Name": "fine_tuning_job_id", "NameInRequest": "fine_tuning_job_id", - "Description": "The ID of the fine-tuning job to get events for.", + "Doc": "The ID of the fine-tuning job to get events for.", "Type": { "$id": "991", "kind": "string", @@ -9488,7 +9488,7 @@ "$id": "992", "Name": "after", "NameInRequest": "after", - "Description": "Identifier for the last event from the previous pagination request.", + "Doc": "Identifier for the last event from the previous pagination request.", "Type": { "$id": "993", "kind": "string", @@ -9510,7 +9510,7 @@ "$id": "994", "Name": "limit", "NameInRequest": "limit", - "Description": "Number of events to retrieve.", + "Doc": "Number of events to retrieve.", "Type": { "$id": "995", "kind": "integer", @@ -9594,7 +9594,7 @@ "$id": "1001", "Name": "fine_tuning_job_id", "NameInRequest": "fine_tuning_job_id", - "Description": "The ID of the fine-tuning job to cancel.", + "Doc": "The ID of the fine-tuning job to cancel.", "Type": { "$id": "1002", "kind": "string", @@ -9677,7 +9677,7 @@ "$id": "1008", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1009", "kind": "url", @@ -9721,7 +9721,7 @@ "$id": "1014", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1015", "kind": "constant", @@ -9830,7 +9830,7 @@ "$id": "1023", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1024", "kind": "url", @@ -9875,7 +9875,7 @@ "$id": "1029", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1030", "kind": "constant", @@ -9984,7 +9984,7 @@ "$id": "1038", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1039", "kind": "url", @@ -10029,7 +10029,7 @@ "$id": "1044", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1045", "kind": "constant", @@ -10138,7 +10138,7 @@ "$id": "1053", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1054", "kind": "url", @@ -10354,7 +10354,7 @@ "$id": "1073", "Name": "file_id", "NameInRequest": "file_id", - "Description": "The ID of the file to use for this request.", + "Doc": "The ID of the file to use for this request.", "Type": { "$id": "1074", "kind": "string", @@ -10438,7 +10438,7 @@ "$id": "1080", "Name": "file_id", "NameInRequest": "file_id", - "Description": "The ID of the file to use for this request.", + "Doc": "The ID of the file to use for this request.", "Type": { "$id": "1081", "kind": "string", @@ -10522,7 +10522,7 @@ "$id": "1087", "Name": "file_id", "NameInRequest": "file_id", - "Description": "The ID of the file to use for this request.", + "Doc": "The ID of the file to use for this request.", "Type": { "$id": "1088", "kind": "string", @@ -10609,7 +10609,7 @@ "$id": "1095", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1096", "kind": "url", @@ -10655,7 +10655,7 @@ "$id": "1101", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1102", "kind": "constant", @@ -10829,7 +10829,7 @@ "$id": "1115", "Name": "fine_tune_id", "NameInRequest": "fine_tune_id", - "Description": "The ID of the fine-tune job", + "Doc": "The ID of the fine-tune job", "Type": { "$id": "1116", "kind": "string", @@ -10914,7 +10914,7 @@ "$id": "1122", "Name": "fine_tune_id", "NameInRequest": "fine_tune_id", - "Description": "The ID of the fine-tune job to get events for.", + "Doc": "The ID of the fine-tune job to get events for.", "Type": { "$id": "1123", "kind": "string", @@ -10936,7 +10936,7 @@ "$id": "1124", "Name": "stream", "NameInRequest": "stream", - "Description": "Whether to stream events for the fine-tune job. If set to true, events will be sent as\ndata-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available. The stream will terminate with a `data: [DONE]` message when the\njob is finished (succeeded, cancelled, or failed).\n\nIf set to false, only events generated so far will be returned.", + "Doc": "Whether to stream events for the fine-tune job. If set to true, events will be sent as\ndata-only\n[server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)\nas they become available. The stream will terminate with a `data: [DONE]` message when the\njob is finished (succeeded, cancelled, or failed).\n\nIf set to false, only events generated so far will be returned.", "Type": { "$id": "1125", "kind": "boolean", @@ -11021,7 +11021,7 @@ "$id": "1131", "Name": "fine_tune_id", "NameInRequest": "fine_tune_id", - "Description": "The ID of the fine-tune job to cancel", + "Doc": "The ID of the fine-tune job to cancel", "Type": { "$id": "1132", "kind": "string", @@ -11104,7 +11104,7 @@ "$id": "1138", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1139", "kind": "url", @@ -11211,7 +11211,7 @@ "$id": "1149", "Name": "model", "NameInRequest": "model", - "Description": "The ID of the model to use for this request.", + "Doc": "The ID of the model to use for this request.", "Type": { "$id": "1150", "kind": "string", @@ -11295,7 +11295,7 @@ "$id": "1156", "Name": "model", "NameInRequest": "model", - "Description": "The model to delete", + "Doc": "The model to delete", "Type": { "$id": "1157", "kind": "string", @@ -11378,7 +11378,7 @@ "$id": "1163", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1164", "kind": "url", @@ -11423,7 +11423,7 @@ "$id": "1169", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1170", "kind": "constant", @@ -11750,7 +11750,7 @@ "$id": "1196", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1197", "kind": "url", @@ -11795,7 +11795,7 @@ "$id": "1202", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "1203", "kind": "constant", @@ -11904,7 +11904,7 @@ "$id": "1211", "Name": "endpoint", "NameInRequest": "endpoint", - "Description": "Service host", + "Doc": "Service host", "Type": { "$id": "1212", "kind": "url", diff --git a/test/UnbrandedProjects/Unbranded-TypeSpec/tspCodeModel.json b/test/UnbrandedProjects/Unbranded-TypeSpec/tspCodeModel.json index 0dea15a0c33..7e0c0597b7e 100644 --- a/test/UnbrandedProjects/Unbranded-TypeSpec/tspCodeModel.json +++ b/test/UnbrandedProjects/Unbranded-TypeSpec/tspCodeModel.json @@ -20,7 +20,7 @@ "kind": "enumvalue", "name": "accept", "value": "accept", - "description": "accept", + "doc": "accept", "valueType": { "$ref": "3" }, @@ -30,7 +30,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralString", + "doc": "The Thing_requiredLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -53,7 +53,7 @@ "kind": "enumvalue", "name": "123", "value": 123, - "description": "123", + "doc": "123", "valueType": { "$ref": "6" }, @@ -63,7 +63,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralInt", + "doc": "The Thing_requiredLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -86,7 +86,7 @@ "kind": "enumvalue", "name": "1.23", "value": 1.23, - "description": "1.23", + "doc": "1.23", "valueType": { "$ref": "9" }, @@ -96,7 +96,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_requiredLiteralFloat", + "doc": "The Thing_requiredLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -119,7 +119,7 @@ "kind": "enumvalue", "name": "reject", "value": "reject", - "description": "reject", + "doc": "reject", "valueType": { "$ref": "12" }, @@ -129,7 +129,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralString", + "doc": "The Thing_optionalLiteralString", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -152,7 +152,7 @@ "kind": "enumvalue", "name": "456", "value": 456, - "description": "456", + "doc": "456", "valueType": { "$ref": "15" }, @@ -162,7 +162,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralInt", + "doc": "The Thing_optionalLiteralInt", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -185,7 +185,7 @@ "kind": "enumvalue", "name": "4.56", "value": 4.56, - "description": "4.56", + "doc": "4.56", "valueType": { "$ref": "18" }, @@ -195,7 +195,7 @@ } ], "crossLanguageDefinitionId": "", - "description": "The Thing_optionalLiteralFloat", + "doc": "The Thing_optionalLiteralFloat", "isFixed": false, "isFlags": false, "usage": "Input,Output,Spread,Json", @@ -266,7 +266,7 @@ "decorators": [] } ], - "description": "Simple enum", + "doc": "Simple enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -337,7 +337,7 @@ "decorators": [] } ], - "description": "Extensible enum", + "doc": "Extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -408,7 +408,7 @@ "decorators": [] } ], - "description": "Int based extensible enum", + "doc": "Int based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -479,7 +479,7 @@ "decorators": [] } ], - "description": "Float based extensible enum", + "doc": "Float based extensible enum", "isFixed": false, "isFlags": false, "usage": "Input,Output,Json", @@ -550,7 +550,7 @@ "decorators": [] } ], - "description": "float fixed enum", + "doc": "float fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -621,7 +621,7 @@ "decorators": [] } ], - "description": "int fixed enum", + "doc": "int fixed enum", "isFixed": true, "isFlags": false, "usage": "Input,Output,Json", @@ -773,7 +773,7 @@ "name": "Thing", "crossLanguageDefinitionId": "UnbrandedTypeSpec.Thing", "usage": "Input,Output,Spread,Json", - "description": "A model with a few properties of literal types", + "doc": "A model with a few properties of literal types", "decorators": [], "properties": [ { @@ -781,7 +781,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the Thing", + "doc": "name of the Thing", "type": { "$id": "86", "kind": "string", @@ -801,7 +801,7 @@ "kind": "property", "name": "requiredUnion", "serializedName": "requiredUnion", - "description": "required Union", + "doc": "required Union", "type": { "$id": "88", "kind": "union", @@ -850,7 +850,7 @@ "kind": "property", "name": "requiredLiteralString", "serializedName": "requiredLiteralString", - "description": "required literal string", + "doc": "required literal string", "type": { "$id": "94", "kind": "constant", @@ -872,7 +872,7 @@ "kind": "property", "name": "requiredLiteralInt", "serializedName": "requiredLiteralInt", - "description": "required literal int", + "doc": "required literal int", "type": { "$id": "96", "kind": "constant", @@ -894,7 +894,7 @@ "kind": "property", "name": "requiredLiteralFloat", "serializedName": "requiredLiteralFloat", - "description": "required literal float", + "doc": "required literal float", "type": { "$id": "98", "kind": "constant", @@ -916,7 +916,7 @@ "kind": "property", "name": "requiredLiteralBool", "serializedName": "requiredLiteralBool", - "description": "required literal bool", + "doc": "required literal bool", "type": { "$id": "100", "kind": "constant", @@ -942,7 +942,7 @@ "kind": "property", "name": "optionalLiteralString", "serializedName": "optionalLiteralString", - "description": "optional literal string", + "doc": "optional literal string", "type": { "$id": "103", "kind": "constant", @@ -964,7 +964,7 @@ "kind": "property", "name": "optionalLiteralInt", "serializedName": "optionalLiteralInt", - "description": "optional literal int", + "doc": "optional literal int", "type": { "$id": "105", "kind": "constant", @@ -986,7 +986,7 @@ "kind": "property", "name": "optionalLiteralFloat", "serializedName": "optionalLiteralFloat", - "description": "optional literal float", + "doc": "optional literal float", "type": { "$id": "107", "kind": "constant", @@ -1008,7 +1008,7 @@ "kind": "property", "name": "optionalLiteralBool", "serializedName": "optionalLiteralBool", - "description": "optional literal bool", + "doc": "optional literal bool", "type": { "$id": "109", "kind": "constant", @@ -1034,7 +1034,7 @@ "kind": "property", "name": "requiredBadDescription", "serializedName": "requiredBadDescription", - "description": "description with xml <|endoftext|>", + "doc": "description with xml <|endoftext|>", "type": { "$id": "112", "kind": "string", @@ -1054,7 +1054,7 @@ "kind": "property", "name": "optionalNullableList", "serializedName": "optionalNullableList", - "description": "optional nullable collection", + "doc": "optional nullable collection", "type": { "$id": "114", "kind": "nullable", @@ -1085,7 +1085,7 @@ "kind": "property", "name": "requiredNullableList", "serializedName": "requiredNullableList", - "description": "required nullable collection", + "doc": "required nullable collection", "type": { "$id": "118", "kind": "nullable", @@ -1119,7 +1119,7 @@ "name": "RoundTripModel", "crossLanguageDefinitionId": "UnbrandedTypeSpec.RoundTripModel", "usage": "Input,Output,Json", - "description": "this is a roundtrip model", + "doc": "this is a roundtrip model", "decorators": [], "properties": [ { @@ -1127,7 +1127,7 @@ "kind": "property", "name": "requiredString", "serializedName": "requiredString", - "description": "Required string, illustrating a reference type property.", + "doc": "Required string, illustrating a reference type property.", "type": { "$id": "123", "kind": "string", @@ -1147,7 +1147,7 @@ "kind": "property", "name": "requiredInt", "serializedName": "requiredInt", - "description": "Required int, illustrating a value type property.", + "doc": "Required int, illustrating a value type property.", "type": { "$id": "125", "kind": "int32", @@ -1167,7 +1167,7 @@ "kind": "property", "name": "requiredCollection", "serializedName": "requiredCollection", - "description": "Required collection of enums", + "doc": "Required collection of enums", "type": { "$id": "127", "kind": "array", @@ -1190,7 +1190,7 @@ "kind": "property", "name": "requiredDictionary", "serializedName": "requiredDictionary", - "description": "Required dictionary of enums", + "doc": "Required dictionary of enums", "type": { "$id": "129", "kind": "dict", @@ -1218,7 +1218,7 @@ "kind": "property", "name": "requiredModel", "serializedName": "requiredModel", - "description": "Required model", + "doc": "Required model", "type": { "$ref": "84" }, @@ -1234,7 +1234,7 @@ "kind": "property", "name": "intExtensibleEnum", "serializedName": "intExtensibleEnum", - "description": "this is an int based extensible enum", + "doc": "this is an int based extensible enum", "type": { "$ref": "36" }, @@ -1250,7 +1250,7 @@ "kind": "property", "name": "intExtensibleEnumCollection", "serializedName": "intExtensibleEnumCollection", - "description": "this is a collection of int based extensible enum", + "doc": "this is a collection of int based extensible enum", "type": { "$id": "134", "kind": "array", @@ -1273,7 +1273,7 @@ "kind": "property", "name": "floatExtensibleEnum", "serializedName": "floatExtensibleEnum", - "description": "this is a float based extensible enum", + "doc": "this is a float based extensible enum", "type": { "$ref": "44" }, @@ -1289,7 +1289,7 @@ "kind": "property", "name": "floatExtensibleEnumCollection", "serializedName": "floatExtensibleEnumCollection", - "description": "this is a collection of float based extensible enum", + "doc": "this is a collection of float based extensible enum", "type": { "$id": "137", "kind": "array", @@ -1312,7 +1312,7 @@ "kind": "property", "name": "floatFixedEnum", "serializedName": "floatFixedEnum", - "description": "this is a float based fixed enum", + "doc": "this is a float based fixed enum", "type": { "$ref": "52" }, @@ -1328,7 +1328,7 @@ "kind": "property", "name": "floatFixedEnumCollection", "serializedName": "floatFixedEnumCollection", - "description": "this is a collection of float based fixed enum", + "doc": "this is a collection of float based fixed enum", "type": { "$id": "140", "kind": "array", @@ -1351,7 +1351,7 @@ "kind": "property", "name": "intFixedEnum", "serializedName": "intFixedEnum", - "description": "this is a int based fixed enum", + "doc": "this is a int based fixed enum", "type": { "$ref": "60" }, @@ -1367,7 +1367,7 @@ "kind": "property", "name": "intFixedEnumCollection", "serializedName": "intFixedEnumCollection", - "description": "this is a collection of int based fixed enum", + "doc": "this is a collection of int based fixed enum", "type": { "$id": "143", "kind": "array", @@ -1390,7 +1390,7 @@ "kind": "property", "name": "stringFixedEnum", "serializedName": "stringFixedEnum", - "description": "this is a string based fixed enum", + "doc": "this is a string based fixed enum", "type": { "$ref": "20" }, @@ -1406,7 +1406,7 @@ "kind": "property", "name": "requiredUnknown", "serializedName": "requiredUnknown", - "description": "required unknown", + "doc": "required unknown", "type": { "$id": "146", "kind": "unknown", @@ -1426,7 +1426,7 @@ "kind": "property", "name": "optionalUnknown", "serializedName": "optionalUnknown", - "description": "optional unknown", + "doc": "optional unknown", "type": { "$id": "148", "kind": "unknown", @@ -1446,7 +1446,7 @@ "kind": "property", "name": "requiredRecordUnknown", "serializedName": "requiredRecordUnknown", - "description": "required record of unknown", + "doc": "required record of unknown", "type": { "$id": "150", "kind": "dict", @@ -1478,7 +1478,7 @@ "kind": "property", "name": "optionalRecordUnknown", "serializedName": "optionalRecordUnknown", - "description": "optional record of unknown", + "doc": "optional record of unknown", "type": { "$id": "154", "kind": "dict", @@ -1510,7 +1510,7 @@ "kind": "property", "name": "readOnlyRequiredRecordUnknown", "serializedName": "readOnlyRequiredRecordUnknown", - "description": "required readonly record of unknown", + "doc": "required readonly record of unknown", "type": { "$id": "158", "kind": "dict", @@ -1542,7 +1542,7 @@ "kind": "property", "name": "readOnlyOptionalRecordUnknown", "serializedName": "readOnlyOptionalRecordUnknown", - "description": "optional readonly record of unknown", + "doc": "optional readonly record of unknown", "type": { "$id": "162", "kind": "dict", @@ -1574,14 +1574,14 @@ "kind": "property", "name": "modelWithRequiredNullable", "serializedName": "modelWithRequiredNullable", - "description": "this is a model with required nullable properties", + "doc": "this is a model with required nullable properties", "type": { "$id": "166", "kind": "model", "name": "ModelWithRequiredNullableProperties", "crossLanguageDefinitionId": "UnbrandedTypeSpec.ModelWithRequiredNullableProperties", "usage": "Input,Output,Json", - "description": "A model with a few required nullable properties", + "doc": "A model with a few required nullable properties", "decorators": [], "properties": [ { @@ -1589,7 +1589,7 @@ "kind": "property", "name": "requiredNullablePrimitive", "serializedName": "requiredNullablePrimitive", - "description": "required nullable primitive type", + "doc": "required nullable primitive type", "type": { "$id": "168", "kind": "nullable", @@ -1613,7 +1613,7 @@ "kind": "property", "name": "requiredExtensibleEnum", "serializedName": "requiredExtensibleEnum", - "description": "required nullable extensible enum type", + "doc": "required nullable extensible enum type", "type": { "$id": "171", "kind": "nullable", @@ -1633,7 +1633,7 @@ "kind": "property", "name": "requiredFixedEnum", "serializedName": "requiredFixedEnum", - "description": "required nullable fixed enum type", + "doc": "required nullable fixed enum type", "type": { "$id": "173", "kind": "nullable", @@ -1668,7 +1668,7 @@ "name": "Friend", "crossLanguageDefinitionId": "UnbrandedTypeSpec.NotFriend", "usage": "Output,Spread,Json", - "description": "this is not a friendly model but with a friendly name", + "doc": "this is not a friendly model but with a friendly name", "decorators": [], "properties": [ { @@ -1676,7 +1676,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the NotFriend", + "doc": "name of the NotFriend", "type": { "$id": "176", "kind": "string", @@ -1699,7 +1699,7 @@ "name": "ProjectedModel", "crossLanguageDefinitionId": "UnbrandedTypeSpec.ModelWithProjectedName", "usage": "Output,Spread,Json", - "description": "this is a model with a projected name", + "doc": "this is a model with a projected name", "decorators": [], "properties": [ { @@ -1707,7 +1707,7 @@ "kind": "property", "name": "name", "serializedName": "name", - "description": "name of the ModelWithProjectedName", + "doc": "name of the ModelWithProjectedName", "type": { "$id": "179", "kind": "string", @@ -1738,13 +1738,13 @@ { "$id": "181", "Name": "UnbrandedTypeSpecClient", - "Description": "This is a sample typespec project.", + "Doc": "This is a sample typespec project.", "Operations": [ { "$id": "182", "Name": "sayHi", "ResourceName": "UnbrandedTypeSpec", - "Description": "Return hi", + "Doc": "Return hi", "Accessibility": "public", "Parameters": [ { @@ -1869,7 +1869,7 @@ "$id": "193", "Name": "helloAgain", "ResourceName": "UnbrandedTypeSpec", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -2020,7 +2020,7 @@ "$id": "206", "Name": "noContentType", "ResourceName": "UnbrandedTypeSpec", - "Description": "Return hi again", + "Doc": "Return hi again", "Accessibility": "public", "Parameters": [ { @@ -2069,7 +2069,7 @@ "$id": "211", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "212", "kind": "constant", @@ -2172,7 +2172,7 @@ "$id": "219", "Name": "helloDemo2", "ResourceName": "UnbrandedTypeSpec", - "Description": "Return hi in demo2", + "Doc": "Return hi in demo2", "Accessibility": "public", "Parameters": [ { @@ -2234,14 +2234,14 @@ "$id": "224", "Name": "createLiteral", "ResourceName": "UnbrandedTypeSpec", - "Description": "Create with literal value", + "Doc": "Create with literal value", "Accessibility": "public", "Parameters": [ { "$id": "225", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "226", "kind": "constant", @@ -2344,7 +2344,7 @@ "$id": "233", "Name": "helloLiteral", "ResourceName": "UnbrandedTypeSpec", - "Description": "Send literal parameters", + "Doc": "Send literal parameters", "Accessibility": "public", "Parameters": [ { @@ -2487,7 +2487,7 @@ "$id": "247", "Name": "topAction", "ResourceName": "UnbrandedTypeSpec", - "Description": "top level method", + "Doc": "top level method", "Accessibility": "public", "Parameters": [ { @@ -2578,7 +2578,7 @@ "$id": "255", "Name": "topAction2", "ResourceName": "UnbrandedTypeSpec", - "Description": "top level method2", + "Doc": "top level method2", "Accessibility": "public", "Parameters": [ { @@ -2640,14 +2640,14 @@ "$id": "260", "Name": "patchAction", "ResourceName": "UnbrandedTypeSpec", - "Description": "top level patch", + "Doc": "top level patch", "Accessibility": "public", "Parameters": [ { "$id": "261", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "262", "kind": "constant", @@ -2750,14 +2750,14 @@ "$id": "269", "Name": "anonymousBody", "ResourceName": "UnbrandedTypeSpec", - "Description": "body parameter without body decorator", + "Doc": "body parameter without body decorator", "Accessibility": "public", "Parameters": [ { "$id": "270", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "271", "kind": "constant", @@ -2860,14 +2860,14 @@ "$id": "278", "Name": "friendlyModel", "ResourceName": "UnbrandedTypeSpec", - "Description": "Model can have its friendly name", + "Doc": "Model can have its friendly name", "Accessibility": "public", "Parameters": [ { "$id": "279", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "280", "kind": "constant", @@ -3027,14 +3027,14 @@ "$id": "292", "Name": "projectedNameModel", "ResourceName": "UnbrandedTypeSpec", - "Description": "Model can have its projected name", + "Doc": "Model can have its projected name", "Accessibility": "public", "Parameters": [ { "$id": "293", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "294", "kind": "constant", @@ -3137,7 +3137,7 @@ "$id": "301", "Name": "returnsAnonymousModel", "ResourceName": "UnbrandedTypeSpec", - "Description": "return anonymous model", + "Doc": "return anonymous model", "Accessibility": "public", "Parameters": [ { @@ -3199,14 +3199,14 @@ "$id": "306", "Name": "createUnknownValue", "ResourceName": "UnbrandedTypeSpec", - "Description": "create extensible enum", + "Doc": "create extensible enum", "Accessibility": "public", "Parameters": [ { "$id": "307", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "308", "kind": "constant", @@ -3276,14 +3276,14 @@ "$id": "312", "Name": "internalProtocol", "ResourceName": "UnbrandedTypeSpec", - "Description": "When set protocol false and convenient true, then the protocol method should be internal", + "Doc": "When set protocol false and convenient true, then the protocol method should be internal", "Accessibility": "public", "Parameters": [ { "$id": "313", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "314", "kind": "constant", @@ -3386,7 +3386,7 @@ "$id": "321", "Name": "stillConvenient", "ResourceName": "UnbrandedTypeSpec", - "Description": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", + "Doc": "When set protocol false and convenient true, the convenient method should be generated even it has the same signature as protocol one", "Accessibility": "public", "Parameters": [], "Responses": [ @@ -3414,7 +3414,7 @@ "$id": "323", "Name": "headAsBoolean", "ResourceName": "UnbrandedTypeSpec", - "Description": "head as boolean.", + "Doc": "head as boolean.", "Accessibility": "public", "Parameters": [ { @@ -3464,14 +3464,14 @@ "$id": "327", "Name": "handleArray", "ResourceName": "UnbrandedTypeSpec", - "Description": "head as boolean.", + "Doc": "head as boolean.", "Accessibility": "public", "Parameters": [ { "$id": "328", "Name": "contentType", "NameInRequest": "Content-Type", - "Description": "Body parameter's content type. Known values are application/json", + "Doc": "Body parameter's content type. Known values are application/json", "Type": { "$id": "329", "kind": "constant", From 6f00a6c86571b4596cbf1e35fe1b61a733b4f722 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Fri, 22 Nov 2024 09:46:47 +0800 Subject: [PATCH 02/16] do not convert swagger titles --- .../Common/Input/CodeModelConverter.cs | 16 ++++++++-------- .../Common/Output/Builders/BuilderHelpers.cs | 3 --- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs index f3ad84841dc..5fb94ed671d 100644 --- a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs @@ -71,7 +71,7 @@ private IReadOnlyList CreateClients(IEnumerable ope private InputClient CreateClient(OperationGroup operationGroup, Dictionary? serviceRequestToInputOperation, Dictionary? inputOperationToOperation) => new( Name: operationGroup.Language.Default.Name, - Summary: operationGroup.Language.Default.Summary ?? string.Empty, + Summary: string.Empty, Doc: operationGroup.Language.Default.Description, Operations: CreateOperations(operationGroup.Operations, serviceRequestToInputOperation, inputOperationToOperation), Parameters: Array.Empty(), @@ -138,7 +138,7 @@ private InputOperation CreateOperation(ServiceRequest serviceRequest, Operation name: operation.Language.Default.Name, // Keep the behavior for non-mgmt scenarios resourceName: Configuration.AzureArm ? GetResoureName(operationId) : null, - summary: operation.Language.Default.Summary, + summary: string.Empty, deprecated: operation.Deprecated?.Reason, doc: operation.Language.Default.Description, accessibility: operation.Accessibility, @@ -265,7 +265,7 @@ private List CreateOperationParameters(IReadOnlyCollection new( Name: input.Language.Default.Name, NameInRequest: input.Language.Default.SerializedName ?? input.Language.Default.Name, - Summary: input.Language.Default.Summary ?? string.Empty, + Summary: string.Empty, Doc: input.Language.Default.Description, Type: GetOrCreateType(input), Location: GetRequestLocation(input), @@ -298,7 +298,7 @@ private List CreateOperationParameters(IReadOnlyCollection new( Name: header.CSharpName(), NameInResponse: header.Extensions?.HeaderCollectionPrefix ?? header.Header, - Summary: header.Language.Default.Summary ?? string.Empty, + Summary: string.Empty, Doc: header.Language.Default.Description, Type: GetOrCreateType(header.Schema, header.Extensions?.Format, true) ); @@ -420,7 +420,7 @@ private InputModelType GetOrCreateModel(ObjectSchema schema) CrossLanguageDefinitionId: GetCrossLanguageDefinitionId(schema), Access: schema.Extensions?.Accessibility ?? (usage.HasFlag(SchemaTypeUsage.Model) ? "public" : "internal"), Deprecation: schema.Deprecated?.Reason, - Summary: schema.CreateSummary(), + Summary: string.Empty, Doc: schema.CreateDescription(), Usage: (schema.Extensions != null && schema.Extensions.Formats.Contains("multipart/form-data") ? InputModelTypeUsage.MultipartFormData : InputModelTypeUsage.None) | GetUsage(usage), @@ -472,7 +472,7 @@ private InputModelProperty GetOrCreateProperty(Property property) inputProperty = new( Name: property.Language.Default.Name, SerializedName: property.SerializedName, - Summary: property.Language.Default.Summary ?? string.Empty, + Summary: string.Empty, Doc: property.Language.Default.Description, Type: GetOrCreateType(property), ConstantValue: property.Schema is ConstantSchema constantSchema ? CreateConstant(constantSchema, constantSchema.Extensions?.Format, property.IsNullable) : null, @@ -775,7 +775,7 @@ private InputEnumType CreateEnumType(Schema schema, PrimitiveSchema choiceType, CrossLanguageDefinitionId: GetCrossLanguageDefinitionId(schema), Accessibility: schema.Extensions?.Accessibility ?? (usage.HasFlag(SchemaTypeUsage.Model) ? "public" : "internal"), Deprecated: schema.Deprecated?.Reason, - Summary: schema.CreateSummary(), + Summary: string.Empty, Doc: schema.CreateDescription(), Usage: GetUsage(usage), ValueType: valueType, @@ -806,7 +806,7 @@ private static InputEnumTypeValue CreateEnumValue(ChoiceValue choiceValue, Input var value = ConvertRawValue(valueType, choiceValue.Value); return new( Name: choiceValue.Language.Default.Name, - Summary: choiceValue.Language.Default.Summary ?? string.Empty, + Summary: string.Empty, Doc: choiceValue.Language.Default.Description, Value: value!); } diff --git a/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs b/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs index 3f9a1c9ac2e..c39723be253 100644 --- a/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs +++ b/src/AutoRest.CSharp/Common/Output/Builders/BuilderHelpers.cs @@ -313,9 +313,6 @@ public static FormattableString CreateDerivedTypesDescription(CSharpType type) return $""; } - public static string CreateSummary(this Schema schema) - => schema.Language.Default.Summary is not null ? EscapeXmlDocDescription(schema.Language.Default.Summary) : string.Empty; - public static string CreateDescription(this Schema schema) => EscapeXmlDocDescription(schema.Language.Default.Description); From d681cc0ecb0429587a116498f2ac6351787158e0 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Fri, 22 Nov 2024 14:08:04 +0800 Subject: [PATCH 03/16] keep operation conversion logic --- src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs index 5fb94ed671d..83c80bef226 100644 --- a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs @@ -138,7 +138,7 @@ private InputOperation CreateOperation(ServiceRequest serviceRequest, Operation name: operation.Language.Default.Name, // Keep the behavior for non-mgmt scenarios resourceName: Configuration.AzureArm ? GetResoureName(operationId) : null, - summary: string.Empty, + summary: operation.Language.Default.Summary, deprecated: operation.Deprecated?.Reason, doc: operation.Language.Default.Description, accessibility: operation.Accessibility, From 114c7ae86d4e76282cf37c80807f387c6e1c9510 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Fri, 22 Nov 2024 14:29:09 +0800 Subject: [PATCH 04/16] fix a typo --- src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs index 83c80bef226..5ae6d7ca116 100644 --- a/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs @@ -137,7 +137,7 @@ private InputOperation CreateOperation(ServiceRequest serviceRequest, Operation var inputOperation = new InputOperation( name: operation.Language.Default.Name, // Keep the behavior for non-mgmt scenarios - resourceName: Configuration.AzureArm ? GetResoureName(operationId) : null, + resourceName: Configuration.AzureArm ? GetResourceName(operationId) : null, summary: operation.Language.Default.Summary, deprecated: operation.Deprecated?.Reason, doc: operation.Language.Default.Description, @@ -164,7 +164,7 @@ private InputOperation CreateOperation(ServiceRequest serviceRequest, Operation return inputOperation; } - private static string? GetResoureName(string? operationId) + private static string? GetResourceName(string? operationId) { if (operationId is null || operationId.IndexOf("_") == -1) { From 02af66f7a423e82146b8c8c4968f08281a48d45d Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 10:29:41 +0800 Subject: [PATCH 05/16] bump latest mgc --- package-lock.json | 6 +++--- src/TypeSpec.Extension/Emitter.Csharp/package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7a653c5ae2b..2a756e851f0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2103,8 +2103,8 @@ } }, "node_modules/@typespec/http-client-csharp": { - "version": "0.1.9-alpha.20241125.1", - "resolved": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2MTY2MS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.1.tgz", + "version": "0.1.9-alpha.20241125.14", + "resolved": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2NDAzNS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.14.tgz", "dev": true, "license": "MIT", "dependencies": { @@ -8336,7 +8336,7 @@ "license": "MIT", "dependencies": { "@autorest/csharp": "3.0.0-beta.20240625.4", - "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2MTY2MS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.1.tgz", + "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2NDAzNS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.14.tgz", "json-serialize-refs": "0.1.0-0" }, "devDependencies": { diff --git a/src/TypeSpec.Extension/Emitter.Csharp/package.json b/src/TypeSpec.Extension/Emitter.Csharp/package.json index abc0b0fe78b..1798cd47c32 100644 --- a/src/TypeSpec.Extension/Emitter.Csharp/package.json +++ b/src/TypeSpec.Extension/Emitter.Csharp/package.json @@ -36,7 +36,7 @@ "dependencies": { "@autorest/csharp": "3.0.0-beta.20240625.4", "json-serialize-refs": "0.1.0-0", - "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2MTY2MS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.1.tgz" + "@typespec/http-client-csharp": "https://artprodcus3.artifacts.visualstudio.com/A0fb41ef4-5012-48a9-bf39-4ee3de03ee35/29ec6040-b234-4e31-b139-33dc4287b756/_apis/artifact/cGlwZWxpbmVhcnRpZmFjdDovL2F6dXJlLXNkay9wcm9qZWN0SWQvMjllYzYwNDAtYjIzNC00ZTMxLWIxMzktMzNkYzQyODdiNzU2L2J1aWxkSWQvNDM2NDAzNS9hcnRpZmFjdE5hbWUvYnVpbGRfYXJ0aWZhY3RzX2NzaGFycA2/content?format=file&subPath=%2fpackages%2ftypespec-http-client-csharp-0.1.9-alpha.20241125.14.tgz" }, "peerDependencies": { "@azure-tools/typespec-azure-core": ">=0.48.0 <1.0.0", From a30bf19605fe5880ff98456e9c53ec2240dbb705 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 10:40:07 +0800 Subject: [PATCH 06/16] update `InputClient` --- .../Common/Input/InputTypes/InputClient.cs | 3 +-- .../Serialization/TypeSpecInputClientConverter.cs | 2 -- .../Common/Output/Builders/ClientBuilder.cs | 8 ++++++++ src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs | 2 +- .../LowLevel/Output/DpgOutputLibraryBuilder.cs | 2 +- 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs index a4b11cff28d..f44be7e503f 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputClient.cs @@ -6,9 +6,8 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputClient(string Name, string Summary, string Doc, IReadOnlyList Operations, IReadOnlyList Parameters, string? Parent) +internal record InputClient(string Name, string? Summary, string? Doc, IReadOnlyList Operations, IReadOnlyList Parameters, string? Parent) { - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; private readonly string? _key; public string Key diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs index 4382532604b..ddef213dcb7 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputClientConverter.cs @@ -51,8 +51,6 @@ public override void Write(Utf8JsonWriter writer, InputClient value, JsonSeriali } name= name ?? throw new JsonException("InputClient must have name"); - summary = summary ?? string.Empty; - doc = doc ?? string.Empty; operations = operations ?? Array.Empty(); parameters = parameters ?? Array.Empty(); var inputClient = new InputClient(name, summary, doc, operations, parameters, parent); diff --git a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs index 8e34de6c13a..e8100e3e4f0 100644 --- a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs +++ b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs @@ -30,6 +30,14 @@ public static string CreateDescription(string description, string clientPrefix) ? $"The {clientPrefix} service client." : BuilderHelpers.EscapeXmlDocDescription(description); + public static string CreateDescription(string? summary, string? doc, string? clientPrefix) + => (summary, doc) switch + { + (null or "", null or "") => clientPrefix is null ? string.Empty : $"The {clientPrefix} service client.", + (string s, null or "") => BuilderHelpers.EscapeXmlDocDescription(s), + _ => BuilderHelpers.EscapeXmlDocDescription(doc), + }; + private const string AzurePackageNamespacePrefix = "Azure."; private const string AzureMgmtPackageNamespacePrefix = "Azure.ResourceManager."; diff --git a/src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs b/src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs index 9b3e86eebd7..4fcbb1c5e47 100644 --- a/src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs +++ b/src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs @@ -31,7 +31,7 @@ public DataPlaneClient(InputClient inputClient, DataPlaneRestClient restClient, } protected override string DefaultName { get; } - public string Description => ClientBuilder.CreateDescription(_inputClient.Description, ClientBuilder.GetClientPrefix(Declaration.Name, DefaultName)); + public string Description => ClientBuilder.CreateDescription(_inputClient.Summary, _inputClient.Doc, ClientBuilder.GetClientPrefix(Declaration.Name, DefaultName)); public DataPlaneRestClient RestClient { get; } public ClientMethod[] Methods => _methods ??= ClientBuilder.BuildMethods(_inputClient, RestClient, Declaration).ToArray(); diff --git a/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs b/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs index 27588d74ae5..00d2be1a205 100644 --- a/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs +++ b/src/AutoRest.CSharp/LowLevel/Output/DpgOutputLibraryBuilder.cs @@ -244,7 +244,7 @@ private static ClientInfo CreateClientInfo(InputClient ns, SourceInputModel? sou { var clientNamePrefix = ClientBuilder.GetClientPrefix(ns.Name, rootNamespaceName); var clientNamespace = Configuration.Namespace; - var clientDescription = ns.Description; + var clientDescription = ClientBuilder.CreateDescription(ns.Summary, ns.Doc, null); var operations = ns.Operations; var clientParameters = RestClientBuilder.GetParametersFromClient(ns).ToList(); var resourceParameters = clientParameters.Where(cp => cp.IsResourceParameter).ToHashSet(); From 2e0769cce993eda327e51c211afa64af78cf08af Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 10:44:52 +0800 Subject: [PATCH 07/16] update `InputEnumType` --- .../Common/Input/InputTypes/InputEnumType.cs | 7 ++----- .../Common/Output/Models/Types/EnumType.cs | 10 +++++++++- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs index 9baac763e0d..ce27901cae1 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumType.cs @@ -5,8 +5,5 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputEnumType(string Name, string CrossLanguageDefinitionId, string? Accessibility, string? Deprecated, string Summary, string Doc, InputModelTypeUsage Usage, InputPrimitiveType ValueType, IReadOnlyList Values, bool IsExtensible) - : InputType(Name) - { - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; - }; +internal record InputEnumType(string Name, string CrossLanguageDefinitionId, string? Accessibility, string? Deprecated, string? Summary, string? Doc, InputModelTypeUsage Usage, InputPrimitiveType ValueType, IReadOnlyList Values, bool IsExtensible) + : InputType(Name); diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs index aa4bfcc5175..48b136fff53 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs @@ -50,7 +50,7 @@ public EnumType(InputEnumType input, string defaultNameSpace, string defaultAcce _typeMapping = sourceInputModel?.CreateForModel(ExistingType); } - Description = string.IsNullOrWhiteSpace(input.Description) ? $"The {input.Name}." : input.Description; + Description = CreateDescription(input.Summary, input.Doc) ?? $"The {input.Name}."; IsExtensible = isExtensible; ValueType = typeFactory.CreateType(input.ValueType); IsStringValueType = ValueType.Equals(typeof(string)); @@ -99,5 +99,13 @@ private static string CreateDescription(InputEnumTypeValue value) : value.Description; return BuilderHelpers.EscapeXmlDocDescription(description); } + + private static string? CreateDescription(string? summary, string? doc) + => (summary, doc) switch + { + (null or "", null or "") => null, + (string s, null or "") => s, + _ => doc, + }; } } From a06b3f2bb0844732b91181d6331cf2acedcf5060 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 10:47:45 +0800 Subject: [PATCH 08/16] update `InputEnumTypeValue` --- .../Common/Input/InputTypes/InputEnumTypeValue.cs | 1 - src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs | 4 +--- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs index 63b4f6bdfb3..a3c25726665 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs @@ -10,7 +10,6 @@ internal record InputEnumTypeValue(string Name, object Value, string? Summary, s public virtual string GetJsonValueString() => GetValueString(); public string GetValueString() => (Value.ToString() ?? string.Empty); - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; public string Name { get; internal set; } = Name; public IReadOnlyList Decorators { get; internal set; } = new List(); } diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs index 48b136fff53..519ba563c69 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs @@ -94,9 +94,7 @@ private List BuildValues() private static string CreateDescription(InputEnumTypeValue value) { - var description = string.IsNullOrWhiteSpace(value.Description) - ? value.GetValueString() - : value.Description; + var description = CreateDescription(value.Summary, value.Doc) ?? value.GetValueString(); return BuilderHelpers.EscapeXmlDocDescription(description); } From d5a8c0642cdc9cf600c72fb369c1f1f5b5cf5f87 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 11:00:22 +0800 Subject: [PATCH 09/16] update `InputModelProperty` --- .../Input/InputTypes/InputModelProperty.cs | 4 +--- .../TypeSpecInputModelPropertyConverter.cs | 2 -- .../Common/Output/Models/Types/EnumType.cs | 13 +++---------- .../Models/Types/ModelTypeProviderFields.cs | 5 +++-- .../Output/Models/Types/SchemaObjectType.cs | 3 ++- .../Output/Models/Types/SystemObjectType.cs | 2 +- .../Common/Utilities/DocHelpers.cs | 16 ++++++++++++++++ 7 files changed, 26 insertions(+), 19 deletions(-) create mode 100644 src/AutoRest.CSharp/Common/Utilities/DocHelpers.cs diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs index cac3acac547..af59e612288 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelProperty.cs @@ -6,7 +6,7 @@ namespace AutoRest.CSharp.Common.Input; -internal record InputModelProperty(string Name, string SerializedName, string Summary, string Doc, InputType Type, InputConstant? ConstantValue, bool IsRequired, bool IsReadOnly, bool IsDiscriminator) +internal record InputModelProperty(string Name, string SerializedName, string? Summary, string? Doc, InputType Type, InputConstant? ConstantValue, bool IsRequired, bool IsReadOnly, bool IsDiscriminator) { public FormattableString? DefaultValue { get; init; } @@ -18,6 +18,4 @@ internal record InputModelProperty(string Name, string SerializedName, string Su // calculated flatten prefix names public IReadOnlyList? FlattenedNames { get; internal set; } - - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; }; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs index 1740b316194..1a87199b730 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputModelPropertyConverter.cs @@ -59,8 +59,6 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read } name = name ?? throw new JsonException($"{nameof(InputModelProperty)} must have a name."); - summary = BuilderHelpers.EscapeXmlDocDescription(summary ?? string.Empty); - doc = BuilderHelpers.EscapeXmlDocDescription(doc ?? string.Empty); propertyType = propertyType ?? throw new JsonException($"{nameof(InputModelProperty)} must have a property type."); if (propertyType is InputLiteralType lt) diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs index 519ba563c69..dd269673942 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/EnumType.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; using AutoRest.CSharp.Common.Input; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Input.Source; using AutoRest.CSharp.Output.Builders; @@ -50,7 +51,7 @@ public EnumType(InputEnumType input, string defaultNameSpace, string defaultAcce _typeMapping = sourceInputModel?.CreateForModel(ExistingType); } - Description = CreateDescription(input.Summary, input.Doc) ?? $"The {input.Name}."; + Description = DocHelpers.GetDescription(input.Summary, input.Doc) ?? $"The {input.Name}."; IsExtensible = isExtensible; ValueType = typeFactory.CreateType(input.ValueType); IsStringValueType = ValueType.Equals(typeof(string)); @@ -94,16 +95,8 @@ private List BuildValues() private static string CreateDescription(InputEnumTypeValue value) { - var description = CreateDescription(value.Summary, value.Doc) ?? value.GetValueString(); + var description = DocHelpers.GetDescription(value.Summary, value.Doc) ?? value.GetValueString(); return BuilderHelpers.EscapeXmlDocDescription(description); } - - private static string? CreateDescription(string? summary, string? doc) - => (summary, doc) switch - { - (null or "", null or "") => null, - (string s, null or "") => s, - _ => doc, - }; } } diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProviderFields.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProviderFields.cs index a85d11491a9..6dfb1d34af6 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProviderFields.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProviderFields.cs @@ -9,6 +9,7 @@ using AutoRest.CSharp.Common.Input; using AutoRest.CSharp.Common.Input.InputTypes; using AutoRest.CSharp.Common.Output.Expressions.ValueExpressions; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Input.Source; @@ -70,7 +71,7 @@ public ModelTypeProviderFields(IReadOnlyList properties, str var parameterValidation = GetParameterValidation(field, inputModelProperty); var parameter = new Parameter( Name: parameterName, - Description: FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(inputModelProperty.Description)), + Description: FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(DocHelpers.GetDescription(inputModelProperty.Summary, inputModelProperty.Doc) ?? string.Empty)), Type: field.Type, DefaultValue: null, Validation: parameterValidation, @@ -270,7 +271,7 @@ private static FieldDeclaration CreateField(string fieldName, CSharpType origina CodeWriterDeclaration declaration = new CodeWriterDeclaration(fieldName); declaration.SetActualName(fieldName); return new FieldDeclaration( - FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(inputModelProperty.Description)), + FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(DocHelpers.GetDescription(inputModelProperty.Summary, inputModelProperty.Doc) ?? string.Empty)), fieldModifiers, originalType, valueType, diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs index 723a2edd2c5..4ec58fcf0de 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs @@ -13,6 +13,7 @@ using AutoRest.CSharp.Common.Output.Models; using AutoRest.CSharp.Common.Output.Models.Serialization.Multipart; using AutoRest.CSharp.Common.Output.Models.Types; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Input; using AutoRest.CSharp.Input.Source; @@ -581,7 +582,7 @@ property.Type is not InputNullableType && var objectTypeProperty = new ObjectTypeProperty( memberDeclaration, - BuilderHelpers.EscapeXmlDocDescription(property.Description), + BuilderHelpers.EscapeXmlDocDescription(DocHelpers.GetDescription(property.Summary, property.Doc) ?? string.Empty), propertyShouldOmitSetter, property, valueType, diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/SystemObjectType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/SystemObjectType.cs index f6eb69ec9bd..a31e455c3ea 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/SystemObjectType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/SystemObjectType.cs @@ -187,7 +187,7 @@ protected override IEnumerable BuildProperties() } - yield return new ObjectTypeProperty(memberDeclarationOptions, inputModelProperty.Description, inputModelProperty.IsReadOnly, inputModelProperty, new CSharpType(property.PropertyType) + yield return new ObjectTypeProperty(memberDeclarationOptions, DocHelpers.GetDescription(inputModelProperty.Summary, inputModelProperty.Doc) ?? string.Empty, inputModelProperty.IsReadOnly, inputModelProperty, new CSharpType(property.PropertyType) { SerializeAs = GetSerializeAs(property.PropertyType) }); diff --git a/src/AutoRest.CSharp/Common/Utilities/DocHelpers.cs b/src/AutoRest.CSharp/Common/Utilities/DocHelpers.cs new file mode 100644 index 00000000000..364124b45ee --- /dev/null +++ b/src/AutoRest.CSharp/Common/Utilities/DocHelpers.cs @@ -0,0 +1,16 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +namespace AutoRest.CSharp.Common.Utilities +{ + internal class DocHelpers + { + public static string? GetDescription(string? summary, string? doc) + => (summary, doc) switch + { + (null or "", null or "") => null, + (string s, null or "") => s, + _ => doc + }; + } +} From 5099791f0af4815934b5a4a01102774f124e40da Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 11:09:04 +0800 Subject: [PATCH 10/16] update `InputModelType` --- .../Common/Input/InputTypes/InputModelType.cs | 2 -- .../Common/Output/Models/Types/ModelTypeProvider.cs | 4 +++- .../Common/Output/Models/Types/SchemaObjectType.cs | 3 ++- src/AutoRest.CSharp/Mgmt/Output/MgmtObjectType.cs | 4 +++- src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs | 6 ++++-- 5 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs index 467bc74d5f1..f85242a05db 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputModelType.cs @@ -39,8 +39,6 @@ internal void SetBaseModel(InputModelType? baseModel, [CallerFilePath] string fi public IEnumerable GetAllBaseModels() => EnumerateBase(BaseModel); - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; - // The setter is only used for swagger input private bool? _useSystemTextJsonConverter; public bool UseSystemTextJsonConverter diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProvider.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProvider.cs index ff196000d05..cd7c21e4b09 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProvider.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/ModelTypeProvider.cs @@ -13,6 +13,7 @@ using AutoRest.CSharp.Common.Output.Models; using AutoRest.CSharp.Common.Output.Models.Serialization.Multipart; using AutoRest.CSharp.Common.Output.Models.Types; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Input; @@ -243,7 +244,8 @@ private MethodSignatureModifiers GetToRequestContentModifiers() protected override FormattableString CreateDescription() { - return string.IsNullOrEmpty(_inputModel.Description) ? $"The {_inputModel.Name}." : FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(_inputModel.Description)); + var description = DocHelpers.GetDescription(_inputModel.Summary, _inputModel.Doc); + return description is null or "" ? $"The {_inputModel.Name}." : FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(description)); } private ConstructorSignature EnsurePublicConstructorSignature() diff --git a/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs b/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs index 4ec58fcf0de..d4b616a8967 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Types/SchemaObjectType.cs @@ -15,6 +15,7 @@ using AutoRest.CSharp.Common.Output.Models.Types; using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; +using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Input; using AutoRest.CSharp.Input.Source; using AutoRest.CSharp.Mgmt.Output; @@ -714,7 +715,7 @@ protected bool TryGetPropertyForSchemaProperty(Func pr protected override FormattableString CreateDescription() { - return $"{InputModel.Description}"; + return FormattableStringHelpers.FromString(DocHelpers.GetDescription(InputModel.Summary, InputModel.Doc) ?? string.Empty); } protected override bool EnsureIncludeSerializer() diff --git a/src/AutoRest.CSharp/Mgmt/Output/MgmtObjectType.cs b/src/AutoRest.CSharp/Mgmt/Output/MgmtObjectType.cs index 1fdcb24fbc4..b8758d65d2b 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/MgmtObjectType.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/MgmtObjectType.cs @@ -7,7 +7,9 @@ using System.Linq; using AutoRest.CSharp.Common.Input; using AutoRest.CSharp.Common.Output.Models.Types; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; +using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Mgmt.AutoRest; using AutoRest.CSharp.Mgmt.Decorator; using AutoRest.CSharp.Mgmt.Report; @@ -298,7 +300,7 @@ public override ObjectTypeProperty GetPropertyForSchemaProperty(InputModelProper protected override FormattableString CreateDescription() { - return $"{InputModel.Description}"; + return FormattableStringHelpers.FromString(DocHelpers.GetDescription(InputModel.Summary, InputModel.Doc) ?? string.Empty); } internal string GetFullSerializedName() diff --git a/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs b/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs index ffc3117a526..51190e484f9 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/ResourceData.cs @@ -6,6 +6,7 @@ using System.Linq; using AutoRest.CSharp.Common.Input; using AutoRest.CSharp.Common.Output.Models.Types; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Mgmt.Decorator; using AutoRest.CSharp.Output.Builders; @@ -27,9 +28,10 @@ public ResourceData(InputModelType inputModel, SerializableObjectType? defaultDe protected override FormattableString CreateDescription() { FormattableString baseDescription = $"{BuilderHelpers.EscapeXmlDocDescription($"A class representing the {_clientPrefix} data model.")}"; - FormattableString extraDescription = string.IsNullOrWhiteSpace(InputModel.Description) ? + var modelDescription = DocHelpers.GetDescription(InputModel.Summary, InputModel.Doc); + FormattableString extraDescription = modelDescription is null or "" ? (FormattableString)$"" : - $"{Environment.NewLine}{BuilderHelpers.EscapeXmlDocDescription(InputModel.Description)}"; + $"{Environment.NewLine}{BuilderHelpers.EscapeXmlDocDescription(modelDescription)}"; return $"{baseDescription}{extraDescription}"; } From 87098c0677140f0cc996324e6926fc27955726f2 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 11:16:55 +0800 Subject: [PATCH 11/16] update `InputOpertion` --- .../Common/Input/InputTypes/InputOperation.cs | 8 +++++--- .../Serialization/TypeSpecInputOperationConverter.cs | 3 +-- .../Common/Output/Builders/ClientBuilder.cs | 2 +- .../Common/Output/Models/CmcRestClientBuilder.cs | 2 +- .../Common/Output/Models/LongRunningOperation.cs | 2 +- .../Common/Output/Models/RestClientBuilder.cs | 4 ++-- 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs index 0147e2f4d24..cf3cb495dd2 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputOperation.cs @@ -7,6 +7,7 @@ using AutoRest.CSharp.Common.Input.Examples; using AutoRest.CSharp.Utilities; using Azure.Core; +using Humanizer; namespace AutoRest.CSharp.Common.Input; @@ -17,7 +18,7 @@ public InputOperation( string? resourceName, string? summary, string? deprecated, - string doc, + string? doc, string? accessibility, IReadOnlyList parameters, IReadOnlyList responses, @@ -138,7 +139,7 @@ private IReadOnlyList EnsureExamples() public string? ResourceName { get; } public string? Summary { get; } public string? Deprecated { get; } - public string Doc { get; } + public string? Doc { get; } public string? Accessibility { get; } public IReadOnlyList Parameters { get; init; } public IReadOnlyList Responses { get; } @@ -164,4 +165,5 @@ private IReadOnlyList EnsureExamples() internal string SpecName { get; init; } internal bool IsNameChanged { get; init; } -} + public string DocDescription => Doc ?? $"{Name.Humanize()}."; +}; diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs index 580347c3e96..d6d95f3c320 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputOperationConverter.cs @@ -87,7 +87,6 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? if (string.IsNullOrEmpty(doc) && string.IsNullOrEmpty(summary)) { Console.Error.WriteLine($"[Warn]: InputOperation '{name}' must have either a summary or description"); - doc = $"{name.Humanize()}."; } crossLanguageDefinitionId = crossLanguageDefinitionId ?? throw new JsonException("InputOperation must have crossLanguageDefinitionId"); uri = uri ?? throw new JsonException("InputOperation must have uri"); @@ -95,7 +94,7 @@ public static InputOperation CreateOperation(ref Utf8JsonReader reader, string? parameters = parameters ?? throw new JsonException("InputOperation must have parameters"); responses = responses ?? throw new JsonException("InputOperation must have responses"); - var inputOperation = new InputOperation(name, resourceName, summary, deprecated, doc!, accessibility, parameters, responses, httpMethod, requestBodyMediaType, uri, path, externalDocsUri, requestMediaTypes, bufferResponse, longRunning, paging, generateProtocolMethod, generateConvenienceMethod, crossLanguageDefinitionId, keepClientDefaultValue, examples) + var inputOperation = new InputOperation(name, resourceName, summary, deprecated, doc, accessibility, parameters, responses, httpMethod, requestBodyMediaType, uri, path, externalDocsUri, requestMediaTypes, bufferResponse, longRunning, paging, generateProtocolMethod, generateConvenienceMethod, crossLanguageDefinitionId, keepClientDefaultValue, examples) { IsNameChanged = IsNameChanged(crossLanguageDefinitionId, name) }; diff --git a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs index e8100e3e4f0..a155c839acf 100644 --- a/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs +++ b/src/AutoRest.CSharp/Common/Output/Builders/ClientBuilder.cs @@ -111,7 +111,7 @@ public static IEnumerable BuildMethods(InputClient inputClient, Re yield return new ClientMethod( name, startMethod, - BuilderHelpers.EscapeXmlDocDescription(operation.Doc), + BuilderHelpers.EscapeXmlDocDescription(operation.DocDescription), new Diagnostic($"{declaration.Name}.{name}", Array.Empty()), operation.Accessibility ?? "public"); } diff --git a/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs b/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs index 2ef02a5926f..799124f7834 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/CmcRestClientBuilder.cs @@ -95,7 +95,7 @@ public RestClientMethod BuildMethod(InputOperation operation, IEnumerable Date: Tue, 26 Nov 2024 14:30:57 +0800 Subject: [PATCH 12/16] update `InputParameter` --- .../Common/Input/InputTypes/InputParameter.cs | 1 - .../Common/Output/Models/Shared/Parameter.cs | 14 ++++++++------ .../Mgmt/Output/Models/MgmtPropertyBag.cs | 3 ++- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs index c62a34b5ee2..e7f2c1aa5ca 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/InputParameter.cs @@ -54,5 +54,4 @@ public InputParameter() : this( public InputType Type { get; internal set; } = Type; public InputOperationParameterKind Kind { get; internal set; } = Kind; public IReadOnlyList Decorators { get; internal set; } = new List(); - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? (Doc ?? string.Empty) : Summary; } diff --git a/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs b/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs index 25e545a1ca4..59e203a7321 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs @@ -7,6 +7,7 @@ using System.Linq; using AutoRest.CSharp.Common.Input; using AutoRest.CSharp.Common.Input.InputTypes; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Output.Builders; @@ -97,9 +98,7 @@ public static Parameter FromInputParameter(in InputParameter operationParameter, public static FormattableString CreateDescription(InputParameter operationParameter, CSharpType type, IEnumerable? values, Constant? defaultValue = null) { - FormattableString description = string.IsNullOrWhiteSpace(operationParameter.Description) - ? (FormattableString)$"The {type:C} to use." - : $"{BuilderHelpers.EscapeXmlDocDescription(operationParameter.Description)}"; + FormattableString description = GetDescription(operationParameter, type); if (defaultValue != null) { var defaultValueString = defaultValue?.Value is string s ? $"\"{s}\"" : $"{defaultValue?.Value}"; @@ -160,9 +159,7 @@ public static ValidationType GetValidation(CSharpType type, RequestLocation requ private static FormattableString CreateDescription(InputParameter requestParameter, CSharpType type, Constant? defaultValue = null) { - FormattableString description = string.IsNullOrWhiteSpace(requestParameter.Description) ? - (FormattableString)$"The {type:C} to use." : - $"{BuilderHelpers.EscapeXmlDocDescription(requestParameter.Description)}"; + FormattableString description = GetDescription(requestParameter, type); if (defaultValue != null) { var defaultValueString = defaultValue?.Value is string s ? $"\"{s}\"" : $"{defaultValue?.Value}"; @@ -186,6 +183,11 @@ static FormattableString AddAllowedValues(FormattableString description, IReadOn } } + private static FormattableString GetDescription(InputParameter parameter, CSharpType type) + { + return FormattableStringHelpers.FromString(DocHelpers.GetDescription(parameter.Summary, parameter.Doc) ?? $"The {type:C} to use."); + } + private static Constant? ParseConstant(InputParameter parameter, TypeFactory typeFactory) { if (parameter.Location == RequestLocation.Header) diff --git a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs index 4bba4c83b09..4452e3366a5 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs @@ -5,6 +5,7 @@ using System.Collections.Generic; using System.Linq; using AutoRest.CSharp.Common.Input; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Writers; using AutoRest.CSharp.Mgmt.AutoRest; using AutoRest.CSharp.Output.Models.Shared; @@ -43,7 +44,7 @@ protected override TypeProvider EnsurePackModel() foreach (var parameter in _paramsToKeep) { var inputParameter = _operation.Parameters.First(p => string.Equals(p.Name, parameter.Name, StringComparison.OrdinalIgnoreCase)); - var description = !string.IsNullOrEmpty(inputParameter.Description) && parameter.Description is not null ? parameter.Description.ToString() : $"The {parameter.Name}"; + var description = DocHelpers.GetDescription(inputParameter.Summary, inputParameter.Doc) is not null && parameter.Description is not null ? parameter.Description.ToString() : $"The {parameter.Name}"; var property = new InputModelProperty(parameter.Name, parameter.Name, string.Empty, description, inputParameter!.Type, parameter.DefaultValue == null ? null : inputParameter.DefaultValue, parameter.DefaultValue == null, false, false); properties.Add(property); } From cef5f01847ed25c5e3926f339918a945f7511409 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 14:33:15 +0800 Subject: [PATCH 13/16] update `OperationResponseHeader` --- .../Common/Input/InputTypes/OperationResponseHeader.cs | 4 +--- .../DataPlane/Output/DataPlaneResponseHeaderGroupType.cs | 3 ++- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs b/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs index 97941af0454..e24efdcf02a 100644 --- a/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs +++ b/src/AutoRest.CSharp/Common/Input/InputTypes/OperationResponseHeader.cs @@ -6,9 +6,7 @@ namespace AutoRest.CSharp.Common.Input; -internal record OperationResponseHeader(string Name, string NameInResponse, string Summary, string Doc, InputType Type) +internal record OperationResponseHeader(string Name, string NameInResponse, string? Summary, string? Doc, InputType Type) { public OperationResponseHeader() : this(string.Empty, string.Empty, string.Empty, string.Empty, InputPrimitiveType.String) { } - - public string Description { get; init; } = string.IsNullOrEmpty(Summary) ? Doc : Summary; } diff --git a/src/AutoRest.CSharp/DataPlane/Output/DataPlaneResponseHeaderGroupType.cs b/src/AutoRest.CSharp/DataPlane/Output/DataPlaneResponseHeaderGroupType.cs index 239d5c2fdaa..a583750f8a2 100644 --- a/src/AutoRest.CSharp/DataPlane/Output/DataPlaneResponseHeaderGroupType.cs +++ b/src/AutoRest.CSharp/DataPlane/Output/DataPlaneResponseHeaderGroupType.cs @@ -4,6 +4,7 @@ using System; using System.Linq; using AutoRest.CSharp.Common.Input; +using AutoRest.CSharp.Common.Utilities; using AutoRest.CSharp.Generation.Types; using AutoRest.CSharp.Input; using AutoRest.CSharp.Input.Source; @@ -34,7 +35,7 @@ ResponseHeader CreateResponseHeader(OperationResponseHeader header) header.Name.ToCleanName(), header.NameInResponse, type, - BuilderHelpers.EscapeXmlDocDescription(header.Description)); + BuilderHelpers.EscapeXmlDocDescription(DocHelpers.GetDescription(header.Summary, header.Doc) ?? string.Empty)); } var operationName = operation.Name.ToCleanName(); From e50a7e0d347c2c0d0622f7f61a6dd6c495cab434 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 14:33:52 +0800 Subject: [PATCH 14/16] minor tune --- src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs index 4452e3366a5..68f75d53059 100644 --- a/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs +++ b/src/AutoRest.CSharp/Mgmt/Output/Models/MgmtPropertyBag.cs @@ -44,7 +44,7 @@ protected override TypeProvider EnsurePackModel() foreach (var parameter in _paramsToKeep) { var inputParameter = _operation.Parameters.First(p => string.Equals(p.Name, parameter.Name, StringComparison.OrdinalIgnoreCase)); - var description = DocHelpers.GetDescription(inputParameter.Summary, inputParameter.Doc) is not null && parameter.Description is not null ? parameter.Description.ToString() : $"The {parameter.Name}"; + var description = (DocHelpers.GetDescription(inputParameter.Summary, inputParameter.Doc) is not null or "") && parameter.Description is not null ? parameter.Description.ToString() : $"The {parameter.Name}"; var property = new InputModelProperty(parameter.Name, parameter.Name, string.Empty, description, inputParameter!.Type, parameter.DefaultValue == null ? null : inputParameter.DefaultValue, parameter.DefaultValue == null, false, false); properties.Add(property); } From 0325b4ee52534b7a3b5aee8c4db91c6fb0c662f6 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 15:02:57 +0800 Subject: [PATCH 15/16] fix parameter --- .../Common/Output/Models/Shared/Parameter.cs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs b/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs index 59e203a7321..76f9a651b56 100644 --- a/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs +++ b/src/AutoRest.CSharp/Common/Output/Models/Shared/Parameter.cs @@ -185,7 +185,12 @@ static FormattableString AddAllowedValues(FormattableString description, IReadOn private static FormattableString GetDescription(InputParameter parameter, CSharpType type) { - return FormattableStringHelpers.FromString(DocHelpers.GetDescription(parameter.Summary, parameter.Doc) ?? $"The {type:C} to use."); + var description = DocHelpers.GetDescription(parameter.Summary, parameter.Doc); + if (description is null) + { + return $"The {type:C} to use."; + } + return FormattableStringHelpers.FromString(BuilderHelpers.EscapeXmlDocDescription(description)); } private static Constant? ParseConstant(InputParameter parameter, TypeFactory typeFactory) From 935ac2dd524d59546de1fbd0c1f68218cb35aee7 Mon Sep 17 00:00:00 2001 From: "Mingzhe Huang (from Dev Box)" Date: Tue, 26 Nov 2024 15:25:31 +0800 Subject: [PATCH 16/16] regen --- .../encoded-name/json/src/Generated/Property.cs | 8 ++++---- .../type/array/src/Generated/BooleanValue.cs | 8 ++++---- .../type/array/src/Generated/DatetimeValue.cs | 8 ++++---- .../type/array/src/Generated/DurationValue.cs | 8 ++++---- .../type/array/src/Generated/Float32Value.cs | 8 ++++---- .../type/array/src/Generated/Int32Value.cs | 8 ++++---- .../type/array/src/Generated/Int64Value.cs | 8 ++++---- .../type/array/src/Generated/ModelValue.cs | 8 ++++---- .../array/src/Generated/NullableBooleanValue.cs | 8 ++++---- .../type/array/src/Generated/NullableFloatValue.cs | 8 ++++---- .../type/array/src/Generated/NullableInt32Value.cs | 8 ++++---- .../type/array/src/Generated/NullableModelValue.cs | 8 ++++---- .../array/src/Generated/NullableStringValue.cs | 8 ++++---- .../type/array/src/Generated/StringValue.cs | 8 ++++---- .../type/array/src/Generated/UnknownValue.cs | 8 ++++---- .../type/dictionary/src/Generated/BooleanValue.cs | 8 ++++---- .../type/dictionary/src/Generated/DatetimeValue.cs | 8 ++++---- .../type/dictionary/src/Generated/DurationValue.cs | 8 ++++---- .../type/dictionary/src/Generated/Float32Value.cs | 8 ++++---- .../type/dictionary/src/Generated/Int32Value.cs | 8 ++++---- .../type/dictionary/src/Generated/Int64Value.cs | 8 ++++---- .../type/dictionary/src/Generated/ModelValue.cs | 8 ++++---- .../dictionary/src/Generated/NullableFloatValue.cs | 8 ++++---- .../src/Generated/RecursiveModelValue.cs | 8 ++++---- .../type/dictionary/src/Generated/StringValue.cs | 8 ++++---- .../type/dictionary/src/Generated/UnknownValue.cs | 8 ++++---- .../recursive/src/Generated/RecursiveClient.cs | 8 ++++---- .../type/union/src/Generated/EnumsOnly.cs | 8 ++++---- .../type/union/src/Generated/FloatsOnly.cs | 8 ++++---- .../type/union/src/Generated/IntsOnly.cs | 8 ++++---- .../type/union/src/Generated/MixedLiterals.cs | 8 ++++---- .../type/union/src/Generated/MixedTypes.cs | 8 ++++---- .../type/union/src/Generated/ModelsOnly.cs | 8 ++++---- .../type/union/src/Generated/StringAndArray.cs | 8 ++++---- .../type/union/src/Generated/StringExtensible.cs | 8 ++++---- .../union/src/Generated/StringExtensibleNamed.cs | 8 ++++---- .../type/union/src/Generated/StringsOnly.cs | 8 ++++---- .../encoded-name/json/src/Generated/Property.cs | 8 ++++---- .../type/array/src/Generated/BooleanValue.cs | 8 ++++---- .../type/array/src/Generated/DatetimeValue.cs | 8 ++++---- .../type/array/src/Generated/DurationValue.cs | 8 ++++---- .../type/array/src/Generated/Float32Value.cs | 8 ++++---- .../type/array/src/Generated/Int32Value.cs | 8 ++++---- .../type/array/src/Generated/Int64Value.cs | 8 ++++---- .../type/array/src/Generated/ModelValue.cs | 8 ++++---- .../array/src/Generated/NullableBooleanValue.cs | 8 ++++---- .../type/array/src/Generated/NullableFloatValue.cs | 8 ++++---- .../type/array/src/Generated/NullableInt32Value.cs | 8 ++++---- .../type/array/src/Generated/NullableModelValue.cs | 8 ++++---- .../array/src/Generated/NullableStringValue.cs | 8 ++++---- .../type/array/src/Generated/StringValue.cs | 8 ++++---- .../type/array/src/Generated/UnknownValue.cs | 8 ++++---- .../type/dictionary/src/Generated/BooleanValue.cs | 8 ++++---- .../type/dictionary/src/Generated/DatetimeValue.cs | 8 ++++---- .../type/dictionary/src/Generated/DurationValue.cs | 8 ++++---- .../type/dictionary/src/Generated/Float32Value.cs | 8 ++++---- .../type/dictionary/src/Generated/Int32Value.cs | 8 ++++---- .../type/dictionary/src/Generated/Int64Value.cs | 8 ++++---- .../type/dictionary/src/Generated/ModelValue.cs | 8 ++++---- .../dictionary/src/Generated/NullableFloatValue.cs | 8 ++++---- .../src/Generated/RecursiveModelValue.cs | 8 ++++---- .../type/dictionary/src/Generated/StringValue.cs | 8 ++++---- .../type/dictionary/src/Generated/UnknownValue.cs | 8 ++++---- .../recursive/src/Generated/RecursiveClient.cs | 8 ++++---- .../type/union/src/Generated/EnumsOnly.cs | 8 ++++---- .../type/union/src/Generated/FloatsOnly.cs | 8 ++++---- .../type/union/src/Generated/IntsOnly.cs | 8 ++++---- .../type/union/src/Generated/MixedLiterals.cs | 8 ++++---- .../type/union/src/Generated/MixedTypes.cs | 8 ++++---- .../type/union/src/Generated/ModelsOnly.cs | 8 ++++---- .../type/union/src/Generated/StringAndArray.cs | 8 ++++---- .../type/union/src/Generated/StringExtensible.cs | 8 ++++---- .../union/src/Generated/StringExtensibleNamed.cs | 8 ++++---- .../type/union/src/Generated/StringsOnly.cs | 8 ++++---- .../Authoring-TypeSpec/src/Generated/Global.cs | 4 ++-- .../src/Generated/AudioTranscriptions.cs | 2 ++ .../src/Generated/AudioTranslations.cs | 2 ++ .../src/Generated/Embeddings.cs | 2 ++ .../src/Generated/Files.cs | 10 ++++++++++ .../src/Generated/FineTunes.cs | 10 ++++++++++ .../src/Generated/FineTuningJobs.cs | 14 ++++++++++---- .../src/Generated/Images.cs | 6 ++++++ .../src/Generated/ModelsOps.cs | 6 ++++++ .../src/Generated/Moderations.cs | 2 ++ 84 files changed, 348 insertions(+), 302 deletions(-) diff --git a/test/CadlRanchProjects/serialization/encoded-name/json/src/Generated/Property.cs b/test/CadlRanchProjects/serialization/encoded-name/json/src/Generated/Property.cs index 6f2c1ff469d..90cbe472eca 100644 --- a/test/CadlRanchProjects/serialization/encoded-name/json/src/Generated/Property.cs +++ b/test/CadlRanchProjects/serialization/encoded-name/json/src/Generated/Property.cs @@ -152,7 +152,7 @@ public virtual Response Send(RequestContent content, RequestContext context = nu } } - /// Get. + /// Get property. /// The cancellation token to use. /// public virtual async Task> GetPropertyAsync(CancellationToken cancellationToken = default) @@ -162,7 +162,7 @@ public virtual async Task> GetPropertyAsync(Cance return Response.FromValue(JsonEncodedNameModel.FromResponse(response), response); } - /// Get. + /// Get property. /// The cancellation token to use. /// public virtual Response GetProperty(CancellationToken cancellationToken = default) @@ -173,7 +173,7 @@ public virtual Response GetProperty(CancellationToken canc } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get property. /// /// /// @@ -208,7 +208,7 @@ public virtual async Task GetPropertyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get property. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/BooleanValue.cs b/test/CadlRanchProjects/type/array/src/Generated/BooleanValue.cs index 5dd90f2788e..6c7c7b7fce3 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/BooleanValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/BooleanValue.cs @@ -45,7 +45,7 @@ internal BooleanValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get boolean value. /// The cancellation token to use. /// public virtual async Task>> GetBooleanValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetBooleanValueAsync(Ca return Response.FromValue(value, response); } - /// Get. + /// Get boolean value. /// The cancellation token to use. /// public virtual Response> GetBooleanValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetBooleanValue(CancellationToken c } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetBooleanValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/DatetimeValue.cs b/test/CadlRanchProjects/type/array/src/Generated/DatetimeValue.cs index 26593a98848..705bf702690 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/DatetimeValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/DatetimeValue.cs @@ -45,7 +45,7 @@ internal DatetimeValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipelin _endpoint = endpoint; } - /// Get. + /// Get datetime value. /// The cancellation token to use. /// public virtual async Task>> GetDatetimeValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetDatetimeVa return Response.FromValue(value, response); } - /// Get. + /// Get datetime value. /// The cancellation token to use. /// public virtual Response> GetDatetimeValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetDatetimeValue(Cancella } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetDatetimeValueAsync(RequestContext context } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/DurationValue.cs b/test/CadlRanchProjects/type/array/src/Generated/DurationValue.cs index 0959bed942b..e6d4d34bf45 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/DurationValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/DurationValue.cs @@ -45,7 +45,7 @@ internal DurationValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipelin _endpoint = endpoint; } - /// Get. + /// Get duration value. /// The cancellation token to use. /// public virtual async Task>> GetDurationValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetDurationValueAsy return Response.FromValue(value, response); } - /// Get. + /// Get duration value. /// The cancellation token to use. /// public virtual Response> GetDurationValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetDurationValue(CancellationTo } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetDurationValueAsync(RequestContext context } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/Float32Value.cs b/test/CadlRanchProjects/type/array/src/Generated/Float32Value.cs index 680c3a34547..23435868f57 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/Float32Value.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/Float32Value.cs @@ -45,7 +45,7 @@ internal Float32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get float 32 value. /// The cancellation token to use. /// public virtual async Task>> GetFloat32ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetFloat32ValueAsync(C return Response.FromValue(value, response); } - /// Get. + /// Get float 32 value. /// The cancellation token to use. /// public virtual Response> GetFloat32Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetFloat32Value(CancellationToken } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetFloat32ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/Int32Value.cs b/test/CadlRanchProjects/type/array/src/Generated/Int32Value.cs index c31055b6be4..b0222bb828b 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/Int32Value.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/Int32Value.cs @@ -45,7 +45,7 @@ internal Int32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get int 32 value. /// The cancellation token to use. /// public virtual async Task>> GetInt32ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetInt32ValueAsync(Cance return Response.FromValue(value, response); } - /// Get. + /// Get int 32 value. /// The cancellation token to use. /// public virtual Response> GetInt32Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetInt32Value(CancellationToken canc } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetInt32ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/Int64Value.cs b/test/CadlRanchProjects/type/array/src/Generated/Int64Value.cs index 24335927026..aa8fe68bfa1 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/Int64Value.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/Int64Value.cs @@ -45,7 +45,7 @@ internal Int64Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get int 64 value. /// The cancellation token to use. /// public virtual async Task>> GetInt64ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetInt64ValueAsync(Canc return Response.FromValue(value, response); } - /// Get. + /// Get int 64 value. /// The cancellation token to use. /// public virtual Response> GetInt64Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetInt64Value(CancellationToken can } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetInt64ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/ModelValue.cs b/test/CadlRanchProjects/type/array/src/Generated/ModelValue.cs index cdaa8954484..ee54bc9d77a 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/ModelValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/ModelValue.cs @@ -46,7 +46,7 @@ internal ModelValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get model value. /// The cancellation token to use. /// public virtual async Task>> GetModelValueAsync(CancellationToken cancellationToken = default) @@ -64,7 +64,7 @@ public virtual async Task>> GetModelValueAsyn return Response.FromValue(value, response); } - /// Get. + /// Get model value. /// The cancellation token to use. /// public virtual Response> GetModelValue(CancellationToken cancellationToken = default) @@ -83,7 +83,7 @@ public virtual Response> GetModelValue(CancellationTok } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// @@ -118,7 +118,7 @@ public virtual async Task GetModelValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/NullableBooleanValue.cs b/test/CadlRanchProjects/type/array/src/Generated/NullableBooleanValue.cs index 4e4e90d3fde..7963993dff1 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/NullableBooleanValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/NullableBooleanValue.cs @@ -45,7 +45,7 @@ internal NullableBooleanValue(ClientDiagnostics clientDiagnostics, HttpPipeline _endpoint = endpoint; } - /// Get. + /// Get nullable boolean value. /// The cancellation token to use. /// public virtual async Task>> GetNullableBooleanValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ internal NullableBooleanValue(ClientDiagnostics clientDiagnostics, HttpPipeline return Response.FromValue(value, response); } - /// Get. + /// Get nullable boolean value. /// The cancellation token to use. /// public virtual Response> GetNullableBooleanValue(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ internal NullableBooleanValue(ClientDiagnostics clientDiagnostics, HttpPipeline } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable boolean value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetNullableBooleanValueAsync(RequestContext } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable boolean value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/NullableFloatValue.cs b/test/CadlRanchProjects/type/array/src/Generated/NullableFloatValue.cs index b9fb9e5b835..7e0b41bed96 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/NullableFloatValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/NullableFloatValue.cs @@ -45,7 +45,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi _endpoint = endpoint; } - /// Get. + /// Get nullable float value. /// The cancellation token to use. /// public virtual async Task>> GetNullableFloatValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi return Response.FromValue(value, response); } - /// Get. + /// Get nullable float value. /// The cancellation token to use. /// public virtual Response> GetNullableFloatValue(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetNullableFloatValueAsync(RequestContext co } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/NullableInt32Value.cs b/test/CadlRanchProjects/type/array/src/Generated/NullableInt32Value.cs index 11b1363af1e..c847c63cc15 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/NullableInt32Value.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/NullableInt32Value.cs @@ -45,7 +45,7 @@ internal NullableInt32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pi _endpoint = endpoint; } - /// Get. + /// Get nullable int 32 value. /// The cancellation token to use. /// public virtual async Task>> GetNullableInt32ValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ internal NullableInt32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pi return Response.FromValue(value, response); } - /// Get. + /// Get nullable int 32 value. /// The cancellation token to use. /// public virtual Response> GetNullableInt32Value(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ internal NullableInt32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pi } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable int 32 value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetNullableInt32ValueAsync(RequestContext co } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable int 32 value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/NullableModelValue.cs b/test/CadlRanchProjects/type/array/src/Generated/NullableModelValue.cs index 3e79b4eb6b8..ddd2cea8a99 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/NullableModelValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/NullableModelValue.cs @@ -46,7 +46,7 @@ internal NullableModelValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi _endpoint = endpoint; } - /// Get. + /// Get nullable model value. /// The cancellation token to use. /// public virtual async Task>> GetNullableModelValueAsync(CancellationToken cancellationToken = default) @@ -64,7 +64,7 @@ public virtual async Task>> GetNullableModelV return Response.FromValue(value, response); } - /// Get. + /// Get nullable model value. /// The cancellation token to use. /// public virtual Response> GetNullableModelValue(CancellationToken cancellationToken = default) @@ -83,7 +83,7 @@ public virtual Response> GetNullableModelValue(Cancell } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable model value. /// /// /// @@ -118,7 +118,7 @@ public virtual async Task GetNullableModelValueAsync(RequestContext co } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable model value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/NullableStringValue.cs b/test/CadlRanchProjects/type/array/src/Generated/NullableStringValue.cs index 0c7db5738cd..497452767b6 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/NullableStringValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/NullableStringValue.cs @@ -45,7 +45,7 @@ internal NullableStringValue(ClientDiagnostics clientDiagnostics, HttpPipeline p _endpoint = endpoint; } - /// Get. + /// Get nullable string value. /// The cancellation token to use. /// public virtual async Task>> GetNullableStringValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetNullableStringValu return Response.FromValue(value, response); } - /// Get. + /// Get nullable string value. /// The cancellation token to use. /// public virtual Response> GetNullableStringValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetNullableStringValue(Cancellati } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable string value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetNullableStringValueAsync(RequestContext c } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable string value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/StringValue.cs b/test/CadlRanchProjects/type/array/src/Generated/StringValue.cs index 41c05655208..782a9869438 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/StringValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/StringValue.cs @@ -45,7 +45,7 @@ internal StringValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get string value. /// The cancellation token to use. /// public virtual async Task>> GetStringValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetStringValueAsync(C return Response.FromValue(value, response); } - /// Get. + /// Get string value. /// The cancellation token to use. /// public virtual Response> GetStringValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetStringValue(CancellationToken } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetStringValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// diff --git a/test/CadlRanchProjects/type/array/src/Generated/UnknownValue.cs b/test/CadlRanchProjects/type/array/src/Generated/UnknownValue.cs index f5ab485c390..f511ee5450c 100644 --- a/test/CadlRanchProjects/type/array/src/Generated/UnknownValue.cs +++ b/test/CadlRanchProjects/type/array/src/Generated/UnknownValue.cs @@ -45,7 +45,7 @@ internal UnknownValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get unknown value. /// The cancellation token to use. /// public virtual async Task>> GetUnknownValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ public virtual async Task>> GetUnknownValueAs return Response.FromValue(value, response); } - /// Get. + /// Get unknown value. /// The cancellation token to use. /// public virtual Response> GetUnknownValue(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ public virtual Response> GetUnknownValue(CancellationT } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetUnknownValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/BooleanValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/BooleanValue.cs index b5c3d5e5fa0..69f1575ebc9 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/BooleanValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/BooleanValue.cs @@ -45,7 +45,7 @@ internal BooleanValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get boolean value. /// The cancellation token to use. /// public virtual async Task>> GetBooleanValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetBoolea return Response.FromValue(value, response); } - /// Get. + /// Get boolean value. /// The cancellation token to use. /// public virtual Response> GetBooleanValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetBooleanValue(Cance } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetBooleanValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/DatetimeValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/DatetimeValue.cs index 63239846896..f488000ab7b 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/DatetimeValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/DatetimeValue.cs @@ -45,7 +45,7 @@ internal DatetimeValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipelin _endpoint = endpoint; } - /// Get. + /// Get datetime value. /// The cancellation token to use. /// public virtual async Task>> GetDatetimeValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> return Response.FromValue(value, response); } - /// Get. + /// Get datetime value. /// The cancellation token to use. /// public virtual Response> GetDatetimeValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetDatetime } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetDatetimeValueAsync(RequestContext context } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/DurationValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/DurationValue.cs index f7bb9076249..c545480cb0c 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/DurationValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/DurationValue.cs @@ -45,7 +45,7 @@ internal DurationValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipelin _endpoint = endpoint; } - /// Get. + /// Get duration value. /// The cancellation token to use. /// public virtual async Task>> GetDurationValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetDu return Response.FromValue(value, response); } - /// Get. + /// Get duration value. /// The cancellation token to use. /// public virtual Response> GetDurationValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetDurationValue( } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetDurationValueAsync(RequestContext context } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/Float32Value.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/Float32Value.cs index f181472f15c..3bfefc14738 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/Float32Value.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/Float32Value.cs @@ -45,7 +45,7 @@ internal Float32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get float 32 value. /// The cancellation token to use. /// public virtual async Task>> GetFloat32ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetFloat return Response.FromValue(value, response); } - /// Get. + /// Get float 32 value. /// The cancellation token to use. /// public virtual Response> GetFloat32Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetFloat32Value(Canc } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetFloat32ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/Int32Value.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/Int32Value.cs index ce0ff8937c9..5c20e336404 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/Int32Value.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/Int32Value.cs @@ -45,7 +45,7 @@ internal Int32Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get int 32 value. /// The cancellation token to use. /// public virtual async Task>> GetInt32ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetInt32Va return Response.FromValue(value, response); } - /// Get. + /// Get int 32 value. /// The cancellation token to use. /// public virtual Response> GetInt32Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetInt32Value(Cancella } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetInt32ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/Int64Value.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/Int64Value.cs index 0b492c79621..7476c695648 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/Int64Value.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/Int64Value.cs @@ -45,7 +45,7 @@ internal Int64Value(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get int 64 value. /// The cancellation token to use. /// public virtual async Task>> GetInt64ValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetInt64V return Response.FromValue(value, response); } - /// Get. + /// Get int 64 value. /// The cancellation token to use. /// public virtual Response> GetInt64Value(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetInt64Value(Cancell } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetInt64ValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/ModelValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/ModelValue.cs index 9bc9276d906..c84332da792 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/ModelValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/ModelValue.cs @@ -46,7 +46,7 @@ internal ModelValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get model value. /// The cancellation token to use. /// public virtual async Task>> GetModelValueAsync(CancellationToken cancellationToken = default) @@ -64,7 +64,7 @@ public virtual async Task>> Get return Response.FromValue(value, response); } - /// Get. + /// Get model value. /// The cancellation token to use. /// public virtual Response> GetModelValue(CancellationToken cancellationToken = default) @@ -83,7 +83,7 @@ public virtual Response> GetModelValue(C } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// @@ -118,7 +118,7 @@ public virtual async Task GetModelValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/NullableFloatValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/NullableFloatValue.cs index 9e798a56171..fdeb7e23776 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/NullableFloatValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/NullableFloatValue.cs @@ -45,7 +45,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi _endpoint = endpoint; } - /// Get. + /// Get nullable float value. /// The cancellation token to use. /// public virtual async Task>> GetNullableFloatValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi return Response.FromValue(value, response); } - /// Get. + /// Get nullable float value. /// The cancellation token to use. /// public virtual Response> GetNullableFloatValue(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ internal NullableFloatValue(ClientDiagnostics clientDiagnostics, HttpPipeline pi } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetNullableFloatValueAsync(RequestContext co } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/RecursiveModelValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/RecursiveModelValue.cs index 9ffaf95e87d..d4d9db9db84 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/RecursiveModelValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/RecursiveModelValue.cs @@ -46,7 +46,7 @@ internal RecursiveModelValue(ClientDiagnostics clientDiagnostics, HttpPipeline p _endpoint = endpoint; } - /// Get. + /// Get recursive model value. /// The cancellation token to use. /// public virtual async Task>> GetRecursiveModelValueAsync(CancellationToken cancellationToken = default) @@ -64,7 +64,7 @@ public virtual async Task>> Get return Response.FromValue(value, response); } - /// Get. + /// Get recursive model value. /// The cancellation token to use. /// public virtual Response> GetRecursiveModelValue(CancellationToken cancellationToken = default) @@ -83,7 +83,7 @@ public virtual Response> GetRecursiveMod } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive model value. /// /// /// @@ -118,7 +118,7 @@ public virtual async Task GetRecursiveModelValueAsync(RequestContext c } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive model value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/StringValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/StringValue.cs index 0f02ee4eac6..42c8d78468e 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/StringValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/StringValue.cs @@ -45,7 +45,7 @@ internal StringValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get string value. /// The cancellation token to use. /// public virtual async Task>> GetStringValueAsync(CancellationToken cancellationToken = default) @@ -63,7 +63,7 @@ public virtual async Task>> GetStri return Response.FromValue(value, response); } - /// Get. + /// Get string value. /// The cancellation token to use. /// public virtual Response> GetStringValue(CancellationToken cancellationToken = default) @@ -82,7 +82,7 @@ public virtual Response> GetStringValue(Canc } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// @@ -117,7 +117,7 @@ public virtual async Task GetStringValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// diff --git a/test/CadlRanchProjects/type/dictionary/src/Generated/UnknownValue.cs b/test/CadlRanchProjects/type/dictionary/src/Generated/UnknownValue.cs index 592ec1939dc..8b7906c7e9b 100644 --- a/test/CadlRanchProjects/type/dictionary/src/Generated/UnknownValue.cs +++ b/test/CadlRanchProjects/type/dictionary/src/Generated/UnknownValue.cs @@ -45,7 +45,7 @@ internal UnknownValue(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline _endpoint = endpoint; } - /// Get. + /// Get unknown value. /// The cancellation token to use. /// public virtual async Task>> GetUnknownValueAsync(CancellationToken cancellationToken = default) @@ -70,7 +70,7 @@ public virtual async Task>> Get return Response.FromValue(value, response); } - /// Get. + /// Get unknown value. /// The cancellation token to use. /// public virtual Response> GetUnknownValue(CancellationToken cancellationToken = default) @@ -96,7 +96,7 @@ public virtual Response> GetUnknownValue } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// @@ -131,7 +131,7 @@ public virtual async Task GetUnknownValueAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// diff --git a/test/CadlRanchProjects/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs b/test/CadlRanchProjects/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs index beb1480f915..a4b97ef43c1 100644 --- a/test/CadlRanchProjects/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs +++ b/test/CadlRanchProjects/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs @@ -155,7 +155,7 @@ public virtual Response Put(RequestContent content, RequestContext context = nul } } - /// Get. + /// Get recursive. /// The cancellation token to use. /// public virtual async Task> GetRecursiveAsync(CancellationToken cancellationToken = default) @@ -165,7 +165,7 @@ public virtual async Task> GetRecursiveAsync(CancellationTok return Response.FromValue(Extension.FromResponse(response), response); } - /// Get. + /// Get recursive. /// The cancellation token to use. /// public virtual Response GetRecursive(CancellationToken cancellationToken = default) @@ -176,7 +176,7 @@ public virtual Response GetRecursive(CancellationToken cancellationTo } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive. /// /// /// @@ -211,7 +211,7 @@ public virtual async Task GetRecursiveAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/EnumsOnly.cs b/test/CadlRanchProjects/type/union/src/Generated/EnumsOnly.cs index 2ef2f8d6e9f..37f97f39d00 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/EnumsOnly.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/EnumsOnly.cs @@ -45,7 +45,7 @@ internal EnumsOnly(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, U _endpoint = endpoint; } - /// Get. + /// Get enums only. /// The cancellation token to use. /// public virtual async Task> GetEnumsOnlyAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetEnumsOnlyAsync(Cancellation return Response.FromValue(GetResponse3.FromResponse(response), response); } - /// Get. + /// Get enums only. /// The cancellation token to use. /// public virtual Response GetEnumsOnly(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetEnumsOnly(CancellationToken cancellatio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get enums only. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetEnumsOnlyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get enums only. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/FloatsOnly.cs b/test/CadlRanchProjects/type/union/src/Generated/FloatsOnly.cs index 8a116e9f840..43a6ebf8fc4 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/FloatsOnly.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/FloatsOnly.cs @@ -45,7 +45,7 @@ internal FloatsOnly(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get floats only. /// The cancellation token to use. /// public virtual async Task> GetFloatsOnlyAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetFloatsOnlyAsync(Cancellatio return Response.FromValue(GetResponse5.FromResponse(response), response); } - /// Get. + /// Get floats only. /// The cancellation token to use. /// public virtual Response GetFloatsOnly(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetFloatsOnly(CancellationToken cancellati } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get floats only. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetFloatsOnlyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get floats only. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/IntsOnly.cs b/test/CadlRanchProjects/type/union/src/Generated/IntsOnly.cs index 2de8c7731ba..dee7854953e 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/IntsOnly.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/IntsOnly.cs @@ -45,7 +45,7 @@ internal IntsOnly(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, Ur _endpoint = endpoint; } - /// Get. + /// Get ints only. /// The cancellation token to use. /// public virtual async Task> GetIntsOnlyAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetIntsOnlyAsync(CancellationT return Response.FromValue(GetResponse6.FromResponse(response), response); } - /// Get. + /// Get ints only. /// The cancellation token to use. /// public virtual Response GetIntsOnly(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetIntsOnly(CancellationToken cancellation } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get ints only. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetIntsOnlyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get ints only. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/MixedLiterals.cs b/test/CadlRanchProjects/type/union/src/Generated/MixedLiterals.cs index a1ed8414471..d908281d48b 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/MixedLiterals.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/MixedLiterals.cs @@ -45,7 +45,7 @@ internal MixedLiterals(ClientDiagnostics clientDiagnostics, HttpPipeline pipelin _endpoint = endpoint; } - /// Get. + /// Get mixed literal. /// The cancellation token to use. /// public virtual async Task> GetMixedLiteralAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetMixedLiteralAsync(Cancellat return Response.FromValue(GetResponse1.FromResponse(response), response); } - /// Get. + /// Get mixed literal. /// The cancellation token to use. /// public virtual Response GetMixedLiteral(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetMixedLiteral(CancellationToken cancella } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed literal. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetMixedLiteralAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed literal. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/MixedTypes.cs b/test/CadlRanchProjects/type/union/src/Generated/MixedTypes.cs index 3c040ba1c91..da273a8ca63 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/MixedTypes.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/MixedTypes.cs @@ -45,7 +45,7 @@ internal MixedTypes(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get mixed type. /// The cancellation token to use. /// public virtual async Task> GetMixedTypeAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetMixedTypeAsync(CancellationT return Response.FromValue(GetResponse.FromResponse(response), response); } - /// Get. + /// Get mixed type. /// The cancellation token to use. /// public virtual Response GetMixedType(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetMixedType(CancellationToken cancellation } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed type. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetMixedTypeAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed type. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/ModelsOnly.cs b/test/CadlRanchProjects/type/union/src/Generated/ModelsOnly.cs index 429f78e20ca..abe1b02788e 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/ModelsOnly.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/ModelsOnly.cs @@ -45,7 +45,7 @@ internal ModelsOnly(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get models only. /// The cancellation token to use. /// public virtual async Task> GetModelsOnlyAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetModelsOnlyAsync(Cancellatio return Response.FromValue(GetResponse4.FromResponse(response), response); } - /// Get. + /// Get models only. /// The cancellation token to use. /// public virtual Response GetModelsOnly(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetModelsOnly(CancellationToken cancellati } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get models only. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetModelsOnlyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get models only. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/StringAndArray.cs b/test/CadlRanchProjects/type/union/src/Generated/StringAndArray.cs index d9d67eb8215..7159e4711ac 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/StringAndArray.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/StringAndArray.cs @@ -45,7 +45,7 @@ internal StringAndArray(ClientDiagnostics clientDiagnostics, HttpPipeline pipeli _endpoint = endpoint; } - /// Get. + /// Get string and array. /// The cancellation token to use. /// public virtual async Task> GetStringAndArrayAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetStringAndArrayAsync(Cancell return Response.FromValue(GetResponse2.FromResponse(response), response); } - /// Get. + /// Get string and array. /// The cancellation token to use. /// public virtual Response GetStringAndArray(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetStringAndArray(CancellationToken cancel } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string and array. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetStringAndArrayAsync(RequestContext contex } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string and array. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/StringExtensible.cs b/test/CadlRanchProjects/type/union/src/Generated/StringExtensible.cs index a5fd64cd412..5df30406844 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/StringExtensible.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/StringExtensible.cs @@ -45,7 +45,7 @@ internal StringExtensible(ClientDiagnostics clientDiagnostics, HttpPipeline pipe _endpoint = endpoint; } - /// Get. + /// Get string extensible. /// The cancellation token to use. /// public virtual async Task> GetStringExtensibleAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetStringExtensibleAsync(Cance return Response.FromValue(GetResponse8.FromResponse(response), response); } - /// Get. + /// Get string extensible. /// The cancellation token to use. /// public virtual Response GetStringExtensible(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetStringExtensible(CancellationToken canc } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetStringExtensibleAsync(RequestContext cont } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/StringExtensibleNamed.cs b/test/CadlRanchProjects/type/union/src/Generated/StringExtensibleNamed.cs index 91dff76b56c..f6492f94855 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/StringExtensibleNamed.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/StringExtensibleNamed.cs @@ -45,7 +45,7 @@ internal StringExtensibleNamed(ClientDiagnostics clientDiagnostics, HttpPipeline _endpoint = endpoint; } - /// Get. + /// Get string extensible named. /// The cancellation token to use. /// public virtual async Task> GetStringExtensibleNamedAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetStringExtensibleNamedAsync( return Response.FromValue(GetResponse7.FromResponse(response), response); } - /// Get. + /// Get string extensible named. /// The cancellation token to use. /// public virtual Response GetStringExtensibleNamed(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetStringExtensibleNamed(CancellationToken } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible named. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetStringExtensibleNamedAsync(RequestContext } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible named. /// /// /// diff --git a/test/CadlRanchProjects/type/union/src/Generated/StringsOnly.cs b/test/CadlRanchProjects/type/union/src/Generated/StringsOnly.cs index b03bf34ba7d..1db20a6aa80 100644 --- a/test/CadlRanchProjects/type/union/src/Generated/StringsOnly.cs +++ b/test/CadlRanchProjects/type/union/src/Generated/StringsOnly.cs @@ -45,7 +45,7 @@ internal StringsOnly(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _endpoint = endpoint; } - /// Get. + /// Get strings only. /// The cancellation token to use. /// public virtual async Task> GetStringsOnlyAsync(CancellationToken cancellationToken = default) @@ -55,7 +55,7 @@ public virtual async Task> GetStringsOnlyAsync(Cancellati return Response.FromValue(GetResponse9.FromResponse(response), response); } - /// Get. + /// Get strings only. /// The cancellation token to use. /// public virtual Response GetStringsOnly(CancellationToken cancellationToken = default) @@ -66,7 +66,7 @@ public virtual Response GetStringsOnly(CancellationToken cancellat } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get strings only. /// /// /// @@ -101,7 +101,7 @@ public virtual async Task GetStringsOnlyAsync(RequestContext context) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get strings only. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/src/Generated/Property.cs b/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/src/Generated/Property.cs index 86412b2a312..5458387d6be 100644 --- a/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/src/Generated/Property.cs +++ b/test/CadlRanchProjectsNonAzure/serialization/encoded-name/json/src/Generated/Property.cs @@ -114,14 +114,14 @@ public virtual ClientResult Send(BinaryContent content, RequestOptions options = return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options)); } - /// Get. + /// Get property. public virtual async Task> GetPropertyAsync() { ClientResult result = await GetPropertyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(JsonEncodedNameModel.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get property. public virtual ClientResult GetProperty() { ClientResult result = GetProperty(null); @@ -129,7 +129,7 @@ public virtual ClientResult GetProperty() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get property. /// /// /// @@ -153,7 +153,7 @@ public virtual async Task GetPropertyAsync(RequestOptions options) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get property. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/BooleanValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/BooleanValue.cs index 580d723b31d..d3361315a2f 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/BooleanValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/BooleanValue.cs @@ -35,7 +35,7 @@ internal BooleanValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get boolean value. public virtual async Task>> GetBooleanValueAsync() { ClientResult result = await GetBooleanValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetBooleanValueAsyn return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get boolean value. public virtual ClientResult> GetBooleanValue() { ClientResult result = GetBooleanValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetBooleanValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetBooleanValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DatetimeValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DatetimeValue.cs index b5b9cbdfe06..e11d6a572c5 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DatetimeValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DatetimeValue.cs @@ -35,7 +35,7 @@ internal DatetimeValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get datetime value. public virtual async Task>> GetDatetimeValueAsync() { ClientResult result = await GetDatetimeValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetDateti return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get datetime value. public virtual ClientResult> GetDatetimeValue() { ClientResult result = GetDatetimeValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetDatetimeValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetDatetimeValueAsync(RequestOptions opt } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DurationValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DurationValue.cs index 39f7fe7e59a..88b6b0f3b45 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DurationValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/DurationValue.cs @@ -35,7 +35,7 @@ internal DurationValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get duration value. public virtual async Task>> GetDurationValueAsync() { ClientResult result = await GetDurationValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetDurationValu return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get duration value. public virtual ClientResult> GetDurationValue() { ClientResult result = GetDurationValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetDurationValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetDurationValueAsync(RequestOptions opt } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Float32Value.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Float32Value.cs index a0f5377f81c..c7105420beb 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Float32Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Float32Value.cs @@ -35,7 +35,7 @@ internal Float32Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get float 32 value. public virtual async Task>> GetFloat32ValueAsync() { ClientResult result = await GetFloat32ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetFloat32ValueAsy return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get float 32 value. public virtual ClientResult> GetFloat32Value() { ClientResult result = GetFloat32Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetFloat32Value() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetFloat32ValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int32Value.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int32Value.cs index bdb6a1fc9c0..cd1de2ace1c 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int32Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int32Value.cs @@ -35,7 +35,7 @@ internal Int32Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get int 32 value. public virtual async Task>> GetInt32ValueAsync() { ClientResult result = await GetInt32ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetInt32ValueAsync() return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get int 32 value. public virtual ClientResult> GetInt32Value() { ClientResult result = GetInt32Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetInt32Value() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetInt32ValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int64Value.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int64Value.cs index f757cb2db92..c94c757ee11 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int64Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/Int64Value.cs @@ -35,7 +35,7 @@ internal Int64Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get int 64 value. public virtual async Task>> GetInt64ValueAsync() { ClientResult result = await GetInt64ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetInt64ValueAsync( return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get int 64 value. public virtual ClientResult> GetInt64Value() { ClientResult result = GetInt64Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetInt64Value() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetInt64ValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/ModelValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/ModelValue.cs index 9f42845f36c..ada496d5cb1 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/ModelValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/ModelValue.cs @@ -36,7 +36,7 @@ internal ModelValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get model value. public virtual async Task>> GetModelValueAsync() { ClientResult result = await GetModelValueAsync(null).ConfigureAwait(false); @@ -51,7 +51,7 @@ public virtual async Task>> GetModelValue return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get model value. public virtual ClientResult> GetModelValue() { ClientResult result = GetModelValue(null); @@ -67,7 +67,7 @@ public virtual ClientResult> GetModelValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// @@ -91,7 +91,7 @@ public virtual async Task GetModelValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableBooleanValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableBooleanValue.cs index 434c67b5ccf..129aa2f5f7c 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableBooleanValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableBooleanValue.cs @@ -35,7 +35,7 @@ internal NullableBooleanValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable boolean value. public virtual async Task>> GetNullableBooleanValueAsync() { ClientResult result = await GetNullableBooleanValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ internal NullableBooleanValue(ClientPipeline pipeline, Uri endpoint) return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable boolean value. public virtual ClientResult> GetNullableBooleanValue() { ClientResult result = GetNullableBooleanValue(null); @@ -80,7 +80,7 @@ internal NullableBooleanValue(ClientPipeline pipeline, Uri endpoint) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable boolean value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetNullableBooleanValueAsync(RequestOpti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable boolean value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableFloatValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableFloatValue.cs index 7dc58818908..441b69e1c59 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableFloatValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableFloatValue.cs @@ -35,7 +35,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable float value. public virtual async Task>> GetNullableFloatValueAsync() { ClientResult result = await GetNullableFloatValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable float value. public virtual ClientResult> GetNullableFloatValue() { ClientResult result = GetNullableFloatValue(null); @@ -80,7 +80,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetNullableFloatValueAsync(RequestOption } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableInt32Value.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableInt32Value.cs index 402c7361d75..9c676dc5166 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableInt32Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableInt32Value.cs @@ -35,7 +35,7 @@ internal NullableInt32Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable int 32 value. public virtual async Task>> GetNullableInt32ValueAsync() { ClientResult result = await GetNullableInt32ValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ internal NullableInt32Value(ClientPipeline pipeline, Uri endpoint) return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable int 32 value. public virtual ClientResult> GetNullableInt32Value() { ClientResult result = GetNullableInt32Value(null); @@ -80,7 +80,7 @@ internal NullableInt32Value(ClientPipeline pipeline, Uri endpoint) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable int 32 value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetNullableInt32ValueAsync(RequestOption } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable int 32 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableModelValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableModelValue.cs index f9f3b3c509e..1e0a5d78604 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableModelValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableModelValue.cs @@ -36,7 +36,7 @@ internal NullableModelValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable model value. public virtual async Task>> GetNullableModelValueAsync() { ClientResult result = await GetNullableModelValueAsync(null).ConfigureAwait(false); @@ -51,7 +51,7 @@ public virtual async Task>> GetNullableMo return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable model value. public virtual ClientResult> GetNullableModelValue() { ClientResult result = GetNullableModelValue(null); @@ -67,7 +67,7 @@ public virtual ClientResult> GetNullableModelValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable model value. /// /// /// @@ -91,7 +91,7 @@ public virtual async Task GetNullableModelValueAsync(RequestOption } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable model value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableStringValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableStringValue.cs index 1b8e51df058..623ff4f7ddd 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableStringValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/NullableStringValue.cs @@ -35,7 +35,7 @@ internal NullableStringValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable string value. public virtual async Task>> GetNullableStringValueAsync() { ClientResult result = await GetNullableStringValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetNullableString return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable string value. public virtual ClientResult> GetNullableStringValue() { ClientResult result = GetNullableStringValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetNullableStringValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable string value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetNullableStringValueAsync(RequestOptio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable string value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/StringValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/StringValue.cs index 75b574abc9e..83bd9dca3ac 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/StringValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/StringValue.cs @@ -35,7 +35,7 @@ internal StringValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get string value. public virtual async Task>> GetStringValueAsync() { ClientResult result = await GetStringValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetStringValueAsy return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get string value. public virtual ClientResult> GetStringValue() { ClientResult result = GetStringValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetStringValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetStringValueAsync(RequestOptions optio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/UnknownValue.cs b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/UnknownValue.cs index b06348d8d5a..54082cd74f9 100644 --- a/test/CadlRanchProjectsNonAzure/type/array/src/Generated/UnknownValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/array/src/Generated/UnknownValue.cs @@ -35,7 +35,7 @@ internal UnknownValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get unknown value. public virtual async Task>> GetUnknownValueAsync() { ClientResult result = await GetUnknownValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ public virtual async Task>> GetUnknownVal return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get unknown value. public virtual ClientResult> GetUnknownValue() { ClientResult result = GetUnknownValue(null); @@ -80,7 +80,7 @@ public virtual ClientResult> GetUnknownValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetUnknownValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/BooleanValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/BooleanValue.cs index 3e08f7050da..6a9a6eadcc6 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/BooleanValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/BooleanValue.cs @@ -35,7 +35,7 @@ internal BooleanValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get boolean value. public virtual async Task>> GetBooleanValueAsync() { ClientResult result = await GetBooleanValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetBo return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get boolean value. public virtual ClientResult> GetBooleanValue() { ClientResult result = GetBooleanValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetBooleanValue() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetBooleanValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get boolean value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DatetimeValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DatetimeValue.cs index fde4b735e7a..f106ce2acf5 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DatetimeValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DatetimeValue.cs @@ -35,7 +35,7 @@ internal DatetimeValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get datetime value. public virtual async Task>> GetDatetimeValueAsync() { ClientResult result = await GetDatetimeValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task Get. + /// Get datetime value. public virtual ClientResult> GetDatetimeValue() { ClientResult result = GetDatetimeValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetDate } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetDatetimeValueAsync(RequestOptions opt } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get datetime value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DurationValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DurationValue.cs index aef8ef5bc00..8582dd28f14 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DurationValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/DurationValue.cs @@ -35,7 +35,7 @@ internal DurationValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get duration value. public virtual async Task>> GetDurationValueAsync() { ClientResult result = await GetDurationValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> G return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get duration value. public virtual ClientResult> GetDurationValue() { ClientResult result = GetDurationValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetDurationVa } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetDurationValueAsync(RequestOptions opt } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get duration value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Float32Value.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Float32Value.cs index cd959dc5d4a..cda80ee1a2e 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Float32Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Float32Value.cs @@ -35,7 +35,7 @@ internal Float32Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get float 32 value. public virtual async Task>> GetFloat32ValueAsync() { ClientResult result = await GetFloat32ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetF return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get float 32 value. public virtual ClientResult> GetFloat32Value() { ClientResult result = GetFloat32Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetFloat32Value( } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetFloat32ValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get float 32 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int32Value.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int32Value.cs index d94465d20dc..f4b22b64258 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int32Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int32Value.cs @@ -35,7 +35,7 @@ internal Int32Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get int 32 value. public virtual async Task>> GetInt32ValueAsync() { ClientResult result = await GetInt32ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetInt return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get int 32 value. public virtual ClientResult> GetInt32Value() { ClientResult result = GetInt32Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetInt32Value() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetInt32ValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 32 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int64Value.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int64Value.cs index 42786e35f2a..27e9f1d65aa 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int64Value.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/Int64Value.cs @@ -35,7 +35,7 @@ internal Int64Value(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get int 64 value. public virtual async Task>> GetInt64ValueAsync() { ClientResult result = await GetInt64ValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> GetIn return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get int 64 value. public virtual ClientResult> GetInt64Value() { ClientResult result = GetInt64Value(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetInt64Value() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetInt64ValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get int 64 value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/ModelValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/ModelValue.cs index edcef5977fe..b5e4622d689 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/ModelValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/ModelValue.cs @@ -36,7 +36,7 @@ internal ModelValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get model value. public virtual async Task>> GetModelValueAsync() { ClientResult result = await GetModelValueAsync(null).ConfigureAwait(false); @@ -51,7 +51,7 @@ public virtual async Task>> return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get model value. public virtual ClientResult> GetModelValue() { ClientResult result = GetModelValue(null); @@ -67,7 +67,7 @@ public virtual ClientResult> GetModelVal } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// @@ -91,7 +91,7 @@ public virtual async Task GetModelValueAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get model value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/NullableFloatValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/NullableFloatValue.cs index 6cd6ab872bd..2fe2ed72ac6 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/NullableFloatValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/NullableFloatValue.cs @@ -35,7 +35,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get nullable float value. public virtual async Task>> GetNullableFloatValueAsync() { ClientResult result = await GetNullableFloatValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get nullable float value. public virtual ClientResult> GetNullableFloatValue() { ClientResult result = GetNullableFloatValue(null); @@ -80,7 +80,7 @@ internal NullableFloatValue(ClientPipeline pipeline, Uri endpoint) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetNullableFloatValueAsync(RequestOption } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get nullable float value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/RecursiveModelValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/RecursiveModelValue.cs index eb0b56fa08f..3a71f25ed0d 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/RecursiveModelValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/RecursiveModelValue.cs @@ -36,7 +36,7 @@ internal RecursiveModelValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get recursive model value. public virtual async Task>> GetRecursiveModelValueAsync() { ClientResult result = await GetRecursiveModelValueAsync(null).ConfigureAwait(false); @@ -51,7 +51,7 @@ public virtual async Task>> return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get recursive model value. public virtual ClientResult> GetRecursiveModelValue() { ClientResult result = GetRecursiveModelValue(null); @@ -67,7 +67,7 @@ public virtual ClientResult> GetRecursiv } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive model value. /// /// /// @@ -91,7 +91,7 @@ public virtual async Task GetRecursiveModelValueAsync(RequestOptio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive model value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/StringValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/StringValue.cs index 76f9ca4f3a4..1ef7f14c3d8 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/StringValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/StringValue.cs @@ -35,7 +35,7 @@ internal StringValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get string value. public virtual async Task>> GetStringValueAsync() { ClientResult result = await GetStringValueAsync(null).ConfigureAwait(false); @@ -50,7 +50,7 @@ public virtual async Task>> Get return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get string value. public virtual ClientResult> GetStringValue() { ClientResult result = GetStringValue(null); @@ -66,7 +66,7 @@ public virtual ClientResult> GetStringValue( } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// @@ -90,7 +90,7 @@ public virtual async Task GetStringValueAsync(RequestOptions optio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/UnknownValue.cs b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/UnknownValue.cs index 8c853cc4b38..9180ae04cfb 100644 --- a/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/UnknownValue.cs +++ b/test/CadlRanchProjectsNonAzure/type/dictionary/src/Generated/UnknownValue.cs @@ -35,7 +35,7 @@ internal UnknownValue(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get unknown value. public virtual async Task>> GetUnknownValueAsync() { ClientResult result = await GetUnknownValueAsync(null).ConfigureAwait(false); @@ -57,7 +57,7 @@ public virtual async Task>> return ClientResult.FromValue(value, result.GetRawResponse()); } - /// Get. + /// Get unknown value. public virtual ClientResult> GetUnknownValue() { ClientResult result = GetUnknownValue(null); @@ -80,7 +80,7 @@ public virtual ClientResult> GetUnknownV } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// @@ -104,7 +104,7 @@ public virtual async Task GetUnknownValueAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get unknown value. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs b/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs index fc54f4f4256..a0b9cf142f8 100644 --- a/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs +++ b/test/CadlRanchProjectsNonAzure/type/model/inheritance/recursive/src/Generated/RecursiveClient.cs @@ -118,14 +118,14 @@ public virtual ClientResult Put(BinaryContent content, RequestOptions options = return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options)); } - /// Get. + /// Get recursive. public virtual async Task> GetRecursiveAsync() { ClientResult result = await GetRecursiveAsync(null).ConfigureAwait(false); return ClientResult.FromValue(Extension.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get recursive. public virtual ClientResult GetRecursive() { ClientResult result = GetRecursive(null); @@ -133,7 +133,7 @@ public virtual ClientResult GetRecursive() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive. /// /// /// @@ -157,7 +157,7 @@ public virtual async Task GetRecursiveAsync(RequestOptions options } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get recursive. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/EnumsOnly.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/EnumsOnly.cs index 26c32178fde..13c1ea63129 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/EnumsOnly.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/EnumsOnly.cs @@ -35,14 +35,14 @@ internal EnumsOnly(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get enums only. public virtual async Task> GetEnumsOnlyAsync() { ClientResult result = await GetEnumsOnlyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse3.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get enums only. public virtual ClientResult GetEnumsOnly() { ClientResult result = GetEnumsOnly(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetEnumsOnly() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get enums only. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetEnumsOnlyAsync(RequestOptions options } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get enums only. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/FloatsOnly.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/FloatsOnly.cs index f6d01edd41f..781d5e4fe80 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/FloatsOnly.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/FloatsOnly.cs @@ -35,14 +35,14 @@ internal FloatsOnly(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get floats only. public virtual async Task> GetFloatsOnlyAsync() { ClientResult result = await GetFloatsOnlyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse5.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get floats only. public virtual ClientResult GetFloatsOnly() { ClientResult result = GetFloatsOnly(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetFloatsOnly() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get floats only. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetFloatsOnlyAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get floats only. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/IntsOnly.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/IntsOnly.cs index 627ecb7393f..09ed93c60dc 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/IntsOnly.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/IntsOnly.cs @@ -35,14 +35,14 @@ internal IntsOnly(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get ints only. public virtual async Task> GetIntsOnlyAsync() { ClientResult result = await GetIntsOnlyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse6.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get ints only. public virtual ClientResult GetIntsOnly() { ClientResult result = GetIntsOnly(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetIntsOnly() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get ints only. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetIntsOnlyAsync(RequestOptions options) } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get ints only. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedLiterals.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedLiterals.cs index e04c4deddcf..921c00b3d51 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedLiterals.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedLiterals.cs @@ -35,14 +35,14 @@ internal MixedLiterals(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get mixed literal. public virtual async Task> GetMixedLiteralAsync() { ClientResult result = await GetMixedLiteralAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse1.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get mixed literal. public virtual ClientResult GetMixedLiteral() { ClientResult result = GetMixedLiteral(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetMixedLiteral() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed literal. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetMixedLiteralAsync(RequestOptions opti } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed literal. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedTypes.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedTypes.cs index 9dba4bf1510..1d151fa86de 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedTypes.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/MixedTypes.cs @@ -35,14 +35,14 @@ internal MixedTypes(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get mixed type. public virtual async Task> GetMixedTypeAsync() { ClientResult result = await GetMixedTypeAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get mixed type. public virtual ClientResult GetMixedType() { ClientResult result = GetMixedType(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetMixedType() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed type. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetMixedTypeAsync(RequestOptions options } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get mixed type. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/ModelsOnly.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/ModelsOnly.cs index 9ecc9f616b7..4c77fc0a5dd 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/ModelsOnly.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/ModelsOnly.cs @@ -35,14 +35,14 @@ internal ModelsOnly(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get models only. public virtual async Task> GetModelsOnlyAsync() { ClientResult result = await GetModelsOnlyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse4.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get models only. public virtual ClientResult GetModelsOnly() { ClientResult result = GetModelsOnly(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetModelsOnly() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get models only. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetModelsOnlyAsync(RequestOptions option } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get models only. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringAndArray.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringAndArray.cs index 43009782f70..c6a61bb9ddf 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringAndArray.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringAndArray.cs @@ -35,14 +35,14 @@ internal StringAndArray(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get string and array. public virtual async Task> GetStringAndArrayAsync() { ClientResult result = await GetStringAndArrayAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse2.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get string and array. public virtual ClientResult GetStringAndArray() { ClientResult result = GetStringAndArray(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetStringAndArray() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string and array. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetStringAndArrayAsync(RequestOptions op } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string and array. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensible.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensible.cs index 2955d301287..11e43e1a329 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensible.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensible.cs @@ -35,14 +35,14 @@ internal StringExtensible(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get string extensible. public virtual async Task> GetStringExtensibleAsync() { ClientResult result = await GetStringExtensibleAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse8.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get string extensible. public virtual ClientResult GetStringExtensible() { ClientResult result = GetStringExtensible(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetStringExtensible() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetStringExtensibleAsync(RequestOptions } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensibleNamed.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensibleNamed.cs index 1018178f767..057c3cf1566 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensibleNamed.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringExtensibleNamed.cs @@ -35,14 +35,14 @@ internal StringExtensibleNamed(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get string extensible named. public virtual async Task> GetStringExtensibleNamedAsync() { ClientResult result = await GetStringExtensibleNamedAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse7.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get string extensible named. public virtual ClientResult GetStringExtensibleNamed() { ClientResult result = GetStringExtensibleNamed(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetStringExtensibleNamed() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible named. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetStringExtensibleNamedAsync(RequestOpt } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get string extensible named. /// /// /// diff --git a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringsOnly.cs b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringsOnly.cs index f15ee50616d..3b86c7ef1d1 100644 --- a/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringsOnly.cs +++ b/test/CadlRanchProjectsNonAzure/type/union/src/Generated/StringsOnly.cs @@ -35,14 +35,14 @@ internal StringsOnly(ClientPipeline pipeline, Uri endpoint) _endpoint = endpoint; } - /// Get. + /// Get strings only. public virtual async Task> GetStringsOnlyAsync() { ClientResult result = await GetStringsOnlyAsync(null).ConfigureAwait(false); return ClientResult.FromValue(GetResponse9.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// Get. + /// Get strings only. public virtual ClientResult GetStringsOnly() { ClientResult result = GetStringsOnly(null); @@ -50,7 +50,7 @@ public virtual ClientResult GetStringsOnly() } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get strings only. /// /// /// @@ -74,7 +74,7 @@ public virtual async Task GetStringsOnlyAsync(RequestOptions optio } /// - /// [Protocol Method] Get. + /// [Protocol Method] Get strings only. /// /// /// diff --git a/test/TestProjects/Authoring-TypeSpec/src/Generated/Global.cs b/test/TestProjects/Authoring-TypeSpec/src/Generated/Global.cs index a773da2bd04..ee3c11a87b5 100644 --- a/test/TestProjects/Authoring-TypeSpec/src/Generated/Global.cs +++ b/test/TestProjects/Authoring-TypeSpec/src/Generated/Global.cs @@ -94,7 +94,7 @@ public virtual Pageable GetSupportedLanguages(int? maxCount = null, } /// - /// [Protocol Method] List training config versions. + /// [Protocol Method] Get training config versions. /// /// /// @@ -118,7 +118,7 @@ public virtual AsyncPageable GetTrainingConfigVersionsAsync(int? max } /// - /// [Protocol Method] List training config versions. + /// [Protocol Method] Get training config versions. /// /// /// diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs index 72dfb7f2824..7de93f2f9da 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranscriptions.cs @@ -42,6 +42,7 @@ internal AudioTranscriptions(ClientPipeline pipeline, ApiKeyCredential keyCreden /// Transcribes audio into the input language. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateTranscriptionRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); @@ -54,6 +55,7 @@ public virtual async Task> CreateAsync /// Transcribes audio into the input language. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateTranscriptionRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs index 27941739cdc..6d8da547d59 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/AudioTranslations.cs @@ -42,6 +42,7 @@ internal AudioTranslations(ClientPipeline pipeline, ApiKeyCredential keyCredenti /// Transcribes audio into the input language. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateTranslationRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); @@ -54,6 +55,7 @@ public virtual async Task> CreateAsync(C /// Transcribes audio into the input language. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateTranslationRequest audio) { Argument.AssertNotNull(audio, nameof(audio)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs index a700362fcda..5c656692549 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Embeddings.cs @@ -42,6 +42,7 @@ internal Embeddings(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// Creates an embedding vector representing the input text. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateEmbeddingRequest embedding) { Argument.AssertNotNull(embedding, nameof(embedding)); @@ -54,6 +55,7 @@ public virtual async Task> CreateAsync(Cre /// Creates an embedding vector representing the input text. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateEmbeddingRequest embedding) { Argument.AssertNotNull(embedding, nameof(embedding)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs index 86a8487034d..294ac52b4a3 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Files.cs @@ -40,6 +40,7 @@ internal Files(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri endp } /// Returns a list of files that belong to the user's organization. + /// Get files. public virtual async Task> GetFilesAsync() { ClientResult result = await GetFilesAsync(null).ConfigureAwait(false); @@ -47,6 +48,7 @@ public virtual async Task> GetFilesAsync() } /// Returns a list of files that belong to the user's organization. + /// Get files. public virtual ClientResult GetFiles() { ClientResult result = GetFiles(null); @@ -104,6 +106,7 @@ public virtual ClientResult GetFiles(RequestOptions options) /// Returns a list of files that belong to the user's organization. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateFileRequest file) { Argument.AssertNotNull(file, nameof(file)); @@ -116,6 +119,7 @@ public virtual async Task> CreateAsync(CreateFileReques /// Returns a list of files that belong to the user's organization. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateFileRequest file) { Argument.AssertNotNull(file, nameof(file)); @@ -187,6 +191,7 @@ public virtual ClientResult Create(BinaryContent content, string contentType, Re /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual async Task> RetrieveAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -199,6 +204,7 @@ public virtual async Task> RetrieveAsync(string fileId) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual ClientResult Retrieve(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -269,6 +275,7 @@ public virtual ClientResult Retrieve(string fileId, RequestOptions options) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Delete. public virtual async Task> DeleteAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -281,6 +288,7 @@ public virtual async Task> DeleteAsync(string f /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Delete. public virtual ClientResult Delete(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -351,6 +359,7 @@ public virtual ClientResult Delete(string fileId, RequestOptions options) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Download. public virtual async Task> DownloadAsync(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); @@ -363,6 +372,7 @@ public virtual async Task> DownloadAsync(string fileId) /// The ID of the file to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Download. public virtual ClientResult Download(string fileId) { Argument.AssertNotNullOrEmpty(fileId, nameof(fileId)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs index ebee9f3d3e1..8635fae95b7 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTunes.cs @@ -48,6 +48,7 @@ internal FineTunes(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// /// The to use. /// is null. + /// Create. [Obsolete("deprecated")] public virtual async Task> CreateAsync(CreateFineTuneRequest fineTune) { @@ -67,6 +68,7 @@ public virtual async Task> CreateAsync(CreateFineTuneRequ /// /// The to use. /// is null. + /// Create. [Obsolete("deprecated")] public virtual ClientResult Create(CreateFineTuneRequest fineTune) { @@ -144,6 +146,7 @@ public virtual ClientResult Create(BinaryContent content, RequestOptions options } /// List your organization's fine-tuning jobs. + /// Get fine tunes. [Obsolete("deprecated")] public virtual async Task> GetFineTunesAsync() { @@ -152,6 +155,7 @@ public virtual async Task> GetFineTunesAsync } /// List your organization's fine-tuning jobs. + /// Get fine tunes. [Obsolete("deprecated")] public virtual ClientResult GetFineTunes() { @@ -217,6 +221,7 @@ public virtual ClientResult GetFineTunes(RequestOptions options) /// The ID of the fine-tune job. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. [Obsolete("deprecated")] public virtual async Task> RetrieveAsync(string fineTuneId) { @@ -234,6 +239,7 @@ public virtual async Task> RetrieveAsync(string fineTuneI /// The ID of the fine-tune job. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. [Obsolete("deprecated")] public virtual ClientResult Retrieve(string fineTuneId) { @@ -320,6 +326,7 @@ public virtual ClientResult Retrieve(string fineTuneId, RequestOptions options) /// /// is null. /// is an empty string, and was expected to be non-empty. + /// Get events. [Obsolete("deprecated")] public virtual async Task> GetEventsAsync(string fineTuneId, bool? stream = null) { @@ -342,6 +349,7 @@ public virtual async Task> GetEventsAsy /// /// is null. /// is an empty string, and was expected to be non-empty. + /// Get events. [Obsolete("deprecated")] public virtual ClientResult GetEvents(string fineTuneId, bool? stream = null) { @@ -433,6 +441,7 @@ public virtual ClientResult GetEvents(string fineTuneId, bool? stream, RequestOp /// The ID of the fine-tune job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. + /// Cancel. [Obsolete("deprecated")] public virtual async Task> CancelAsync(string fineTuneId) { @@ -446,6 +455,7 @@ public virtual async Task> CancelAsync(string fineTuneId) /// The ID of the fine-tune job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. + /// Cancel. [Obsolete("deprecated")] public virtual ClientResult Cancel(string fineTuneId) { diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs index 906b560d413..4da8f9b63a1 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/FineTuningJobs.cs @@ -143,7 +143,7 @@ public virtual ClientResult Create(BinaryContent content, RequestOptions options return ClientResult.FromResponse(_pipeline.ProcessMessage(message, options)); } - /// List paginated. + /// Get paginateds. /// Identifier for the last job from the previous pagination request. /// Number of fine-tuning jobs to retrieve. public virtual async Task> GetPaginatedsAsync(string after = null, long? limit = null) @@ -152,7 +152,7 @@ public virtual async Task> Get return ClientResult.FromValue(ListPaginatedFineTuningJobsResponse.FromResponse(result.GetRawResponse()), result.GetRawResponse()); } - /// List paginated. + /// Get paginateds. /// Identifier for the last job from the previous pagination request. /// Number of fine-tuning jobs to retrieve. public virtual ClientResult GetPaginateds(string after = null, long? limit = null) @@ -162,7 +162,7 @@ public virtual ClientResult GetPaginateds(s } /// - /// [Protocol Method] List paginated. + /// [Protocol Method] Get paginateds. /// /// /// @@ -188,7 +188,7 @@ public virtual async Task GetPaginatedsAsync(string after, long? l } /// - /// [Protocol Method] List paginated. + /// [Protocol Method] Get paginateds. /// /// /// @@ -221,6 +221,7 @@ public virtual ClientResult GetPaginateds(string after, long? limit, RequestOpti /// The to use. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual async Task> RetrieveAsync(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -237,6 +238,7 @@ public virtual async Task> RetrieveAsync(string fine /// The to use. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual ClientResult Retrieve(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -313,6 +315,7 @@ public virtual ClientResult Retrieve(string fineTuningJobId, RequestOptions opti /// Number of events to retrieve. /// is null. /// is an empty string, and was expected to be non-empty. + /// Get events. public virtual async Task> GetEventsAsync(string fineTuningJobId, string after = null, long? limit = null) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -327,6 +330,7 @@ public virtual async Task> GetEven /// Number of events to retrieve. /// is null. /// is an empty string, and was expected to be non-empty. + /// Get events. public virtual ClientResult GetEvents(string fineTuningJobId, string after = null, long? limit = null) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -401,6 +405,7 @@ public virtual ClientResult GetEvents(string fineTuningJobId, string after, long /// The ID of the fine-tuning job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. + /// Cancel. public virtual async Task> CancelAsync(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); @@ -413,6 +418,7 @@ public virtual async Task> CancelAsync(string fineTu /// The ID of the fine-tuning job to cancel. /// is null. /// is an empty string, and was expected to be non-empty. + /// Cancel. public virtual ClientResult Cancel(string fineTuningJobId) { Argument.AssertNotNullOrEmpty(fineTuningJobId, nameof(fineTuningJobId)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs index e4f52b64145..da64ab3cbfb 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Images.cs @@ -42,6 +42,7 @@ internal Images(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri end /// Creates an image given a prompt. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateImageRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -54,6 +55,7 @@ public virtual async Task> CreateAsync(CreateImageR /// Creates an image given a prompt. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateImageRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -122,6 +124,7 @@ public virtual ClientResult Create(BinaryContent content, RequestOptions options /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. + /// Create edit. public virtual async Task> CreateEditAsync(CreateImageEditRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -134,6 +137,7 @@ public virtual async Task> CreateEditAsync(CreateIm /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. + /// Create edit. public virtual ClientResult CreateEdit(CreateImageEditRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -204,6 +208,7 @@ public virtual ClientResult CreateEdit(BinaryContent content, string contentType /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. + /// Create variation. public virtual async Task> CreateVariationAsync(CreateImageVariationRequest image) { Argument.AssertNotNull(image, nameof(image)); @@ -216,6 +221,7 @@ public virtual async Task> CreateVariationAsync(Cre /// Creates an edited or extended image given an original image and a prompt. /// The to use. /// is null. + /// Create variation. public virtual ClientResult CreateVariation(CreateImageVariationRequest image) { Argument.AssertNotNull(image, nameof(image)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs index 01b89980664..883972d1878 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/ModelsOps.cs @@ -43,6 +43,7 @@ internal ModelsOps(ClientPipeline pipeline, ApiKeyCredential keyCredential, Uri /// Lists the currently available models, and provides basic information about each one such as the /// owner and availability. /// + /// Get models. public virtual async Task> GetModelsAsync() { ClientResult result = await GetModelsAsync(null).ConfigureAwait(false); @@ -53,6 +54,7 @@ public virtual async Task> GetModelsAsync() /// Lists the currently available models, and provides basic information about each one such as the /// owner and availability. /// + /// Get models. public virtual ClientResult GetModels() { ClientResult result = GetModels(null); @@ -116,6 +118,7 @@ public virtual ClientResult GetModels(RequestOptions options) /// The ID of the model to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual async Task> RetrieveAsync(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -131,6 +134,7 @@ public virtual async Task> RetrieveAsync(string model) /// The ID of the model to use for this request. /// is null. /// is an empty string, and was expected to be non-empty. + /// Retrieve. public virtual ClientResult Retrieve(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -203,6 +207,7 @@ public virtual ClientResult Retrieve(string model, RequestOptions options) /// The model to delete. /// is null. /// is an empty string, and was expected to be non-empty. + /// Delete. public virtual async Task> DeleteAsync(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); @@ -215,6 +220,7 @@ public virtual async Task> DeleteAsync(string /// The model to delete. /// is null. /// is an empty string, and was expected to be non-empty. + /// Delete. public virtual ClientResult Delete(string model) { Argument.AssertNotNullOrEmpty(model, nameof(model)); diff --git a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs index fc4149a9821..1e9336287e9 100644 --- a/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs +++ b/test/UnbrandedProjects/Platform-OpenAI-TypeSpec/src/Generated/Moderations.cs @@ -42,6 +42,7 @@ internal Moderations(ClientPipeline pipeline, ApiKeyCredential keyCredential, Ur /// Classifies if text violates OpenAI's Content Policy. /// The to use. /// is null. + /// Create. public virtual async Task> CreateAsync(CreateModerationRequest content) { Argument.AssertNotNull(content, nameof(content)); @@ -54,6 +55,7 @@ public virtual async Task> CreateAsync(Cr /// Classifies if text violates OpenAI's Content Policy. /// The to use. /// is null. + /// Create. public virtual ClientResult Create(CreateModerationRequest content) { Argument.AssertNotNull(content, nameof(content));