diff --git a/specification/marketplacecatalog/data-plane/Products/preview/2023-01-01-preview/products.json b/specification/marketplacecatalog/data-plane/Products/preview/2023-01-01-preview/products.json index 6db669477768..912e2888b072 100644 --- a/specification/marketplacecatalog/data-plane/Products/preview/2023-01-01-preview/products.json +++ b/specification/marketplacecatalog/data-plane/Products/preview/2023-01-01-preview/products.json @@ -17,7 +17,7 @@ "tags": [ "SinglePublicProduct" ], - "summary": "Single Public Product API provides an unauthenticated endpoint for consuming product attributes of a single commercial Marketplace public product. Each API request must include an API key allocated to you. Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Get a single commercial Marketplace public product.", "operationId": "SinglePublicProduct_Get", "x-ms-examples": { "Product_Get": { @@ -106,7 +106,7 @@ "tags": [ "ListingPublicProducts" ], - "summary": "Public Products API provides an unauthenticated endpoint for consuming commercial Marketplace public products. In addition, it enables filtering on selected product properties, search, and getting starting price information per product. Each API request must include an API key allocated to you (see X-API-Key description).Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Get a list of commercial public products.", "x-ms-examples": { "Product_Get": { "$ref": "./examples/PublicProducts_List.json" diff --git a/specification/marketplacecatalog/data-plane/Products/preview/2023-05-01-preview/products.json b/specification/marketplacecatalog/data-plane/Products/preview/2023-05-01-preview/products.json index 77d05f81f7cf..6a4c0cf2f73a 100644 --- a/specification/marketplacecatalog/data-plane/Products/preview/2023-05-01-preview/products.json +++ b/specification/marketplacecatalog/data-plane/Products/preview/2023-05-01-preview/products.json @@ -17,7 +17,7 @@ "tags": [ "SinglePublicProduct" ], - "summary": "Single Public Product API provides an unauthenticated endpoint for consuming product attributes of a single commercial 3rd party Marketplace public product or 1st party Azure product. Each API request must include an API key allocated to you. Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Get a single commercial Marketplace public product.", "operationId": "Products_Get", "x-ms-examples": { "Get_Single_Product_SaaS": { @@ -147,7 +147,7 @@ "tags": [ "ListingPublicProducts" ], - "summary": "Public Products API provides an unauthenticated endpoint for consuming commercial 3rd party Marketplace public products and 1st party Azure products. In addition, it enables Odata filtering on selected product properties. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Get a list of commercial public products.", "x-ms-examples": { "List_Products": { "$ref": "./examples/PublicProducts_List.json" @@ -270,7 +270,7 @@ "tags": [ "ListingPublicSkus" ], - "summary": "Public Skus API provides an unauthenticated endpoint for consuming commercial 3rd party Marketplace public skus and 1st party Azure skus. In addition, it enables Odata filtering on selected sku properties or attributes. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "List commercial skus.", "x-ms-examples": { "List_Skus": { "$ref": "./examples/PublicSkus_List.json" diff --git a/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json b/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json index 40e85493b5c4..ae22972d2786 100644 --- a/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json +++ b/specification/marketplacecatalog/data-plane/Search/preview/2023-01-01-preview/search.json @@ -19,7 +19,7 @@ "tags": [ "Public-Search" ], - "summary": "Public Facets API provides an unauthenticated endpoint for consuming list of Marketplace public products counts per requested properties. In addition, it enables filtering on selected product properties, search, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Get counts of Marketplace public products with requested properties.", "operationId": "Facets_Get", "x-ms-examples": { "Facets_Get": { @@ -364,7 +364,7 @@ "tags": [ "Public-Search" ], - "summary": "Public Search API provides an unauthenticated endpoint for consuming list of Marketplace public products, total count of products returned, and facets per requested properties. In addition, it enables filtering on selected product properties, search, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Serves a user experience with search and filter results on Marketplace public products.", "operationId": "Search_Get", "x-ms-examples": { "Search_Get": { @@ -773,7 +773,7 @@ "tags": [ "Public-Suggestions" ], - "summary": "Public Suggestions API provides an unauthenticated endpoint for consuming list of Marketplace public products suggestions per requested properties. In addition, it enables filtering on selected product properties, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)", + "summary": "Make suggestions while user is typing a search query for products.", "operationId": "Suggestions_GetProducts", "x-ms-examples": { "SuggestionsProducts_Get": { diff --git a/specification/marketplacecatalog/suppressions.yaml b/specification/marketplacecatalog/suppressions.yaml new file mode 100644 index 000000000000..25374bacfb32 --- /dev/null +++ b/specification/marketplacecatalog/suppressions.yaml @@ -0,0 +1,11 @@ +- tool: TypeSpecRequirement + path: ./data-plane/Products/preview/2023-01-01-preview/products.json + reason: Only change here is to description. New compliant TypeSpec version in development + +- tool: TypeSpecRequirement + path: ./data-plane/Products/preview/2023-05-01-preview/products.json + reason: Only change here is to description. New compliant TypeSpec version in development + +- tool: TypeSpecRequirement + path: ./data-plane/Search/preview/2023-01-01-preview/search.json + reason: Only change here is to description. New compliant TypeSpec version in development