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

Update agfood.json #3326

Closed
wants to merge 3 commits into from
Closed

Update agfood.json #3326

wants to merge 3 commits into from

Conversation

konrad-jamrozik
Copy link

@konrad-jamrozik konrad-jamrozik commented Apr 24, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@konrad-jamrozik konrad-jamrozik self-assigned this Apr 24, 2024
Copy link

openapi-pipeline-app-test bot commented Apr 24, 2024

Next Steps to merge

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

Copy link

openapi-pipeline-app-test bot commented Apr 24, 2024

Swagger Generation Artifacts

️🔄[ignore this check status; not blocking PR merge] ApiDocPreview inProgress [Detail]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning in generating from 1cf23a1379f9b88dbd89c8d940874cb7edd30e6c. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh]  notice
    cmderr	[init.sh] npm notice New patch version of npm available! 10.5.0 -> 10.5.2
    cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.2>
    cmderr	[init.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[init.sh] npm notice
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Apr 24, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.AgFoodPlatform https://apiviewstagingtest.com/Assemblies/Review/494b73a351f349fe80ec0cbee58380e2?revisionId=d855c595b09041d78a1de8646871fe75

Copy link

openapi-pipeline-app-test bot commented Apr 24, 2024

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.8) new version base version
agfood.json 2021-03-31-preview(296fb92) 2021-03-31-preview(main)
Rule Message
1008 - ModifiedOperationId The operation id has been changed from 'ApplicationData_ListByFarmerId' to 'ApplicationData_ListByFarmerId test'. This will impact generated code.
New: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10:7
Old: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 1 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2021-03-31-preview package-2021-03-31-preview(296fb92) package-2021-03-31-preview(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10


The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.

Rule Message
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Farms' 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: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L3304
⚠️ OperationIdNounConflictingModelNames 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/2021-03-31-preview/agfood.json#L15
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L20
⚠️ ParameterNamesConvention Parameter name '$maxPageSize' should not begin with '$' or '@'.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L211
⚠️ ParameterNamesConvention Parameter name '$skipToken' should not begin with '$' or '@'.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L221
⚠️ PaginationResponse value property in pageable response should be required
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L236
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L240
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L242
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L242
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L242
⚠️ OperationIdNounConflictingModelNames 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/2021-03-31-preview/agfood.json#L263
⚠️ ParameterNamesConvention Parameter name '$maxPageSize' should not begin with '$' or '@'.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L452
⚠️ ParameterNamesConvention Parameter name '$skipToken' should not begin with '$' or '@'.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L462
⚠️ PaginationResponse value property in pageable response should be required
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L477
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L481
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L483
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L483
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L483
⚠️ OperationIdNounConflictingModelNames 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/2021-03-31-preview/agfood.json#L504
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L509
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L516
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L538
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L540
⚠️ ErrorResponse Error schema should define code and message properties as required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L540
⚠️ ErrorResponse The error property in the error response schema should be required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L540
⚠️ OperationIdNounConflictingModelNames 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/2021-03-31-preview/agfood.json#L556
⚠️ PatchInOperationName '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/2021-03-31-preview/agfood.json#L556
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L564
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L571
⚠️ RequestBodyOptional The body parameter is not marked as required.
Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L585
️️✔️[ignore this check status; not blocking PR merge] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 158 Errors, 0 Warnings failed [Detail] Only 30 items are listed, please refer to log for more details.
Rule Message
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json#L54:25
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json#L55:29
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_List.json#L53:25
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_List.json#L54:29
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_Get.json#L53:21
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_Get.json#L54:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L7:24
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L7:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L93:21
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L94:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L141:21
INVALID_TYPE Expected type object but found type integer
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9469:35
ExampleUrl: preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json#L142:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_List.json#L17:28
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_List.json#L18:29
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_Get.json#L16:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_Get.json#L17:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json#L6:13
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json#L26:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json#L27:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json#L42:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10057:35
ExampleUrl: preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json#L43:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json#L20:28
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json#L21:29
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_List.json#L19:28
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_List.json#L20:29
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_Get.json#L19:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_Get.json#L20:25
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json#L7:20
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json#L30:24
INVALID_TYPE Expected type object but found type string
Url: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L10152:35
ExampleUrl: preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json#L31:25
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[ignore this check status; not blocking PR merge] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@konrad-jamrozik konrad-jamrozik deleted the konrad-jamrozik-patch-3 branch July 8, 2024 18:38
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