Data Dictionaries

[zdne]

Explore possible concept of data bags for HTTP messages / API Blueprint assets.

[rurounijones]

Does this tie in with the JSON schemas? Using JSON schemas for request and response objects is immensely useful and would be even more so if we can link to them from any part of our API.

Edit, I have just read #19 and #20 which seems to be more appropriate to the above. I am therefore not sure what your image is for this issue.

[zdne]

Not directly related to JSON schemas although a JSON schema (being an asset of API blueprint) could be a part of a data dictionary.

Take this issue more like an "umbrella issue" where #19 (and maybe even #20) are a prerequisite to have separate files (data bags) where you store your payloads referenced in blueprint.

e.g. (brainstorming here):

A data bag file:

# My Payload (application/json)
+ Headers

        A:1

+ Body

        { "message" : "Hello World" }

A blueprint file:

# GET /1
+ response 200

    [My Payload][]

This is of course closely related, but not identical, to #8.

[zdne]

Closing this issue as duplicate. This issue should be addressed by Drafter apiaryio/snowcrash#57 including #8 Modularity and #19 Referenced Payloads and #20 External Assets.

[zdne]

This will be addressed with the introduction of MSON in API Blueprint. See #117 (comment)