Skip to content

Commit cb68bb1

Browse files
sserratasserrata
authored
[Enhancement] Add support for rendering example summary as description (#285)
* Render example summary as description if it exists * Re-gen API docs
1 parent 1d2b03e commit cb68bb1

File tree

7 files changed

+29
-9
lines changed

7 files changed

+29
-9
lines changed

‎demo/docs/petstore/get-order-by-id.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values w
3030

3131
successful operation
3232

33-
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": 0,\n \"petId\": 0,\n \"quantity\": 1,\n \"shipDate\": \"2022-09-21\",\n \"status\": \"placed\",\n \"complete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"<root>\n <id>0</id>\n <petId>0</petId>\n <quantity>1</quantity>\n <shipDate>2022-09-21</shipDate>\n <status>placed</status>\n <complete>false</complete>\n</root>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
33+
</div><div><MimeTabs groupId={"mime-type"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": 0,\n \"petId\": 0,\n \"quantity\": 1,\n \"shipDate\": \"2022-09-27\",\n \"status\": \"placed\",\n \"complete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs groupId={"schema-tabs"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"<root>\n <id>0</id>\n <petId>0</petId>\n <quantity>1</quantity>\n <shipDate>2022-09-27</shipDate>\n <status>placed</status>\n <complete>false</complete>\n</root>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
3434

3535
Invalid ID supplied
3636

0 commit comments

Comments
 (0)