[Fiware] Apiary specs with Fabre : Recommendations

[JOSE MANUEL CANTERA FONSECA]

Dear friends,

I've seen that many of you are using tables for parameter or payload description. Just to let you know that is not necessary as Fabre takes care of parameter and payload rendering. So the recommended way is to enumerate parameters following the API Blueprint conventions (+ Parameters) , for instance

https://github.com/FiwareULPGC/fiware-api-blueprint-renderer/blob/master/apib-example/template-fiware-open-spec2.apib#L169

And the same with the description of the payload (+ Attributes) see

https://github.com/FiwareULPGC/fiware-api-blueprint-renderer/blob/master/apib-example/template-fiware-open-spec2.apib#L89

If you have any doubt please do not hesitate to contact me

Thanks, best


________________________________

Este mensaje y sus adjuntos se dirigen exclusivamente a su destinatario, puede contener información privilegiada o confidencial y es para uso exclusivo de la persona o entidad de destino. Si no es usted. el destinatario indicado, queda notificado de que la lectura, utilización, divulgación y/o copia sin autorización puede estar prohibida en virtud de la legislación vigente. Si ha recibido este mensaje por error, le rogamos que nos lo comunique inmediatamente por esta misma vía y proceda a su destrucción.

The information contained in this transmission is privileged and confidential information intended only for the use of the individual or entity named above. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this communication is strictly prohibited. If you have received this transmission in error, do not read it. Please immediately reply to the sender that you have received this communication in error and then delete it.

Esta mensagem e seus anexos se dirigem exclusivamente ao seu destinatário, pode conter informação privilegiada ou confidencial e é para uso exclusivo da pessoa ou entidade de destino. Se não é vossa senhoria o destinatário indicado, fica notificado de que a leitura, utilização, divulgação e/ou cópia sem autorização pode estar proibida em virtude da legislação vigente. Se recebeu esta mensagem por erro, rogamos-lhe que nos o comunique imediatamente por esta mesma via e proceda a sua destruição
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware/attachments/20150916/7b3dc939/attachment.html>