Skip to content

Conversation

@stevemunk
Copy link
Member

DOC UPDATE: Added information to the query uri parameter: 'Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline.'

… generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline.'
@stevemunk stevemunk requested a review from a team as a code owner June 6, 2024 17:16
@stevemunk stevemunk requested review from tg-msft and weidongxu-microsoft and removed request for a team June 6, 2024 17:16
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 6, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 6, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
Compared specs (v0.10.9) new version base version
weather.json 1.1(a35c5c5) 1.1(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 specs (v2.2.2) new version base version
1.1 1.1(a35c5c5) 1.1(main)

The following errors/warnings exist before current PR submission:

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

Rule Message
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L286
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L332
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L381
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L436
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L485
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Weather' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Weather/stable/1.1/weather.json#L512
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Weather' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Weather/stable/1.1/weather.json#L556
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L624
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L630
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Weather/stable/1.1/weather.json#L636
⚠️ VersionConvention API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'.
Location: Weather/stable/1.1/weather.json#L5
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Weather/stable/1.1/weather.json#L53
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Weather/stable/1.1/weather.json#L224
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Weather/stable/1.1/weather.json#L233
⚠️ PageableOperation Based on the response model schema, operation 'Weather_GetHourlyForecast' might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L261
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L261
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Weather/stable/1.1/weather.json#L277
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Weather/stable/1.1/weather.json#L303
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Weather/stable/1.1/weather.json#L303
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Weather/stable/1.1/weather.json#L303
⚠️ PageableOperation Based on the response model schema, operation 'Weather_GetMinuteForecast' might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L310
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L310
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Weather/stable/1.1/weather.json#L326
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Weather/stable/1.1/weather.json#L349
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Weather/stable/1.1/weather.json#L349
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Weather/stable/1.1/weather.json#L349
⚠️ PageableOperation Based on the response model schema, operation 'Weather_GetQuarterDayForecast' might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L356
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Weather/stable/1.1/weather.json#L356
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Weather/stable/1.1/weather.json#L372
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Weather/stable/1.1/weather.json#L398
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 6, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 6, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger 1.1 https://apiview.dev/Assemblies/Review/7c31ede4f4e3472fa261fb29ea244d10?revisionId=701d714023164da98479b48564e67793

@jhendrixMSFT jhendrixMSFT merged commit c1621be into Azure:main Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants