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

Add version 2018-06-01 with pricing configuration (second time) #4978

Merged
merged 1 commit into from
Feb 7, 2019

Conversation

amireluk
Copy link
Contributor

@amireluk amireluk commented Jan 3, 2019

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-portal-comment
Copy link

If you're a MSFT employee, click this link
to view this PR's validation status on our new OpenAPI Hub spec management tool.

@kpajdzik kpajdzik added the review label Jan 3, 2019
@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@amireluk
Copy link
Contributor Author

amireluk commented Jan 3, 2019

2nd iteration of this PR which was closed - #4072
With slight change to the PUT operation to reflect the API.

@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

@AutorestCI
Copy link

AutorestCI commented Jan 3, 2019

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@orparnes
Copy link
Contributor

orparnes commented Jan 3, 2019

@chlahav is added to the review. #Closed

@chlahav chlahav self-requested a review January 6, 2019 14:38
@amireluk
Copy link
Contributor Author

amireluk commented Jan 7, 2019

@kpajdzik Can you please review the PR ?

@praries880 praries880 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. labels Jan 7, 2019
@sergey-shandar
Copy link
Contributor

@praries880 see also this PR #4072

@sergey-shandar
Copy link
Contributor

sergey-shandar commented Jan 8, 2019

@amireluk have you addressed ARM issues (see #4072)?

@simongdavies let me know if you are ok with the changes.

@sergey-shandar sergey-shandar requested review from simonjaeger and simongdavies and removed request for simonjaeger January 8, 2019 18:51
@amireluk
Copy link
Contributor Author

amireluk commented Jan 8, 2019

@amireluk have you addressed ARM issues (see #4072)?

@simongdavies let me know if you are ok with the changes.

ARM issues in #4072 was about long running operation header. In this iteration the operation is not a long running operation. It returns 200 OK.

Copy link
Contributor

@ravbhatnagar ravbhatnagar left a comment

Choose a reason for hiding this comment

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

@amireluk - some comments

"description": "List of pricing configurations",
"items": {
"$ref": "#/definitions/Pricing"
}
Copy link
Contributor

Choose a reason for hiding this comment

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

do you support pagination?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, the number of returned items is limited.

"type": "object",
"description": "Pricing properties for the relevant scope",
"properties": {
"pricingTier": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Isnt this similar notion as a SKU? If yes, it should be modeled using the sku property which is a top level property. More details can be found in ARM Resource provider contract.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a new API version to an existing type, customers are using it and used to use it. I don't think we want to deprecate it and use the SKU propery instead as it will be very confusing to existing customers.
I'm also not sure we can use the SKU property even if we wanted to since this pricing type implies the tier of the subscritpion in Microsoft.Secruity, and not the sku of a specific resource.

}
}
},
"paths": {
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you had a meeting earlier with Simon about this new resource type? I wanted to get some more context on the usecase for the pricing resource type. what scenario is it enabling.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please note it's an existing type, I'm adding a new API version. The previous version is already documented.

@ravbhatnagar ravbhatnagar added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jan 9, 2019
@ravbhatnagar
Copy link
Contributor

@amireluk - Got it, it was hard to review using the diff tool and know what changed. For next time, please remember that when adding new api-version, the first commit should be the copy of the previous api-version. and then changes to the new api-version should come in subsequent commits. it will make it easier to review.
It looks like you are just moving /pricings resourceType to a non-preview api-version. And there are no changes to this existing resource type from preview. Is that correct.
Also, this means the customer will not be able to use the other resource types like securityContacts etc in this new api-version. Is that the intention?

@amireluk
Copy link
Contributor Author

Also, this means the customer will not be able to use the other resource types like securityContacts etc in this new api-version. Is that the intention?

The non-preview pricing API is slightly different than the preview one, that's the reason for the version change.
I understand that this API version will only include this resource. The other resources have not changed.

@KrisBash
Copy link
Contributor

I understand that this API version will only include this resource. The other resources have not changed.

@amireluk Can you please bring forward the unchanged APIs into this version? It creates a degraded user experience if different resources in the same namespace require different API versions.

@amireluk
Copy link
Contributor Author

@KrisBash
The reason for a new api version for pricing resource is that it changes from the old one. The other did not change and we want to keep them in their existing preview api version.
I want to publish the changes in this PR so customers can have documentation for the pricing resource, even if it means the SDK will not be optimal. At this points the (already public) pricing api is not documented.

@sergey-shandar
Copy link
Contributor

@KrisBash @amireluk any progress on this PR?

@chlahav
Copy link
Contributor

chlahav commented Feb 7, 2019

@KrisBash we want to split our swagger files to types (similar to Compute) to mitigate the degraded user experience.
we will do that right after this merge will happen to avoid merge conflicts.
is there anything additional that we need to do to get the PR approval?

@sergey-shandar sergey-shandar added the ARM-overdue ARM review has not occurred within the expected timeframe label Feb 7, 2019
@sergey-shandar sergey-shandar merged commit 277de73 into Azure:master Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. ARM-overdue ARM review has not occurred within the expected timeframe ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants