You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When defining a schema object (which is an extended subset of the JSON Schema Specification) in the context of a OpenAPI document, a few keywords might have a different meaning than in the standard JSON Schema specification (details here). I would like to have an option to signal that my schema actually follows the OpenAPI definition at least for keywords such as readOnly and writeOnly. Also, it would be nice to have additional keywords such as nullable and externalDocs be taken into account while rendering the Markdown file.
Actual Behaviour
Keywords such as readOnly and writeOnly can only follow the definition specified in the JSON Schema draft 2019-09. If a definition would look like this:
it MAY be sent as part of a response but SHOULD NOT be sent as part of the request.
Therefore, the property being marked as Optional (as well as the text in the Access Restrictions section) gives the wrong impression that the API actually allows it to be passed by the user.
Reproduce Scenario
Steps to Reproduce
Platform and Version
MacOS
jsonschema2md v6.1.0
Sample Code that illustrates the problem
Logs taken while reproducing problem
The text was updated successfully, but these errors were encountered:
Expected Behaviour
When defining a schema object (which is an extended subset of the JSON Schema Specification) in the context of a OpenAPI document, a few keywords might have a different meaning than in the standard JSON Schema specification (details here). I would like to have an option to signal that my schema actually follows the OpenAPI definition at least for keywords such as
readOnly
andwriteOnly
. Also, it would be nice to have additional keywords such asnullable
andexternalDocs
be taken into account while rendering the Markdown file.Actual Behaviour
Keywords such as
readOnly
andwriteOnly
can only follow the definition specified in the JSON Schema draft 2019-09. If a definition would look like this:It would give the following output file:
Even though, for this schema
readOnly
means:Therefore, the property being marked as Optional (as well as the text in the Access Restrictions section) gives the wrong impression that the API actually allows it to be passed by the user.
Reproduce Scenario
Steps to Reproduce
Platform and Version
MacOS
jsonschema2md v6.1.0
Sample Code that illustrates the problem
Logs taken while reproducing problem
The text was updated successfully, but these errors were encountered: