Separating public from private api?


#1

My client wants to separate the private parts of their api from the public parts in their documentation and I was wondering if there is an easy way to segregate the actions on the RAML specification into private/public groups? I thought about using the description field to ‘code’ some marker into it, but that doesn’t feel as a sustainable solution.

Are there idea’s to add tags to RAML on the level of the actions? Documentation generators could then use those tags to include or exclude certain parts of the api.


#2

Hi @Peter_Rigole,

What you are looking for is coming in RAML 1.0. You will have the ability to annotate HTTP methods with your defined metadata that can be picked up by a generator as you said.

Hope that helps.

Cheers,
Christian