Skip to content
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.

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

subscription Subscriptions_List requires nextLink #17621

Closed
cataggar opened this issue Feb 2, 2022 · 2 comments
Closed

subscription Subscriptions_List requires nextLink #17621

cataggar opened this issue Feb 2, 2022 · 2 comments
Labels
Service Attention Workflow: This issue is responsible by Azure service team. Subscription

Comments

@cataggar
Copy link
Member

cataggar commented Feb 2, 2022

In the subscription service, the Subscriptions_List operation returns a SubscriptionListResult which says nextLink is required. The service is not returning a nextLink when there are not enough results for paging. The API version for that operation is 2016-06-01 which is used by these tags:

  • package-2021-10
  • package-2020-09
  • package-2019-10-preview
  • package-2019-03-preview
  • package-2018-11-preview
  • package-2018-03-preview
  • package-2016-06-01

cc @Ochirkhuyag, @navysingla, @mjfrb

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/subscription/resource-manager/readme.md

"/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_List",
"description": "Gets all subscriptions for a tenant.",
"x-ms-examples": {
"listSubscriptions": {
"$ref": "./examples/listSubscriptions.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of subscriptions.",
"schema": {
"$ref": "#/definitions/SubscriptionListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},

"SubscriptionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Subscription"
},
"description": "An array of subscriptions."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next set of results."
}
},
"required": [
"nextLink"
],
"description": "Subscription list operation response."
},

This is a swagger quality issue. Tools like the Azure SDK for Rust rely on the service specification matching the service implementation. Azure/azure-sdk-for-rust#650

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 2, 2022
@JackTn JackTn added Service Attention Workflow: This issue is responsible by Azure service team. Subscription labels Feb 6, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 6, 2022
@ghost
Copy link

ghost commented Feb 6, 2022

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @anuragdalmia, @ShilpiGautam, @ramaganesan-rg.

Issue Details

In the subscription service, the Subscriptions_List operation returns a SubscriptionListResult which says nextLink is required. The service is not returning a nextLink when there are not enough results for paging. The API version for that operation is 2016-06-01 which is used by these tags:

  • package-2021-10
  • package-2020-09
  • package-2019-10-preview
  • package-2019-03-preview
  • package-2018-11-preview
  • package-2018-03-preview
  • package-2016-06-01

cc @Ochirkhuyag, @navysingla, @mjfrb

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/subscription/resource-manager/readme.md

"/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"operationId": "Subscriptions_List",
"description": "Gets all subscriptions for a tenant.",
"x-ms-examples": {
"listSubscriptions": {
"$ref": "./examples/listSubscriptions.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of subscriptions.",
"schema": {
"$ref": "#/definitions/SubscriptionListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},

"SubscriptionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Subscription"
},
"description": "An array of subscriptions."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next set of results."
}
},
"required": [
"nextLink"
],
"description": "Subscription list operation response."
},

This is a swagger quality issue. Tools like the Azure SDK for Rust rely on the service specification matching the service implementation. Azure/azure-sdk-for-rust#650

Author: cataggar
Assignees: -
Labels:

Service Attention, Subscription, needs-triage

Milestone: -

@cataggar
Copy link
Member Author

Fixed by #17674.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Service Attention Workflow: This issue is responsible by Azure service team. Subscription
Projects
None yet
Development

No branches or pull requests

2 participants