From fac387b735910ff183cecf1a40197989ee7b59e1 Mon Sep 17 00:00:00 2001 From: Heidi Steen <1612796+HeidiSteen@users.noreply.github.com> Date: Tue, 17 Oct 2023 08:52:05 -0700 Subject: [PATCH] Replaced disallowed HTML chars and added a missing connection string value (#26265) * Replaced disallowed HTML chars and added a missing value * Fixed sev-1 policheck error --- .../2023-10-01-Preview/searchindex.json | 10 +++++----- .../2023-10-01-Preview/searchservice.json | 4 ++-- .../stable/2023-11-01/searchindex.json | 16 +++++++-------- .../stable/2023-11-01/searchservice.json | 20 +++++++++---------- 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchindex.json index 292f64a6ea05..09cee71ad8b0 100644 --- a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchindex.json +++ b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchindex.json @@ -420,7 +420,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7.", + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.", "x-ms-parameter-grouping": { "name": "SearchOptions" } @@ -550,7 +550,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'.", + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`.", "x-ms-parameter-grouping": { "name": "SearchOptions" } @@ -1819,7 +1819,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7." + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7." }, "Captions": { "type": "string", @@ -1843,7 +1843,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'." + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`." }, "VectorQuery": { "type": "object", @@ -2345,7 +2345,7 @@ { "value": "gl-es", "name": "GlEs", - "description": "Query language value for Galician (Spain)." + "description": "Query language value for Galician." }, { "value": "gu-in", diff --git a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json index 630ec0922e7a..87868e5f52ed 100644 --- a/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json @@ -6488,7 +6488,7 @@ "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" }, "type": "string", - "description": "The connection string for the datasource. Set to '' if you do not want the connection string updated." + "description": "The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource." } }, "description": "Represents credentials that can be used to connect to a datasource." @@ -11728,7 +11728,7 @@ "keyVaultUri": { "x-ms-client-name": "vaultUri", "type": "string", - "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`." }, "accessCredentials": { "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", diff --git a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchindex.json b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchindex.json index f0dd28d76a02..13f3ea9aa06f 100644 --- a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchindex.json +++ b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchindex.json @@ -434,7 +434,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7.", + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.", "x-ms-parameter-grouping": { "name": "SearchOptions" } @@ -463,7 +463,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'.", + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`.", "x-ms-parameter-grouping": { "name": "SearchOptions" } @@ -1204,7 +1204,7 @@ "readOnly": true, "x-ms-client-name": "RerankerScore", "x-nullable": true, - "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'." + "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type `semantic`." }, "@search.highlights": { "type": "object", @@ -1226,7 +1226,7 @@ "readOnly": true, "x-ms-client-name": "Captions", "x-nullable": true, - "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`." } }, "required": [ @@ -1912,7 +1912,7 @@ } }, "additionalProperties": true, - "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.." + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`." }, "SemanticPartialResponseReason": { "type": "string", @@ -1928,7 +1928,7 @@ { "value": "maxWaitExceeded", "name": "MaxWaitExceeded", - "description": "If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned." + "description": "If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned." }, { "value": "capacityOverloaded", @@ -2014,7 +2014,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7." + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7." }, "Captions": { "type": "string", @@ -2038,7 +2038,7 @@ } ] }, - "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'." + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-` option, such as `extractive|highlight-true`. Defaults to `None`." } }, "parameters": { diff --git a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json index 3a38a5232b47..d1075c6e3890 100644 --- a/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json +++ b/specification/search/data-plane/Azure.Search/stable/2023-11-01/searchservice.json @@ -212,7 +212,7 @@ "in": "query", "required": false, "type": "string", - "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or `*` for all properties. The default is all properties." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -561,7 +561,7 @@ "in": "query", "required": false, "type": "string", - "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or `*` for all properties. The default is all properties." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -869,7 +869,7 @@ "in": "query", "required": false, "type": "string", - "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or `*` for all properties. The default is all properties." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -1130,7 +1130,7 @@ "in": "query", "required": false, "type": "string", - "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or `*` for all properties. The default is all properties." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -1271,7 +1271,7 @@ "in": "query", "required": false, "type": "string", - "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or `*` for all properties. The default is all properties." }, { "$ref": "#/parameters/ClientRequestIdParameter" @@ -5738,7 +5738,7 @@ "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" }, "type": "string", - "description": "The connection string for the datasource. Set to '' if you do not want the connection string updated." + "description": "The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource." } }, "description": "Represents credentials that can be used to connect to a datasource." @@ -7088,7 +7088,7 @@ "items": { "type": "string" }, - "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single `*` to allow all origins (not recommended)." }, "maxAgeInSeconds": { "type": "integer", @@ -7546,7 +7546,7 @@ }, "name": { "type": "string", - "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character `#`." }, "description": { "type": "string", @@ -8071,7 +8071,7 @@ "type": "string", "x-nullable": true, "maxLength": 1, - "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is `*`." }, "modelVersion": { "type": "string", @@ -10452,7 +10452,7 @@ "keyVaultUri": { "x-ms-client-name": "vaultUri", "type": "string", - "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`." }, "accessCredentials": { "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials",