Search code examples
data-structuresmarkdownapiblueprintapiary.io

Adding comments to data structure in API Blueprint

I have two properties, one of which must be supplied. I was trying to add a comment at the bottom of the data structure but it was ignored. So I tried a multi line description but that was also ignored:

# Data Structures

## Record (object)

+ ResponseId: `42f7b8b07da641bcb6d96422cb903c0e` (string, optional) - Identifier for the record being updated
+ UniqueReference: 1 (number, optional) - Reference for the record being updated.

    If both are supplied, response id will be used
Solution

  • Add the description to the top and use member type separator to separate it from the member properties.

    Eg.

    # Data Structures

## Record (object)

If both are supplied, response id will be used

### Properties

- ResponseId: 42f7b8b07da641bcb6d96422cb903c0e (string, optional) - Identifier for the record being updated
- UniqueReference: 1 (number, optional) - Reference for the record being updated.