We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Rendering an API Blueprint document to OpenAPI3 with flag --open-api-3 converts a custom type like this:
--open-api-3
## MyType (object) + id: `4711` (required, string) + someProperty (required, nullable, object) + someList (required, array) + (object) + id: `some example`(required, string)
into this:
MyType: type: object required: - id - someProperty properties: id: type: string example: 4711 someProperty: type: object nullable: true required: - someList properties: someList: type: array items: type: object required: - id properties: id: type: string example: some example
results in:
MyType: type: object required: - id - someProperty properties: id: type: string someProperty: type: object required: - someList properties: someList: type: array items: {} nullable: true
Please note the missing definition in line 16 and the missing example values.
The text was updated successfully, but these errors were encountered:
Thank you for reporting!
I have implemented example conversion at v1.15.0.
For the missing definition, we should use fixed-type attribute. e.g.
fixed-type
## MyType (object) + id: `4711` (required, string) + someProperty (required, nullable, object) + someList (required, array, fixed-type) + (object) + id: `some example`(required, string)
MyType: type: object required: - id - someProperty properties: id: type: string example: '4711' someProperty: type: object required: - someList properties: someList: type: array items: type: object required: - id properties: id: type: string example: some example nullable: true
Sorry, something went wrong.
Looks good to me!
No branches or pull requests
Nominal
Rendering an API Blueprint document to OpenAPI3 with flag
--open-api-3
converts a custom type like this:into this:
Actual
Rendering an API Blueprint document to OpenAPI3 with flag
--open-api-3
converts a custom type like this:results in:
Please note the missing definition in line 16 and the missing example values.
The text was updated successfully, but these errors were encountered: