search

apiaryio / api-elements

API Elements is a structure for describing APIs and the complex data structures used within them.
http://apielements.org/
MIT License
28 stars 10 forks source link

[docs] Converted the spec into refract v1.0 serialization #22

Closed pksunkara closed 7 years ago

pksunkara commented 7 years ago

I did a bit more thinking today and finalised the document from my side. The serialisation guidelines I followed are:

  1. element of an element value should always be serialised as string
  2. meta & attribute of an element value should always be serialised as object
  3. content of an element can be string, number, boolean, array or object based on the element
  4. Everything else is fully serialised as an element
pksunkara commented 7 years ago

This needs a careful look over once refract v1 is released.

kylef commented 7 years ago

Seems that the threading for some of the comments in my review didn't show up in the correct place. Just a note if some of the comments look out of place.