Can I use reference syntax for arbitrary text?

[chriswu000]

Hi all,

Thanks for a great project! I'm using apiary for our api docs and I'm loving it so far. Question though: I have a url root that I don't want to copy and paste every time I refer to it. Is there anyway to reference it within a Model? Something like this?

# Some section with references in it
    [DOC_ROOT]: "http://www.mydoc.com"

## Loan Instance [/loans/{id}]

+ Parameters
    + id (required, number, `42`)

+ Model (application/hal+json)

        {
            "documentation": "#{DOC_ROOT}/something_specific.html",
            "var1": 1
         }

So when we look at a response in the documention, we would see:

{
    "documentation": "http://www.mydoc.com/something_specific.html",
    "var1": 1
}

Thanks for your help.

[zdne]

@chriswu000 This is currently not possible. I am trying to keep assets (markdown code blocks - or data "blobs" if you will) in API Blueprint atomic from the parser's point of view.

Otherwise you will have to escape some sequences in every asset which would lead to serious problems (remember its not only JSON out there).

Lately I have been thinking this might be possible by explicitly marking the assets that can (should) be expanded.

I would love to put more thoughts into this, so your feedback us much appreciated!

[chriswu000]

@zdne Thanks for your reply. I'm just starting with api-blueprint as well as markdown, so I don't have any in depth opinions to provide. However, if I think of anything I'll be sure to let you know. Thanks again for a great product!

[zdne]

Currently there is no plan to add constructs to the language to define and reference arbitrary text. When it comes to HTTP message bodies, this should be addressed by the introduction of MSON into API Blueprint. See #117 (comment)