Adding a new GET api in Microsoft.Network for ServiceTags, with pagination #11075
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[Staging] Swagger Validation Report
️✔️ |
| Rule | Message |
|---|---|
|
Additional properties not allowed: networkFeatures Url: Microsoft.Network/stable/2020-07-01/serviceTags.json#L180 |
|
Additional properties not allowed: state Url: Microsoft.Network/stable/2020-07-01/serviceTags.json#L180 |
️️✔️SemanticValidation [Detail]
️✔️Validation passes for SemanticValidation.
|
No pipelines are associated with this pull request. |
guptas14
added
the
WaitForARMFeedback
|
This is a draft PR for confirming the changes for adding a new service for getting ServiceTag details from NRP. This new api would support pagination, as per ARM-RP contract. |
chiragg4u
reviewed
Oct 8, 2020
| @@ -73,6 +73,49 @@ | |||
| } | |||
| } | |||
| } | |||
| }, | |||
| "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTags/paged": { | |||
There was a problem hiding this comment.
I'm not sure you should added new API for the paged version of serviceTags. Please look at other examples in NRP to evolve the existing API to support paging.
There was a problem hiding this comment.
@chiragg4u So, as I discussed with you during office hours, https://stackoverflow.microsoft.com/questions/225823 , the current ServiceTag definition returned by api is a single object of structure:
public class ServiceTag {
public string Name { get; set; }
public string Id { get; set; }
public string Type { get; set; }
public string ChangeNumber { get; set; }
public string Cloud { get; set; }
public List<ServiceTagInformation> Values { get; set; }
}
And, the requirement is to paginate over the Values list , and not ServiceTag.
Hence, I plan to add a new definition ServiceTagsDetail, as per the PR.
If I change the definition returned by old api, it would break the existing workflow.
What do you suggest?
There was a problem hiding this comment.
IMO adding a query parameter to get the optimal response would be better
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
azure-sdk-for-go
|
azure-sdk-for-net
|
azure-sdk-for-js
|
Azure CLI Extension Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-python-track2
- Breaking Change detected in SDK
|
azure-sdk-for-java
|
Trenton Generation
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
This was referenced Oct 11, 2020
|
No pipelines are associated with this pull request. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
This was referenced Oct 17, 2020
|
Hi, @guptas14. The PR has be closed for a long time and it's related branch still exist. If no further used for over 14 days, I will delete this related branch. Please tell me if you still need this branch. |
|
Hi, @guptas14. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days. |
2 similar comments
|
Hi, @guptas14. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days. |
|
Hi, @guptas14. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
[ Y] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.