Skip to content

[Test] add a new mgmt service #3655

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
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[Test] add a new mgmt service #3655

wants to merge 1 commit into from

Conversation

chunyu3
Copy link

@chunyu3 chunyu3 commented Apr 12, 2023

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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

openapi-pipeline-app-test bot commented Apr 12, 2023 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-2023-05-preview package-2023-05-preview(8cc6499) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L611
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
Rule Message
❌ RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE Following response status codes 200 for operation IndexOperations_Delete were present in the swagger spec, however they were not present in x-ms-examples. Please provide them.
Url: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L378:18
ExampleUrl: preview/2023-05-01-preview/examples/IndexOperations_Delete.json#L10:16
❌ RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE Following response status codes 204 for operation IndexOperations_Delete were present in the swagger spec, however they were not present in x-ms-examples. Please provide them.
Url: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L395:18
ExampleUrl: preview/2023-05-01-preview/examples/IndexOperations_Delete.json#L10:16
❌ RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE Following response status codes 200 for operation IndexOperations_Delete were present in the swagger spec, however they were not present in x-ms-examples. Please provide them.
Url: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L378:18
ExampleUrl: preview/2023-05-01-preview/examples/IndexOperations_Delete.json#L10:16
❌ RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE Following response status codes 204 for operation IndexOperations_Delete were present in the swagger spec, however they were not present in x-ms-examples. Please provide them.
Url: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L395:18
ExampleUrl: preview/2023-05-01-preview/examples/IndexOperations_Delete.json#L10:16
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️❌~[Staging] TypeSpecAPIView: 0 Errors, 1 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."
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️❌[Staging] SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule Message
❌ HowToFix Unknown word (typespec), please fix the error or add words to ./custom-words.txt
path: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L7:8
❌ HowToFix Unknown word (typespec), please fix the error or add words to ./custom-words.txt
path: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L9:34
❌ HowToFix Unknown word (typespec), please fix the error or add words to ./custom-words.txt
path: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L511:14
❌ HowToFix Unknown word (typespec), please fix the error or add words to ./custom-words.txt
path: Microsoft.CognitiveSearch/preview/2023-05-01-preview/openapi.json#L518:14
️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
  • The following tags are being changed in this PR
    • "https://github.com/openapi-env-test/azure-rest-api-specs/blob/8cc6499b58a00292e367ec7366e6e8e64a2fdf7a/specification/cognitivesearch/resource-manager/readme.md#tag-package-2023-05-preview">cognitivesearch/resource-manager/readme.md#package-2023-05-preview
The following errors/warnings are introduced by current PR:
Rule Message
⚠️ UnkownSecurityScheme "readme":"cognitivesearch/resource-manager/readme.md",
"tag":"package-2023-05-preview",
"details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
AzureKey,
Anonymous"
️️✔️CadlValidation succeeded [Detail] [Expand] 
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
Validation passes for TypeSpec Validation.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Apr 12, 2023 •
edited
Loading

Swagger Generation Artifacts

️🔄[Staging] ApiDocPreview inProgress [Detail]
️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 4ac4b4b94c3602a08afe6c4115e6b5fb51ac8486. 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		specification/cognitivesearch/CognitiveSearch.Management/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.Cognitivesearch [View full logs]  [Preview SDK Changes] 
    info	[Changelog]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Apr 12, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.CognitiveSearch https://apiviewstaging.azurewebsites.net/Assemblies/Review/aea6636333694f94be7bb57f9ed03668
.Net Azure.ResourceManager.Cognitivesearch https://apiviewstaging.azurewebsites.net/Assemblies/Review/44540a7a8da947e3bd7462b847b65bde

@azure-sdk azure-sdk mentioned this pull request Apr 12, 2023
Closed
@chunyu3
Copy link
Author

chunyu3 commented Apr 12, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 12, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 12, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3 chunyu3 marked this pull request as draft April 13, 2023 08:33
@chunyu3
Copy link
Author

chunyu3 commented Apr 21, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 21, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 21, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 21, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@chunyu3
Copy link
Author

chunyu3 commented Apr 23, 2023

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@ruowan ruowan

Labels
ARMReview CI-FixRequiredOnFailure CI-MissingBaseCommit new-api-version new-rp-namespace resource-manager RPaaS WaitForARMFeedback
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chunyu3 @ruowan @AzureRestAPISpecReview