Skip to content

[monitor query] add descriptions to swagger#23833

Merged
tjprescott merged 1 commit intoAzure:mainfrom
gracewilcox:monitor-query-descriptions
May 5, 2023
Merged

[monitor query] add descriptions to swagger#23833
tjprescott merged 1 commit intoAzure:mainfrom
gracewilcox:monitor-query-descriptions

Conversation

@gracewilcox
Copy link
Member

  • Adding descriptions to properties without them
  • Updating outdated descriptions

@gracewilcox gracewilcox added the Monitor Monitor, Monitor Ingestion, Monitor Query label May 5, 2023
@gracewilcox gracewilcox requested a review from srnagar May 5, 2023 17:29
@openapi-workflow-bot
Copy link

Hi, @gracewilcox 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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 5, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    OperationalInsights.json 2022-10-27(2bf8fcc) 2022-10-27(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.1) new version base version
    20221027 20221027(2bf8fcc) 20221027(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ⚠️ VersionPolicy Version segment 'v1' in basePath violates Azure versioning policy.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L19
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L61
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L62
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L79
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L99
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L100
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L117
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L136
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L137
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L148
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L165
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L166
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L177
    ⚠️ GetInOperationName 'GET' operation 'Query_ResourceGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L188
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L196
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L197
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L214
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L231
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L232
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L249
    ⚠️ PathCharacters Path contains non-recommended characters.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L258
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L259
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L268
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L287
    ⚠️ MsPaths Don't use x-ms-paths except where necessary to support legacy APIs.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L297
    ⚠️ GetInOperationName 'GET' operation 'Query_ResourceGetXms' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L300
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L436
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L440
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L444
    ⚠️ SchemaNamesConvention Schema name should be Pascal case.
    Location: Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json#L451
    ️️✔️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 succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️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 May 5, 2023

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 5, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.OperationalInsights https://apiview.dev/Assemblies/Review/8ff727287c92418791ea30f53d718610

    @tjprescott tjprescott merged commit 72427ef into Azure:main May 5, 2023
    @gracewilcox gracewilcox deleted the monitor-query-descriptions branch May 5, 2023 20:52
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    data-plane Monitor - Operational Insights Monitor Monitor, Monitor Ingestion, Monitor Query

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants

    Comments