demo new service #20017

dw511214992 · 2022-07-29T05:47:20Z

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

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.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-07-29T05:47:23Z

Hi, @dw511214992 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. vscswagger@microsoft.com

openapi-pipeline-app · 2022-07-29T05:47:24Z

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-07-01-preview	package-2022-07-01-preview(493c453)	default(main)

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2687

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck 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.

️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/493c45354428a21e09067a3360583e5370e7ad19/specification/demoservice/data-plane/readme.md#tag-package-2022-07-01-preview">demoservice/data-plane/readme.md#package-2022-07-01-preview

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"demoservice/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"
⚠️ SecurityDefinedSpecAndConfig	"readme":"demoservice/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used."

️️✔️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.

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

openapi-pipeline-app · 2022-07-29T05:47:24Z

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 - azure-newservice-demo - first release

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning [Logs] Generate from d2001077d690f0bdf707084f30526bb085a0d82a. 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]  global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️azure-newservice-demo [View full logs] [Preview SDK Changes]
- azure-newservice-demo-1.0.0b1.zip
- azure_newservice_demo-1.0.0b1-py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```

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

️✔️Succeeded [Logs] Generate from d2001077d690f0bdf707084f30526bb085a0d82a. 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-newservices-demo [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from d2001077d690f0bdf707084f30526bb085a0d82a. 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-rest/newservice-demo [View full logs] [Preview SDK Changes]
- azure-rest-newservice-demo-1.0.0-beta.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from d2001077d690f0bdf707084f30526bb085a0d82a. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.IoT.NewServiceDemo [View full logs] [Preview SDK Changes]
- Azure.IoT.NewServiceDemo.1.0.0-alpha.20220729.1.nupkg
```
info	[Changelog]
```

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

openapi-pipeline-app · 2022-07-29T05:47:25Z

Generated ApiView

Language	Package Name	ApiView Link
Python	azure-newservice-demo	https://apiview.dev/Assemblies/Review/93d8cb3c5f114f3d92189586d03298f4
.Net	Azure.IoT.NewServiceDemo	https://apiview.dev/Assemblies/Review/302345dc15d2408ca09b99d6cb76fe07
Java	azure-newservices-demo	https://apiview.dev/Assemblies/Review/816b0c7e3ffd4a6e9ad1b8e863c35522
JavaScript	@azure-rest/newservice-demo	https://apiview.dev/Assemblies/Review/1dca07b395b44755a75ebd131dea42e2

dw511214992 · 2022-07-29T05:47:31Z

azure-sdk-for-js

output-folder: sdk/demoservice/newservice-demo-rest
require:
 - specification/demoservice/data-plane/readme.md

dw511214992 · 2022-07-29T05:47:35Z

azure-sdk-for-python

output-folder: sdk/demoservice/azure-newservice-demo
require:
 - specification/demoservice/data-plane/readme.md

dw511214992 · 2022-07-29T05:47:39Z

azure-sdk-for-java

output-folder: sdk/demoservice/azure-newservices-demo
namespace: com.azure.iot.newservice.demo
data-plane: true
require:
 - specification/demoservice/data-plane/readme.md

dw511214992 · 2022-07-29T05:47:44Z

azure-sdk-for-net-track2

output-folder: sdk/demoservice/Azure.IoT.NewServiceDemo
require:
 - specification/demoservice/data-plane/readme.md

openapi-workflow-bot · 2022-07-29T05:52:01Z

Hi @dw511214992, 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.

dw511214992 · 2022-07-29T06:16:07Z

/azp run

azure-pipelines · 2022-07-29T06:16:16Z

Azure Pipelines successfully started running 1 pipeline(s).

demo new service

493c453

openapi-pipeline-app bot added data-plane CI-FixRequiredOnFailure labels Jul 29, 2022

dw511214992 closed this Jul 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

demo new service #20017

demo new service #20017

dw511214992 commented Jul 29, 2022

openapi-workflow-bot bot commented Jul 29, 2022

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading

dw511214992 commented Jul 29, 2022

dw511214992 commented Jul 29, 2022

dw511214992 commented Jul 29, 2022

dw511214992 commented Jul 29, 2022

openapi-workflow-bot bot commented Jul 29, 2022

dw511214992 commented Jul 29, 2022

azure-pipelines bot commented Jul 29, 2022

demo new service #20017

demo new service #20017

Conversation

dw511214992 commented Jul 29, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 29, 2022

openapi-pipeline-app bot commented Jul 29, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 29, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Jul 29, 2022 • edited Loading

Generated ApiView

dw511214992 commented Jul 29, 2022

azure-sdk-for-js

dw511214992 commented Jul 29, 2022

azure-sdk-for-python

dw511214992 commented Jul 29, 2022

azure-sdk-for-java

dw511214992 commented Jul 29, 2022

azure-sdk-for-net-track2

openapi-workflow-bot bot commented Jul 29, 2022

dw511214992 commented Jul 29, 2022

azure-pipelines bot commented Jul 29, 2022

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 29, 2022 •

edited

Loading