Azure / Azure/oav

Missing Required 'ID' during example generation

Open
#884 1 comment 0 reactions 1 assignee Claimed by @ankhyk View on GitHub
enhancement P2
Dominant language
TypeScript
Stars
104
Forks
62
Avg merge
2d 12h
Merged PRs (30d)
5

Description

Hello, I am trying to use OAV to generate swagger json examples. I noticed that it generates two sets of examples - MaximumSet_Gen and MinimumSet_Gen. During the example validation, it complains that id is missing in the response of Get/Put resource operations. I believe id is not required.
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#response-object

Another question is, can we choose to not generate two sets of example jsons?

`{
code: 'MISSING_RESOURCE_ID',
message: 'id is required to return in response of GET/PUT resource calls but not being provided',
schemaUrl: .json',
exampleUrl: '_MinimumSet_Gen.json',
schemaPosition: { line: 3282, column: 46 },
schemaJsonPath: '#/x-ms-azure-resource',
examplePosition: { line: 22, column: 15 },
exampleJsonPath: '$responses.201.body',
severity: 0,
source: 'response',
operationId: 'XXX_CreateOrUpdate',
level: 'error',
}`

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.