-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Add new swagger.json for Application Insights ingestion endpoint #17894
Conversation
Hi, @hectorhdzg Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
UNREFERENCED_JSON_FILE |
The example JSON file is not referenced from the swagger file. readme: applicationinsights/data-plane/Monitor.Exporters/readme.md json: preview/2022-02-16_Preview/examples/track.json |
UNREFERENCED_JSON_FILE |
The swagger JSON file is not referenced from the readme file. readme: applicationinsights/data-plane/Monitor.Exporters/readme.md json: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json |
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️❌
ModelValidation: 3 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 401 for operation track were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L64:18 ExampleUrl: preview/2022-02-16_Preview/examples/track.json#L105:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 403 for operation track were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L78:18 ExampleUrl: preview/2022-02-16_Preview/examples/track.json#L105:16 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
Following response status codes 408 for operation track were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L85:18 ExampleUrl: preview/2022-02-16_Preview/examples/track.json#L105:16 |
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 3 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:preview/2022-02-16_Preview/swagger.json compared with base:preview/2020-09-15_Preview/swagger.json
Rule | Message |
---|---|
1011 - AddingResponseCode |
The new version adds a response code '401'. New: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L64:11 |
1011 - AddingResponseCode |
The new version adds a response code '403'. New: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L78:11 |
1011 - AddingResponseCode |
The new version adds a response code '408'. New: Monitor.Exporters/preview/2022-02-16_Preview/swagger.json#L85:11 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
️️✔️
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).
Swagger Generation Artifacts
|
Hi @hectorhdzg, Your PR has some issues. Please fix the CI sequentially by following the order of
|
We need new an updated file for Breeze endpoint used by Application Insights and Azure Monitor OpenTelemetry exporters, this mainly to call v2.1/track instead of v2/track defined before, some features in Breeze are only available in 2.1 like Authentication support that we want to have in exporters. |
Duplicated |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Service is in currently available
March 2022
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.