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.

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

Jsedlak microsoft languages #25933

Merged

Conversation

jsedlak-microsoft
Copy link
Member

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

@jsedlak-microsoft jsedlak-microsoft requested a review from a team as a code owner September 22, 2023 17:27
@jsedlak-microsoft jsedlak-microsoft requested review from DominikMe and weidongxu-microsoft and removed request for a team September 22, 2023 17:27
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 22, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 22, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
geocoding.json 2021-11-01-preview(3315b65) 2021-11-01-preview(main)
geocoding.json 2022-02-01-preview(3315b65) 2022-02-01-preview(main)
search.json 2022-09-01-preview(3315b65) 2022-09-01-preview(main)
search.json 2022-12-01-preview(3315b65) 2022-12-01-preview(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.1.5) new version base version
2021-11-01-preview 2021-11-01-preview(3315b65) 2021-11-01-preview(main)
2022-02-01-preview 2022-02-01-preview(3315b65) 2022-02-01-preview(main)
package-preview-2022-09 package-preview-2022-09(3315b65) package-preview-2022-09(main)
package-preview-2022-12 package-preview-2022-12(3315b65) package-preview-2022-12(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: Search/preview/2021-11-01-preview/geocoding.json#L54
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L310
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L339
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L355
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2021-11-01-preview/geocoding.json#L383
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2021-11-01-preview/geocoding.json#L513
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2021-11-01-preview/geocoding.json#L518
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L543
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L665
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L674
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2021-11-01-preview/geocoding.json#L687
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2022-02-01-preview/geocoding.json#L54
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2022-02-01-preview/geocoding.json#L358
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2022-02-01-preview/geocoding.json#L374
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2022-02-01-preview/geocoding.json#L402
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2022-02-01-preview/geocoding.json#L532
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Search/preview/2022-02-01-preview/geocoding.json#L537
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2022-02-01-preview/geocoding.json#L693
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2022-02-01-preview/geocoding.json#L702
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Search/preview/2022-02-01-preview/geocoding.json#L715
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Search/preview/2021-11-01-preview/geocoding.json#L126
⚠️ ParameterDefaultNotAllowed A required parameter should not specify a default value.
Location: Search/preview/2021-11-01-preview/geocoding.json#L144
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Search/preview/2021-11-01-preview/geocoding.json#L250
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Search/preview/2021-11-01-preview/geocoding.json#L250
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Search/preview/2021-11-01-preview/geocoding.json#L250
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: Search/preview/2021-11-01-preview/geocoding.json#L257
⚠️ ParameterDefaultNotAllowed A required parameter should not specify a default value.
Location: Search/preview/2021-11-01-preview/geocoding.json#L269
⚠️ SchemaTypeAndFormat Schema with type: integer should specify format
Location: Search/preview/2021-11-01-preview/geocoding.json#L288
⚠️ SchemaTypeAndFormat Schema with type: integer should specify format
Location: Search/preview/2021-11-01-preview/geocoding.json#L288
⚠️ SchemaTypeAndFormat Schema with type: integer should specify format
Location: Search/preview/2021-11-01-preview/geocoding.json#L294
️️✔️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.
️️✔️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).
️️✔️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 Sep 22, 2023

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 22, 2023

Generated ApiView

Language Package Name ApiView Link
Swagger maps-data-plane-Search https://apiview.dev/Assemblies/Review/39bef687805c46a09b88f195af21d52e

@weidongxu-microsoft weidongxu-microsoft added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Sep 27, 2023
@weidongxu-microsoft weidongxu-microsoft merged commit 3eb9ec8 into Azure:main Sep 27, 2023
@openapi-pipeline-app
Copy link

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

@jsedlak-microsoft jsedlak-microsoft deleted the jsedlak-microsoft-languages branch October 25, 2023 15:17
jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
* Update search 2021-11-01-preview language coverage link

* Update 2022-02-01-preview supported language link

* Update 2022-09-01-preview supported languages link

* Update 2022-12-01-preview supported languages link

* Remove locale

* Update geocoding.json to remove locale in URL

* Update geocoding.json to remove locale in URL

* Update search.json to remove locale in URL

* Update search.json to remove locale in URL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. data-plane
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants