Azure / Azure/azure-openapi-validator

Linter seems to complain about secret properties from the PUT request misisng from the GET response

Open
#739 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

**Describe the bug**

If I correctly understood the cause of the linter warning,
this isn't really a bad thing that needs warnings,
since its a secret property (look for "x-ms-secret"):

https://github.com/Azure/azure-rest-api-specs-pr/blob/df5a3d3ae66802afb6c00cca11a42487d5eae2a0/specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-09-01-preview/swagger.json#L1269

❌ PutRequestResponseSchemeArm | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ApiKeys_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema'Location: NGINX.NGINXPLUS/preview/2024-09-01-preview/swagger.json#L30 | RPC-Put-V1-25
-- | -- | --
❌ PutRequestResponseSchemeArm | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Configurations_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema'Location: NGINX.NGINXPLUS/preview/2024-09-01-preview/swagger.json#L558 | RPC-Put-V1-2

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.