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

[EGv2] Update documentation #24473

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

[EGv2] Update documentation #24473

wants to merge 21 commits into from

Conversation

l0lawrence
Copy link
Member

No description provided.

@openapi-workflow-bot
Copy link

Hi, @l0lawrence Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @ghost ghost added the Event Grid label Jun 15, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 15, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    EventGrid.json 2023-06-01-preview(a84db94) 2023-06-01-preview(main)
    Rule Message
    ❌ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/json; charset=utf-8' as a request body format.
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L34:3
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L165:9
    ❌ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/json; charset=utf-8' as a request body format.
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L34:3
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L222:9
    ❌ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/json; charset=utf-8' as a request body format.
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L34:3
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L279:9
    ❌ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/topics/{topicName}:publish?api-version={apiVersion}' removed or restructured?
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L286:5
    ❌ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L404:7
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L388:7
    ❌ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L452:7
    Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L437:7
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L51:5
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.3) new version base version
    package-2023-06-01-preview package-2023-06-01-preview(a84db94) package-2023-06-01-preview(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L53
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L59


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ SecurityDefinitionDescription Security definition should have a description.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L43
    ⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L111
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L111
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L112
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L118
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L125
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L180
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L181
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L187
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L194
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L239
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L240
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L246
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L253
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L298
    ⚠️ OperationId OperationId should be of the form 'Noun_Verb'
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L299
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L305
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L312
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L402
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L437
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L450
    ⚠️ PropertyType Property should have a defined type.
    Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L494
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️⚠️TypeSpec Validation: 1 Warnings warning [Detail]
    Rule Message
    ❌ InConsistentSwagger "details":"The generated swagger file EventGrid.json from typespec specification/eventgrid/Azure.Messaging.EventGrid is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json' in PR,
    please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."
    ⚠️ MissingTypeSpecProjectConfig "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/eventgrid/Azure.Messaging.EventGrid,
    please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'."
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 15, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • ❌Pipeline Framework Failed [Logs] Generate from 2562a31497286b9a9dbf9fd4816147279c2a2fff. 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
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mWrite-Error: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/common/scripts/TypeSpec-Project-Process.ps1:26
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m  26 | �[0m   $serviceDir = �[36;1mGet-ServiceDir $tspConfig $repoRoot�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mMissing service-dir in parameters section of tspconfig.yaml. Please
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mrefer to
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mhttps://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
warn	No file changes detected after generation
the given reference name 'refs/heads/sdkAuto/24473/' is not valid
Error: the given reference name 'refs/heads/sdkAuto/24473/' is not valid
    • error	Fatal error: the given reference name 'refs/heads/sdkAuto/24473/' is not valid
error	The following packages are still pending:
error
    ️❌ azure-sdk-for-python failed [Detail]
    • ❌Code Generator Failed [Logs] Generate from 2562a31497286b9a9dbf9fd4816147279c2a2fff. 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.
warn		specification/eventgrid/data-plane/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
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! 9.5.1 -> 9.7.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.7.1` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 15, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    TypeSpec Azure.Messaging.EventGrid https://apiview.dev/Assemblies/Review/d0498bed8c4c4abbb0b1ed5dca303276

    @l0lawrence l0lawrence mentioned this pull request Jun 15, 2023
    Merged
    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane labels Jun 15, 2023
    @openapi-workflow-bot
    Copy link

    Hi @l0lawrence, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

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

    @weshaggard weshaggard Awaiting requested review from weshaggard weshaggard will be requested when the pull request is marked ready for review weshaggard is a code owner

    @mikeharder mikeharder Awaiting requested review from mikeharder mikeharder will be requested when the pull request is marked ready for review mikeharder is a code owner

    @benbp benbp Awaiting requested review from benbp benbp will be requested when the pull request is marked ready for review benbp is a code owner

    @lmazuel lmazuel Awaiting requested review from lmazuel lmazuel will be requested when the pull request is marked ready for review lmazuel is a code owner

    @jsquire jsquire Awaiting requested review from jsquire jsquire will be requested when the pull request is marked ready for review jsquire is a code owner

    @JoshLove-msft JoshLove-msft Awaiting requested review from JoshLove-msft JoshLove-msft will be requested when the pull request is marked ready for review JoshLove-msft is a code owner

    At least 1 approving review is required to merge this pull request.

    Assignees
    No one assigned
    Labels
    BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane Event Grid
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @l0lawrence @AzureRestAPISpecReview