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.

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

mgmt_tsp_automation_conf #3295

Merged
merged 1 commit into from
Apr 19, 2024
Merged

mgmt_tsp_automation_conf #3295

merged 1 commit into from
Apr 19, 2024

Conversation

XiaofeiCao
Copy link

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app-test bot commented Apr 19, 2024

Next Steps to merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app-test bot commented Apr 19, 2024

Swagger Generation Artifacts

️️✔️~[NotRequired_Staging] ApiDocPreview succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

PR validation pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

Copy link

openapi-pipeline-app-test bot commented Apr 19, 2024

Swagger Validation Report

️️✔️ArmstrongValidation succeeded [Detail] [Expand]
️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
Runtime Exception "new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json",
"old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specificationRepositoryConfiguration.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.427/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-VLDMEO
2: FATAL: swagger-document/loader - FAILED
3: FATAL: Error: File 'file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')
4: Error: File 'file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specificationRepositoryConfiguration.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')"
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
Rule Message
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json"
️❌SemanticValidation: 8 Errors, 0 Warnings failed [Detail]
Rule Message
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: $schema
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: pipelineName
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: sdkRepositoryMappings
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: overrides
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: typespecEmitterToSdkRepositoryMapping
JsonUrl: azure-rest-api-specs/blob/d68ddd2ffedf9f8aa423dbce499aedbc0b5f9d73/specificationRepositoryConfiguration.json
️️✔️~[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@XiaofeiCao XiaofeiCao merged commit b2a83a9 into main Apr 19, 2024
23 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants