[Agrifood] Adding new API version 2023-04-01-preview#23265
Merged
anuchandy merged 4 commits intoAzure:mainfrom Mar 30, 2023
Merged
[Agrifood] Adding new API version 2023-04-01-preview#23265anuchandy merged 4 commits intoAzure:mainfrom
anuchandy merged 4 commits intoAzure:mainfrom
Conversation
bhargav-kansagara
requested review from
JeffreyRichter and
scgbear
and removed request for
a team
|
Hi, @bhargav-kansagara 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| agfood.json | 2023-04-01-preview(ce6caac) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-04-01-preview | package-2023-04-01-preview(ce6caac) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L16042 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L16110 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L16182 |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L15 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L225 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L253 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L258 |
|
| A 202 response should include an Operation-Location response header. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L288 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L296 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L323 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L328 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L352 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L377 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L382 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L594 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L622 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L627 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L634 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L658 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L681 |
|
| 'PATCH' operation 'ApplicationData_CreateOrUpdate' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L681 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L689 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L696 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L723 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApplicationDataModel'. Consider using the plural form of 'ApplicationData' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L758 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L763 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L770 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L791 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L821 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json#L949 |
️️✔️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.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @bhargav-kansagara, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @bhargav-kansagara, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
…te Job and Scenes Get & Search Features APIs
bhargav-kansagara
force-pushed
the
users/bhkansag/2023-04-01-preview
branch
from
23e9ed1 to
24dda61
Compare
Member
|
Reviewed and approved for preview in #23007 |
mikekistler
added
the
APIStewardshipBoard-SignedOff
Member
Author
|
Hi @anuchandy, could you please help me merge the pull request? |
3 tasks
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Adding 2022-11-01-preview swagger for reference * Adding provicer client id and client secret as part of the Scene Create Job and Scenes Get & Search Features APIs * Removing duplicate parameter IntegrationIds from list sensor integrations API * Add changes for supporting multi-polygon shapefile ingestion --------- Co-authored-by: Bhargav Kansagara <bhkansag@microsoft.com> Co-authored-by: Pratyush Prateek <pratyush.prateek.eee15@itbhu.ac.in>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
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 engagement record.
Is this review for (select one):
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 Open API document (swagger) if applicable, and the root paths that have been updated.
❔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