0

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
yemartin
  • 73
  • 5
sixeyes
  • 483
  • 3
  • 14

1 Answers1

2

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.
Zdenek
  • 3,653
  • 27
  • 34
  • Unless I did something wrong, that didn't appear to work. `FORMAT: 1A HOST: http://test.apiblueprint.org/ # Test ## Backfeed [/api/Backfeeds] ### Single backfeed record [PUT] + Attributes (BackfeedRecord) + Request (application/json) { "UniqueReference": 4 } + Response 202 # Data Structures ## BackfeedRecord (object) If both are supplied, response id will be used ### Properties + ResponseId: 42f7b8b07 (string, optional) - Identifier for the record being updated + UniqueReference: 1 (number, optional) - The reference for the record being updated.` – sixeyes Nov 26 '15 at 14:06
  • @sixeyes can you please paste the blueprint in an answer or use a gist to link it – Zdenek Dec 07 '15 at 10:17
  • the blueprint looks OK, it is the bug in rendering – check https://github.com/apiaryio/api-blueprint/issues/191 – Zdenek Dec 08 '15 at 11:40