Skip to content

[Hub Generated] Add missing listProducts API to documentation #19392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
honghr merged 2 commits into from
Jun 22, 2022
Merged

[Hub Generated] Add missing listProducts API to documentation #19392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4dd8dbc
Add specification for list products
sdandu21 Jun 9, 2022
1c597ec
Add spec to 2016-01-01
sdandu21 Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions ...ification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Product.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,54 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listProducts": {
"post": {
"x-ms-examples": {
"Returns a list of products.": {
"$ref": "examples/Product/ListPost.json"
}
},
"tags": [
"Product"
],
"description": "Returns a list of products.",
"operationId": "Products_ListProducts",
"parameters": [
{
"$ref": "AzureStack.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "AzureStack.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "AzureStack.json#/parameters/RegistrationNameParameter"
},
{
"$ref": "#/parameters/ProductNameParameter"
},
{
"$ref": "#/parameters/DeviceConfigurationParameter"
},
{
"$ref": "AzureStack.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProductList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProducts": {
"post": {
"x-ms-examples": {
Expand Down
48 changes: 48 additions & 0 deletions ...ification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,54 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listProducts": {

@raosuhas raosuhas Jun 10, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

listProducts

why do you need a POST .. this should really be modelled as a GET collection at the top level i.e :

GET : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products

@zcollins0 zcollins0 Jun 10, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is for fixing a swagger completeness item in s360. This API has been around for the entire lifetime of the RP, but wasn't documented for some reason. Changing how we model the operation would be a breaking change, and also wouldn't fix the swagger completeness issue. I don't know why this didn't show up earlier in swagger completeness - logs show the operation has been in use for a long time.

This action is modeled as a POST request because it has a body, the DeviceConfigurationParameter in the swagger JSON.

@zcollins0 zcollins0 Jun 10, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Further, this action is identical to the POST ...{productName}/getProducts action. I don't know why they both exist - anyone who wrote these APIs is long gone.

@raosuhas raosuhas Jun 10, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You would need to work with the breaking change board to get the "NewApiversionRequired" Tag removed. Once that is done then please remove the "ARMChangesRequested" label and we can do the arm sign off

@zcollins0 zcollins0 Jun 10, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Can you give an example of what we should do to annotate the parameter? If you look at the parameter definition further down the file it does say "in": "body". Not sure what else we should do.

"post": {
"x-ms-examples": {
"Returns a list of products.": {
"$ref": "examples/Product/ListPost.json"
}
},
"tags": [
"Product"
],
"description": "Returns a list of products.",
"operationId": "Products_ListProducts",
"parameters": [
{
"$ref": "AzureStack.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "AzureStack.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "AzureStack.json#/parameters/RegistrationNameParameter"
},
{
"$ref": "#/parameters/ProductNameParameter"
},
{
"$ref": "#/parameters/DeviceConfigurationParameter"
},
{
"$ref": "AzureStack.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProductList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "AzureStack.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProducts": {
"post": {
"x-ms-examples": {
Expand Down