We’ve thought about lifecycle along the lines of software versioning, but this is a fair point.
We have actually discussed something similar to this with Jakub and as for the API Blueprint syntax we believe this will be covered by API Blueprint Traits – which essentially allows you to "tag" a section of blueprint with arbitrary metadata.
What (if any) would be the support for this in product is another question.
12 votesZ shared this idea ·
This is possible to do in the new format, but we are not displaying this properly in the old documentation.
We certainly plan to fix this and I’ll keep you posted once it’s live.
Absolutely. You can already discuss respective payload (requests, responses and models) in API Blueprint as specified here: https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#Payload – see "Example (request payload section)"
However as Lukas mentions, it is displayed in the current Apiary rendered documentation.
We are working around the clock to bring you the new, completely redesigned, documentation that will fully capture every aspect of the new format.
We have started to work on some OAuth2 support and testing it with some customers.
Current status is “very alpha”; you can only mark the whole API as being authenticated and we do not provide any support for mock server yet.
Note that this suggestion might be eventually covered by upcoming API Blueprint Format update. Please refer to http://support.apiary.io/forums/120125-general/suggestions/2970802-new-api-blueprint-format
Undocumented pre-alpha is live, but not all in-product edges are fine-tuned properly.
Please let us know (e-mail to email@example.com) if you want to use this feature, we will give you a howto.
Note that in addition to current alpha implementation this suggestion might be covered by upcoming API Blueprint Format update. Please refer to http://support.apiary.io/forums/120125-general/suggestions/2970802-new-api-blueprint-format.
We are working on http auth support as part of our blueprint overhaul.
You can already describe URI parameters in structured way with the new API Blueprint format. Refer to https://github.com/apiaryio/api-blueprint/blob/master/examples/7.%20Parameters.md for details.
The new format is now default and URI parameters are properly rendered in the documentation.
We are still working on description of http message–body properties (parameters). It is planned in the upcoming revision 1B of API Blueprint – as discussed in https://github.com/apiaryio/api-blueprint/issues/25