Skip to content

[TSP]Generate ring0 service tsp files #27387

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Conversation

blow-hey
Copy link
Member

@blow-hey blow-hey commented Jan 16, 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.

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 (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (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 swagger 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
Swagger-Suppression-Process
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.
  • 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 bot commented Jan 16, 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 bot commented Jan 16, 2024

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: 0 Errors, 0 Warnings failed [Detail]
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️❌Avocado: 10 Errors, 0 Warnings failed [Detail]
Rule Message
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: Microsoft.Cdn/stable/2021-06-01/examples
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.Cdn/stable/2021-06-01
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: Microsoft.EventHub/preview/2022-10-01-preview/examples
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.EventHub/preview/2022-10-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: Microsoft.KeyVault/stable/2023-02-01/examples
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.KeyVault/stable/2023-02-01
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.ServiceBus/preview/2022-10-01-preview
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: Microsoft.ServiceFabric/stable/2021-06-01/examples
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.ServiceFabric/stable/2021-06-01
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: resource-manager/Microsoft.Storage/stable/2022-09-01
️❌SwaggerAPIView: 1 Errors, 0 Warnings failed [Detail]
Rule Message
Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log. "How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"
️❌TypeSpecAPIView: 0 Errors, 3 Warnings failed [Detail]
Rule Message
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
️❌ModelValidation: 22 Errors, 0 Warnings failed [Detail]
Rule Message
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/cdn/Cdn.Management/resource-manager/Microsoft.Cdn/stable/2021-06-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/cdn/Cdn.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/compute/Compute.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/cosmos-db/CosmosDB.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/dns/Dns.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/eventhub/Eventhub.Management/resource-manager/Microsoft.EventHub/preview/2022-10-01-preview/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/eventhub/Eventhub.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/keyvault/KeyVault.Management/resource-manager/Microsoft.KeyVault/stable/2023-02-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/keyvault/KeyVault.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/resources/Resources.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/servicebus/Servicebus.Management/resource-manager/Microsoft.ServiceBus/preview/2022-10-01-preview/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/servicebus/Servicebus.Management/resource.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/servicefabric/ServiceFabric.Management/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/servicefabric/ServiceFabric.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/sql/Sql.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/storage/Storage.Management/resource-manager/Microsoft.Storage/stable/2022-09-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/storage/Storage.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/subscription/Subscription.Management/resources.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/cdn/Cdn.Management/resource-manager/Microsoft.Cdn/stable/2021-06-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/eventhub/Eventhub.Management/resource-manager/Microsoft.EventHub/preview/2022-10-01-preview/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/keyvault/KeyVault.Management/resource-manager/Microsoft.KeyVault/stable/2023-02-01/openapi.json"
unacceptable kind of an object to dump [object Error] "role":"Model Validation",
"url":"https://github.com/Azure/azure-rest-api-specs/blob/98987a33cbf0dd5c7dd787c78a4bfe77678f8830/specification/servicefabric/ServiceFabric.Management/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/openapi.json"
️❌SemanticValidation: 54 Errors, 0 Warnings failed [Detail]

Only 30 items are listed, please refer to log for more details.

Rule Message
INTERNAL_ERROR Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/cdn/common-types/resource-management/v3/types.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/cdn/common-types/resource-management/v3/types.json'
JsonUrl: Microsoft.Cdn/stable/2021-06-01/openapi.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/cdn/Cdn.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/cdn/Cdn.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/cdn/Cdn.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/cdn/Cdn.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/compute/Compute.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/compute/Compute.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/compute/Compute.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/compute/Compute.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/cosmos-db/CosmosDB.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/cosmos-db/CosmosDB.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/cosmos-db/CosmosDB.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/cosmos-db/CosmosDB.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/dns/Dns.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/dns/Dns.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/dns/Dns.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/dns/Dns.Management/resources.json
INTERNAL_ERROR Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/eventhub/common-types/resource-management/v3/types.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/eventhub/common-types/resource-management/v3/types.json'
JsonUrl: Microsoft.EventHub/preview/2022-10-01-preview/openapi.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/eventhub/Eventhub.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/eventhub/Eventhub.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/eventhub/Eventhub.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/eventhub/Eventhub.Management/resources.json
INTERNAL_ERROR Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/keyvault/common-types/resource-management/v3/types.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/keyvault/common-types/resource-management/v3/types.json'
JsonUrl: Microsoft.KeyVault/stable/2023-02-01/openapi.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/keyvault/KeyVault.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/keyvault/KeyVault.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/keyvault/KeyVault.Management/resources.json
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: Resources
JsonUrl: specification/keyvault/KeyVault.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
JsonUrl: specification/resources/Resources.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: info
JsonUrl: specification/resources/Resources.Management/resources.json
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: paths
JsonUrl: specification/resources/Resources.Management/resources.json
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (Aailability), please fix the error. See https://aka.ms/ci-fix#spell-check
path: specification/cosmos-db/CosmosDB.Management/resources.json#L1:105015
HowToFix Unknown word (timeto), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.Storage/stable/2022-09-01/openapi.json#L6298:10
HowToFix Unknown word (timeto), please fix the error. See https://aka.ms/ci-fix#spell-check
path: Microsoft.Storage/stable/2022-09-01/openapi.json#L6314:10
HowToFix Unknown word (doesn), please fix the error. See https://aka.ms/ci-fix#spell-check
path: specification/storage/Storage.Management/resources.json#L1:29159
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 16, 2024

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=408875&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 16, 2024

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

Copy link

Hi @blow-hey! 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.

Copy link

Hi, @blow-hey, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    Copy link

    Hi @blow-hey This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

    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