Renaming 'credential' property to 'credentials'

[JatinKhatri03]

Data Plane API - Pull Request

We merged this PR last week and we missed a minor change that we wanted to do for 'credential' property name in our new API version. Since this api version is still in development phase and not yet deployed we wanted to rectify out mistake.
In this PR we are renaming 'credential' to 'credentials' for more consistent naming across 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.

• 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.}

• Design Document:
• Previous API Spec Doc:
• Updated paths:

❔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.

• 💬 Teams Channel
• 💌 email

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

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot]

Hi, @JatinKhatri03 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
agfood.json	2023-06-01-preview(84ab965)	2023-06-01-preview(main)

Rule	Message
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'credential' renamed or removed? New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'credential' renamed or removed? New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22544:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22544:7
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'credential' renamed or removed? New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L24728:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L24728:7
❌ 1041 - AddedPropertyInResponse	The new version has a new property 'credentials' in response that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'credentials' that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22220:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'credentials' that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22544:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L22544:7
❌ 1045 - AddedOptionalProperty	The new version has a new optional property 'credentials' that was not found in the old version. New: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L24728:7 Old: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L24728:7

️️✔️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.3)	new version	base version
package-2023-06-01-preview	package-2023-06-01-preview(84ab965)	package-2023-06-01-preview(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
❌ AvoidAnonymousTypes	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
❌ AvoidAnonymousTypes	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
❌ AvoidAnonymousTypes	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
⚠️ 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/2023-06-01-preview/agfood.json#L15
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L225
⚠️ 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/2023-06-01-preview/agfood.json#L253
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L258
⚠️ LroHeaders	A 202 response should include an Operation-Location response header. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L288
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L296
⚠️ 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/2023-06-01-preview/agfood.json#L323
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L328
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L352
⚠️ 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/2023-06-01-preview/agfood.json#L377
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L382
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L594
⚠️ 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/2023-06-01-preview/agfood.json#L622
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L627
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L634
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L658
⚠️ 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/2023-06-01-preview/agfood.json#L681
⚠️ 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/2023-06-01-preview/agfood.json#L681
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L689
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L696
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L723
⚠️ 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/2023-06-01-preview/agfood.json#L758
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L763
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L770
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L791
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.AgFoodPlatform/preview/2023-06-01-preview/agfood.json#L821
⚠️ ErrorResponse	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.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-java warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 221677f. 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] A new release of pip is available: 23.0.1 -> 23.1.2
  cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
  cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
  cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
  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?}

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.AgFoodPlatform	https://apiview.dev/Assemblies/Review/d054b2935f6d49afbd5d69f7bc0617ed

[openapi-workflow-bot]

Hi @JatinKhatri03, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.