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

[mainsyncbranch] test comment regexp #3325

Closed
wants to merge 1 commit into from

Conversation

JackTn
Copy link

@JackTn JackTn commented Apr 24, 2024

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 24, 2024

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

Copy link

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

Swagger Generation Artifacts

️🔄[ignore this check status; not blocking PR merge] ApiDocPreview inProgress [Detail]
️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-powershell succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

Copy link

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

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.8) new version base version
servicelinker.json 2022-05-01(fc81bd3) 2022-05-01(main)
Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}' removed or restructured?
Old: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2022-05-01 package-2022-05-01(fc81bd3) package-2022-05-01(mainsyncbranch)

The following errors/warnings exist before current PR submission:

Rule Message
ResourceNameRestriction The resource name parameter 'linkerName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L108
ResourceNameRestriction The resource name parameter 'linkerName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L120
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L52
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L65
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validatelinker' in:'Linker_Validate'. Consider updating the operationId
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L79
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L95
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L114
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L137
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L153
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetConfiguration
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L166
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L173
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L180
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L186
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L280
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L547
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L563
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L715
️️✔️[ignore this check status; not blocking PR merge] 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: 5 Errors, 0 Warnings failed [Detail]
Rule Message
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/servicelinker/resource-manager/readme.md
json: stable/2022-05-01/examples/Link.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/servicelinker/resource-manager/readme.md
json: stable/2022-05-01/examples/PatchLink.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/servicelinker/resource-manager/readme.md
json: stable/2022-05-01/examples/PutLink.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/servicelinker/resource-manager/readme.md
json: stable/2022-05-01/examples/PutLinkWithSecretStore.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/servicelinker/resource-manager/readme.md
json: stable/2022-05-01/examples/PutLinkWithServiceEndpoint.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.ServiceLinker/stable/2022-05-01/servicelinker.json#L101:22
ExampleUrl: stable/2022-05-01/examples/ValidateLinkSuccess.json
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[ignore this check status; not blocking PR merge] 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?

@JackTn
Copy link
Author

JackTn commented Apr 24, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@JackTn
Copy link
Author

JackTn commented Apr 24, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@JackTn
Copy link
Author

JackTn commented Apr 25, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@JackTn
Copy link
Author

JackTn commented Apr 26, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@JackTn
Copy link
Author

JackTn commented Apr 26, 2024

/azp run

Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

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.

3 participants