Template Specs: Dropping "Model" suffix from TemplateSpec and TemplateSpecVersion #9998
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 |
|---|---|
|
The new version is missing a definition that was found in the old version. Was 'TemplateSpecModel' removed or renamed? New: Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json#L546:3 Old: Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json#L546:3 |
|
The new version is missing a definition that was found in the old version. Was 'TemplateSpecVersionModel' removed or renamed? New: Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json#L546:3 Old: Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json#L546:3 |
️️✔️LintDiff [Detail]
️✔️Validation passes for LintDiff.
️️✔️Avocado [Detail]
️✔️Validation passes for Avocado.
|
Azure Pipelines successfully started running 1 pipeline(s). |
Azure CLI Extension Generation - Release
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-go - Release
|
azure-sdk-for-java - Release
|
azure-sdk-for-js - Release
|
azure-sdk-for-python - Release
|
azure-sdk-for-net - Release
|
azure-sdk-for-python-track2 - Release
|
Trenton Generation - Release
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
|
|
Can one of the admins verify this patch? |
This was referenced Jul 1, 2020
|
FYI: The breaking change failures (model renames) are of course expected. This service is not yet released, so we are not breaking any customers. |
|
Hi @stuartko , per Retirement of Preview guidance, products in Preview for over one year need to move to GA or retire; require CVP exemption after 1 year in preview. |
|
@raych1 : Template Specs has not entered preview (we plan to enter private preview this month), so we are not exceeding any review periods. It's currently a feature/service in development. |
|
@stuartko , the api version says |
|
I think this is an edge case that is not covered by that rule. Yes, the API is over a year old, but it never even entered private preview, no customers have ever been onboarded and no SDKs have been published (the feature got held up in super long discussions). I think the confusing part here is that the swagger was made public even though the feature is actually hidden behind feature flags. It should have been kept private. I think the end state that we want here is the following:
Submitting the PR for number 1 will trigger breaking change detection even though it is not actually a breaking change. Which is why I think this PR should be approved. (We don't want "Model" suffixes in the swagger.) This will then unblock step 1 and then step 2 (which will also not be a breaking change because the API is not being used). Once that's the done we will be in the end state that everyone wants. In reply to: 652729923 [](ancestors = 652729923) |
majastrz
approved these changes
Jul 2, 2020
majastrz
added
the
ARMSignedOff
raych1
added
the
Approved-BreakingChange
raych1
approved these changes
Jul 2, 2020
|
@akning-ms , the features of |
00Kai0
pushed a commit
to 00Kai0/azure-rest-api-specs
that referenced
this pull request
Oct 12, 2020
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.
No functionality changes... simply drops the "Model" suffix from the definitions of two existing models. Results in cleaner/more consistent SDK.
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
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.
Please follow the link to find more details on API review process.