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.

Sign up for GitHub

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

Jump to bottom

Merge deviceupdate #3066

Merged
merged 1 commit into from
Mar 11, 2022
Merged

Merge deviceupdate #3066

merged 1 commit into from
Mar 11, 2022

Conversation

dw511214992
Copy link

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Mar 11, 2022 •
edited
Loading

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/deviceupdate/{instanceId}/management/groups/{groupId}/bestUpdates' removed or restructured?
Old: Microsoft.DeviceUpdate/preview/2021-06-01-preview/deviceupdate.json#L1201:5
️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:
Rule Message
⚠️ R2010 - LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DeviceUpdate/preview/2021-06-01-preview/deviceupdate.json#L56
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceupdate/data-plane/readme.md
json: preview/2021-06-01-preview/examples/DeviceManagement_ListBestUpdatesForGroup.json
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.DeviceUpdate/preview/2021-06-01-preview/deviceupdate.json#L89:22
ExampleUrl: preview/2021-06-01-preview/examples/DeviceUpdate_ImportUpdate.json
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
Validation passes for SDKTrack2Validation

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Mar 11, 2022 •
edited
Loading

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
 Please click here to preview with your @microsoft account.
️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-python-dataplane - track2_azure-iot-deviceupdate - first release
️❌ azure-sdk-for-js-dataplane failed [Detail]
  • ❌Failed [Logs]Release - Generate from 9ff84fd. 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
cmderr	[automation_init.sh] WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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
warn	No file changes detected after generation
error	Fatal error: packageFolderFromFileSearch not configured and could not be found in legacy config
packageFolderFromFileSearch not configured and could not be found in legacy config
Error: packageFolderFromFileSearch not configured and could not be found in legacy config
    at workflowDetectChangedPackages (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:422:23)
    at workflowHandleReadmeMd (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:168:11)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:87:13)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
️❌ azure-sdk-for-python-dataplane failed [Detail]
  • ❌Failed [Logs]Release - Generate from 9ff84fd. 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 minor version of npm available! 8.3.1 -> 8.5.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.5.4` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
error	Fatal error: packageFolderFromFileSearch not configured and could not be found in legacy config
packageFolderFromFileSearch not configured and could not be found in legacy config
Error: packageFolderFromFileSearch not configured and could not be found in legacy config
    at workflowDetectChangedPackages (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:422:23)
    at workflowHandleReadmeMd (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:168:11)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
️⚠️ azure-sdk-for-java-dataplane warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 9ff84fd. 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
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
warn	No file changes detected after generation
  • ️✔️azure-iot-deviceupdate [View full logs] 
️⚠️ azure-sdk-for-net-dataplane warning [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@azure-sdk
Copy link
Collaborator

azure-sdk commented Mar 11, 2022 •
edited
Loading

API change check for Microsoft.DeviceUpdate

API changes have been detected in Microsoft.DeviceUpdate. You can review API changes here

This was referenced Mar 11, 2022
Merged
Merged
Merged
@azure-sdk azure-sdk mentioned this pull request Mar 11, 2022
Merged
@dw511214992 dw511214992 merged commit 9ff84fd into main Mar 11, 2022
azure-sdk pushed a commit that referenced this pull request Jun 7, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
3314542
azure-sdk pushed a commit that referenced this pull request Jul 15, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
3436543
azure-sdk pushed a commit that referenced this pull request Jul 19, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
04cdb76
azure-sdk pushed a commit that referenced this pull request Jul 20, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
9a0e874
azure-sdk pushed a commit that referenced this pull request Jul 21, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
5cc9e1d
azure-sdk pushed a commit that referenced this pull request Jul 21, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
d5bcc26
azure-sdk pushed a commit that referenced this pull request Aug 9, 2022
@dw511214992 @azure-sdk
deviceupdate change and add readme (#3066)
4a8c267
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CI-FixRequiredOnFailure
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dw511214992 @azure-sdk