Moving Swagger to stable folder creating folder structure #22563

banggaurav · 2023-02-12T17:55:22Z

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:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

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.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] 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.

openapi-workflow-bot · 2023-02-12T17:55:25Z

Hi, @banggaurav Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2023-02-12T17:55:26Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
NewRelic.json	2022-07-01(05fa3c6)	2022-07-01-preview(main)

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2022-07-01	package-2022-07-01(05fa3c6)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` OperationIdNounVerb	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/stable/2022-07-01/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 succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-02-12T17:55:27Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-python failed [Detail]

❌Code Generator Failed [Logs]Release - Generate from 4c9f50b. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.5.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4c9f50b. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-newrelic [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4c9f50b. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/newrelic/armnewrelic [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4c9f50b. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-newrelic [View full logs] [Release SDK Changes]

azure-arm-newrelic-1.0.0-beta.1.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-02-12T17:55:28Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/newrelic/armnewrelic	https://apiview.dev/Assemblies/Review/9874cb37a00944edab0bfd675dda30c3
Java	azure-resourcemanager-newrelic	https://apiview.dev/Assemblies/Review/34dbdabf69a24b20a624000478e255a6
JavaScript	@azure/arm-newrelic	https://apiview.dev/Assemblies/Review/2d554e55a2fe4600b778dec92ada8743

openapi-workflow-bot · 2023-02-12T17:56:04Z

Hi, @banggaurav your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

openapi-workflow-bot · 2023-02-12T18:02:31Z

Hi @banggaurav, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2023-02-12T18:28:20Z

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

rkmanda · 2023-02-18T06:48:41Z

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

Its not clear what specific changes you would like to make with this version. Please follow this guidance to raise the PR

openapi-workflow-bot · 2023-02-18T06:48:53Z

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

banggaurav · 2023-02-20T17:17:58Z

@rkmanda This PR already have 2 commits. In first commit it have all the files copied from preview version and in second commit it contains version update changes. Let me know if something is missing.

* creating folder structure * updating version --------- Co-authored-by: Gaurav Bang <[email protected]>

creating folder structure

f23b070

openapi-assignment-bot bot assigned honghr Feb 12, 2023

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 12, 2023

azure-sdk mentioned this pull request Feb 12, 2023

[AutoPR sdk/resourcemanager/newrelic/armnewrelic] Moving Swagger to stable folder creating folder structure azure-sdk/azure-sdk-for-go#4298

Closed

AzureRestAPISpecReview added Cadl Authored with Cadl CI-FixRequiredOnFailure resource-manager RPaaS labels Feb 12, 2023

updating version

05fa3c6

AzureRestAPISpecReview added CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels Feb 12, 2023

rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 18, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 18, 2023

banggaurav removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 20, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 20, 2023

NetRock approved these changes Feb 20, 2023

View reviewed changes

NetRock added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 20, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 20, 2023

honghr approved these changes Feb 21, 2023

View reviewed changes

honghr merged commit 4c9f50b into main Feb 21, 2023

honghr deleted the gauravbang/nr-stable-folder branch February 21, 2023 04:46

aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023

Moving Swagger to stable folder creating folder structure (Azure#22563)

6ec4b52

* creating folder structure * updating version --------- Co-authored-by: Gaurav Bang <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moving Swagger to stable folder creating folder structure #22563

Moving Swagger to stable folder creating folder structure #22563

banggaurav commented Feb 12, 2023 •

edited

Loading

openapi-workflow-bot bot commented Feb 12, 2023

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading

openapi-workflow-bot bot commented Feb 12, 2023

openapi-workflow-bot bot commented Feb 12, 2023

openapi-workflow-bot bot commented Feb 12, 2023

rkmanda commented Feb 18, 2023

openapi-workflow-bot bot commented Feb 18, 2023

banggaurav commented Feb 20, 2023

Moving Swagger to stable folder creating folder structure #22563

Moving Swagger to stable folder creating folder structure #22563

Conversation

banggaurav commented Feb 12, 2023 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Feb 12, 2023

openapi-pipeline-app bot commented Feb 12, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Feb 12, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Feb 12, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Feb 12, 2023

openapi-workflow-bot bot commented Feb 12, 2023

openapi-workflow-bot bot commented Feb 12, 2023

rkmanda commented Feb 18, 2023

openapi-workflow-bot bot commented Feb 18, 2023

banggaurav commented Feb 20, 2023

banggaurav commented Feb 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading

openapi-pipeline-app bot commented Feb 12, 2023 •

edited

Loading