-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
fix casing for operation id #26180
fix casing for operation id #26180
Conversation
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). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
HybridCompute.json | 2023-06-20-preview(1d688ee) | 2023-06-20-preview(main) |
Rule | Message |
---|---|
1008 - ModifiedOperationId |
The operation id has been changed from 'licenseProfiles_List' to 'LicenseProfiles_List'. This will impact generated code. New: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L829:7 Old: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L829: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.6) | new version | base version |
---|---|---|
package-preview-2023-06 | package-preview-2023-06(1d688ee) | package-preview-2023-06(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PostResponseCodes |
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L38 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'Licenses' 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.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L42 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L84 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L84 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L134 |
LroPatch202 |
The async patch operation should return 202. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L163 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L224 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L348 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L520 |
ResourceNameRestriction |
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1103 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1104 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1104 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1154 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1253 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1441 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1617 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1654 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L1705 |
BodyTopLevelProperties |
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources']. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L2477 |
TrackedResourcePatchOperation |
Tracked resource 'License' must have patch operation that at least supports the update of tags. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L2585 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L3026 |
A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L37 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L46 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L49 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L71 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L92 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L95 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L98 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L123 |
|
Use the latest version v5 of types.json. Location: Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json#L142 |
️️✔️
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]
Swagger Generation Artifacts
|
Generated ApiView
|
/pr RequestMerge |
Please address or respond to feedback from the ARM API reviewer. |
please remove ARMChangesRequested Label when it's ready for review. And Add MergeRequested label only after the PR is labeled signedoff. |
/pr RequestMerge |
just for clarity, this is a 1 character change to correct a casing discrepancy that apparently breaks the pipeline somewhere down the line and isn't checked for as part of the PR builds, for some reason. There are no actual breaking changes in this PR, despite the auto-added tags. thanks. |
The PR is in the review queue. Pl request a merge when u reach step 4 as per the PR workflow diagram |
This is correcting one character's casing. Why does this need to jump through so many hoops? Customers are complaining about the lack of documentation for this API version because the casing conflict caused a pipeline error (which I'll keep bringing up, should either be case insensitive or the PR build should be checking this). It'd be great if there was a simplified flow for absolutely trivial fixes like this. |
/pr RequestMerge |
again, single character change that needs to go in to fix a broken pipeline. Could we please get this merged? |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
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:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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.
Getting help
and https://aka.ms/ci-fix.