Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Brackets in action #31

Closed
kafejo opened this issue Feb 3, 2016 · 1 comment
Closed

Brackets in action #31

kafejo opened this issue Feb 3, 2016 · 1 comment

Comments

@kafejo
Copy link

kafejo commented Feb 3, 2016

Let's assume endpoint and action

## Avatar [/me/avatar]
### New (update) avatar [POST]

this won't show in rendered documentation unless we remove the brackets.

## Avatar [/me/avatar]
### New update avatar [POST]

Sorry if that is a wrong repository to file an issue of that kind.

@kylef
Copy link
Member

kylef commented Feb 9, 2016

As per the API Blueprint specification, an identifier such as that used in the action may not contain brackets so this is intended.

A section definition may or must include an identifier of the section. An identifier is any non-empty combination of any character except [, ], (, ) and newline characters.

@kylef kylef closed this as completed Feb 9, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants