Adding BYOL changes #24064
Merged
Adding BYOL changes #24064
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
JatinKhatri03
requested review from
DominikMe and
JeffreyRichter
and removed request for
a team
|
Hi, @JatinKhatri03 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 Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| agfood.json | 2023-06-01-preview(c6b105e) | 2023-04-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: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-06-01-preview | package-2023-06-01-preview(c6b105e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Check for appropriate use of formData parameters. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L1154 |
||
| Check for appropriate use of formData parameters. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L6220 |
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-06-01-preview/agfood.json#L15971 |
|
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-06-01-preview/agfood.json#L16039 |
|
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-06-01-preview/agfood.json#L16111 |
| 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-06-01-preview/agfood.json#L15 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-01-preview/agfood.json#L253 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L258 |
|
| A 202 response should include an Operation-Location response header. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L288 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-01-preview/agfood.json#L323 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L328 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-01-preview/agfood.json#L377 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L382 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-01-preview/agfood.json#L622 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L627 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L634 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-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-06-01-preview/agfood.json#L681 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L689 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L696 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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-06-01-preview/agfood.json#L758 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L763 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L770 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L791 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L821 |
|
The error property in the error response schema should be required.Location: Microsoft.AgFoodPlatform/preview/2023-06-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 @JatinKhatri03, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
JeffreyRichter
approved these changes
May 19, 2023
There was a problem hiding this comment.
I'm assuming that these lowercase to uppercase case changes are not breaking with a prior release of the service. I also see some properties that still start with a lowercase letter and I think this is a lack of consistency. Also, we tend to start everything with a lowercase letter so I'm not sure that changing to an initial uppercase letter is the right thing to do anyway.
I'll approve this PR but you may want to reconsider the case changes (especially if they are breaking from a previously released version of the service).
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
| } | ||
| }, | ||
| "BasicAuthCredentials": { | ||
| "description": "BasicAuthCredentials.", |
There was a problem hiding this comment.
description can be improved for all new models being introduced
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
| @@ -24768,7 +24783,7 @@ | |||
| }, | |||
| "endTimeHours": { | |||
| "format": "int32", | |||
| "description": "End of time range. Supported ranges are from 0 to 240. (Only applicable for DTN.ClearAg extension.)", | |||
| "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", | |||
There was a problem hiding this comment.
since DTN extension is not available then comment is still valid ?
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
| } | ||
| } | ||
| ], | ||
| "x-ms-discriminator-value": "ApiKeyAuth" |
There was a problem hiding this comment.
The Azure Naming Guidelines recommend that the discriminator field be named kind
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
...fication/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-04-01-preview/agfood.json
Outdated
Show resolved
Hide resolved
JeffreyRichter
added
the
Approved-BreakingChange
|
Hi, @JatinKhatri03, 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 |
3 tasks
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
* Adding BYOL changes * Resolving failing checks * Reverting lowercase to uppercase change * Resolving comments * restoring scenes_list file * Changing model name from BasicAuthCredentials to OAuthClientCredentials * adding changest to new apiversion * Updating examples * Removing null from the query example in swagger
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.
Data Plane API - Pull Request
a. Using ApiKeyAuthCredentials model to get credentials from customer using their keyvault rather than directly asking for the credentials in "/weather-data/:fetch" Api
b. Using ApiKeyAuthCredentials model to get credentials from customer using their keyvault rather than directly asking for the credentials in "/scenes/satellite/ingest-data/{jobId}" and "/scenes/stac-collections/{collectionId}:search" APIs
c. Updated example files for the above mentioned APIs
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.
Is this review for (select one):