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
{{ message }}
This repository has been archived by the owner on Jan 15, 2022. It is now read-only.
I have the following API Blueprint (just a snippet):
...
### Initiate sign-up [POST /v1/users/signup]
+ Attributes (object)
+ state_id (number)
+ count_id (number)
+ elements (array[Element], fixed-type)
+ Request (application/json)
{
"state_id": 27,
"count_id": 10,
"elements": [
{
"id": 1,
"status": true,
"facts": [
"fact1",
"fact2",
"etc"
]
}
]
}
...
# Data Structures
## Element (object)
+ id: 1 (number) - Element id
+ status: true (boolean) - Whether the particular element is present or not
+ facts: [""] (array[string]) - Supporting facts for the elements with the "status: true"
Initially elements in the JSON schema has not been expanded at all, and has been rendered as "elements": "array", unless I added the fixed-type as mentioned at #40.
Now JSON schema includes the Element type definition, although description is missing, i.e. this how Snowboard renders it:
See the description I highlighted. In various examples, on the internet, I see that JSON Schema supports this extra description field in the output, but Snowboard doesn't display it.
I expect as you already parsed the Data Structures block (as Element type has been processed), it should be not difficult to access the description of the field and put it into the JSON schema definition.
The text was updated successfully, but these errors were encountered:
zshamrock
changed the title
Description is not displayed in the schema defition
Description is not displayed in the JSON schema defition
Jul 28, 2020
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
I have the following API Blueprint (just a snippet):
Initially
elements
in the JSON schema has not been expanded at all, and has been rendered as"elements": "array"
, unless I added thefixed-type
as mentioned at #40.Now JSON schema includes the
Element
type definition, althoughdescription
is missing, i.e. this how Snowboard renders it:And this how Apiary renders it:
See the
description
I highlighted. In various examples, on the internet, I see that JSON Schema supports this extradescription
field in the output, but Snowboard doesn't display it.I expect as you already parsed the
Data Structures
block (asElement
type has been processed), it should be not difficult to access thedescription
of the field and put it into the JSON schema definition.The text was updated successfully, but these errors were encountered: