moving preview version to public folder #22447
Merged
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
banggaurav
requested review from
msyyc,
Wzb123456789,
ArcturusZhang and
qiaozha
as code owners
|
Hi, @banggaurav Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-07-01-preview | package-2022-07-01-preview(377bda2) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json#L826 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌CadlValidation: 1 Errors, 25 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"details":"The generated swagger file 2022-07-01-preview/openapi.json from cadl specification/newrelic/NewRelic.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: @azure-tools/cadl-azure-core/lib/models.cadl#L13 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: @azure-tools/cadl-azure-core/lib/models.cadl#L13 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: specification/newrelic/NewRelic.Management/main.cadl#L386 |
|
| The documentation should not be the same as the node name. Location: specification/newrelic/NewRelic.Management/main.cadl#L670 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: specification/newrelic/NewRelic.Management/main.cadl#L377 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L469 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L599 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L596 |
|
| The RP-specific property model in the 'properties' property of this resource must contain a 'provisioningState property. The property type should be an enum, and it must specify known state values 'Succeeded', 'Failed', and 'Canceled'. Location: specification/newrelic/NewRelic.Management/main.cadl#L659 |
|
| The RP-specific property model in the 'properties' property of this resource must contain a 'provisioningState property. The property type should be an enum, and it must specify known state values 'Succeeded', 'Failed', and 'Canceled'. Location: specification/newrelic/NewRelic.Management/main.cadl#L638 |
|
| The RP-specific property model in the 'properties' property of this resource must contain a 'provisioningState property. The property type should be an enum, and it must specify known state values 'Succeeded', 'Failed', and 'Canceled'. Location: specification/newrelic/NewRelic.Management/main.cadl#L689 |
|
@armResourceAction should not be used with @segment. Instead, use @action(...) if you need to rename the action, or omit.Location: specification/newrelic/NewRelic.Management/main.cadl#L69 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L74 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L81 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L89 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L97 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L105 |
|
| Resource POST operation must be decorated with @armResourceAction. Location: specification/newrelic/NewRelic.Management/main.cadl#L113 |
|
| The names of Interface types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L122 |
|
| Each resource interface must have an @armResourceOperations decorator. Location: specification/newrelic/NewRelic.Management/main.cadl#L122 |
|
| The names of Interface types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L132 |
|
| Each resource interface must have an @armResourceOperations decorator. Location: specification/newrelic/NewRelic.Management/main.cadl#L132 |
|
| The names of Interface types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L142 |
|
| Each resource interface must have an @armResourceOperations decorator. Location: specification/newrelic/NewRelic.Management/main.cadl#L142 |
|
| "details":"The configuration 'output-file' for '@azure-tools/cadl-autorest' is missing in the cadl-project.yaml under folder specification/newrelic/NewRelic.Management, please ensure it is added in the configuration of the emitter '@azure-tools/cadl-autorest'." |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @banggaurav your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
AzureRestAPISpecReview
added
Cadl
|
Hi @banggaurav, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @banggaurav, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
Hi @banggaurav, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
This was referenced Feb 3, 2023
[AutoPR @azure/arm-newrelic] moving preview version to public folder
azure-sdk/azure-sdk-for-js#3681
Closed
Pleasehttps://github.com/Azure/azure-openapi-validator/blob/main/docs/operation-id-noun-verb.md Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Refers to: specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json:826 in 076b64c. [](commit_id = 076b64c, deletion_comment = False) |
|
Please see if you can fix the linter errors https://github.com/Azure/azure-rest-api-specs/pull/22447/checks?check_run_id=11091771476 |
sjanamma
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
honghr
approved these changes
Feb 8, 2023
This was referenced Feb 8, 2023
Closed
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* moving preview version to public folder * updating cadl file * fixing cadl compile error * fixing inconsistent cadl --------- Co-authored-by: Gaurav Bang <gauravbang@microsoft.com>
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.