Skip to content

Instantly share code, notes, and snippets.

@zdne
Last active December 21, 2015 10:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save zdne/6292831 to your computer and use it in GitHub Desktop.
Save zdne/6292831 to your computer and use it in GitHub Desktop.
Testing new API Blueprint parameters syntax

Full-featured

NOTE: Colons are optional. Keywords are case insensitive.

  • Parameters

    • id

      Lorem ipsum dolor sit amet, consectetur adipiscing elit. In molestie justo eget diam vulputate rutrum. Donec ultrices est sed scelerisque lacinia. In vitae consectetur mauris.

      • Type: number
      • Optional | Required
      • Default: 1234
      • Example: 0000
      • Values
        • 1234
        • 5678
        • 0000
        • 1111
        • 2222
        • 3333

Full-featured abbreviated syntax

  • Parameters

    • id = 1234 (number, optional) ... Lorem ipsum dolor sit amet, consectetur adipiscing elit. In molestie justo.

      • Example: ABCD
      • Values
        • 1234
        • 5678
        • 0000
        • 1111
        • 2222
        • 3333
{
"parameters": {
"id": {
"name": "id",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In molestie justo
eget diam vulputate rutrum. Donec ultrices est sed scelerisque lacinia.
In vitae consectetur mauris.",
"type": "number",
"required": "false",
"default": 1234,
"example": 0000,
"values": [
1234,
5678,
0000,
1111,
2222,
3333
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment