-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[TypeSpec] Suppress "documentation-required" lint rule #24297
Merged
mikeharder
merged 16 commits into
Azure:main
from
mikeharder:suppress-documentation-required
Jun 6, 2023
Merged
[TypeSpec] Suppress "documentation-required" lint rule #24297
mikeharder
merged 16 commits into
Azure:main
from
mikeharder:suppress-documentation-required
Jun 6, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- New rule coming in TypeSpec 0.45.0
Swagger Validation Report
|
Rule | Message |
---|---|
"How to fix":"Check the detailed log and update cadl version to latest." | |
"How to fix":"Check the detailed log and update cadl version to latest." |
️⌛
TypeSpecAPIView pending [Detail]
️️✔️
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 pending [Detail]
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️⌛
CadlValidation pending [Detail]
️❌
TypeSpec Validation: 8 Errors, 26 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
SwaggerNotExistInPRBranch |
"details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
SwaggerNotExistInPRBranch |
"details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
InConsistentSwagger |
"details":"The generated swagger file 2022-09-02-preview/fleets.json from typespec specification/containerservice/Fleet.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2022-09-02-preview/fleets.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
InConsistentSwagger |
"details":"The generated swagger file 2023-03-15-preview/fleets.json from typespec specification/containerservice/Fleet.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/eventgrid/Azure.Messaging.EventGrid, please ensure the 'examples' is added in the PR." |
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." |
InConsistentSwagger |
"details":"The generated swagger file 2023-05-01-preview/TrafficController.json from typespec specification/servicenetworking/ServiceNetworking.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
|
Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
|
Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
|
Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L168 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L185 |
|
Azure services must not have properties of type unknown .Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L56 |
|
The names of Property types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L59 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L168 |
|
Request body should not be of raw array type. Consider creating a container model that can add properties over time to avoid introducing breaking changes. Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L196 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L185 |
|
Request body should not be of raw array type. Consider creating a container model that can add properties over time to avoid introducing breaking changes. Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L196 |
|
Request body should not be of raw array type. Consider creating a container model that can add properties over time to avoid introducing breaking changes. Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L196 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L204 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L228 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L252 |
|
The names of Operation types must use camelCase Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L275 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L168 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L185 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L168 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L185 |
|
The shared option is deprecated, use the @sharedRoute decorator instead.Location: specification/eventgrid/Azure.Messaging.EventGrid/main.tsp#L168 |
️⌛
PR Summary pending [Detail]
Hi, @mikeharder 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. [email protected] |
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
Cognitive Services
label
Jun 5, 2023
mikeharder
requested review from
palma21,
weinong,
alvinli222,
matthchr,
circy9 and
yangyuan
as code owners
June 5, 2023 21:14
Closed
mikeharder
changed the title
Suppress "documentation-required" lint rule
[TypeSpec] Suppress "documentation-required" lint rule
Jun 5, 2023
markcowl
approved these changes
Jun 5, 2023
This was referenced Jun 6, 2023
This was referenced Jun 6, 2023
markcowl
approved these changes
Jun 6, 2023
This was referenced Jun 6, 2023
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
- Docs missing from version enums will be fixed by https://github.com/Azure/typespec-azure/issues/3107 - Other missing docs MUST be fixed in the next update to the spec
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CI targeting "main"
CI targeting "typespec-next"
Check Failures