Stack Overflow
Stack Overflow

Questions tagged [aglio]

aglio is a renderer for the API Blueprint language. It supports themes and outputs static HTML which can be served by any web host.

aglio is a for the language. It supports and outputs static which can be served by any web host. For questions on API Blueprint's markdown-based document format please use the tag itself.

aglio is available on GitHub.

24 questions
6
votes
1 answer

Use pattern in API Blueprint / MSON

I'm investigating the possibilities of the new Data Structures syntax in API Blueprint, especially MSON. Is it possible to attach or rather specify something like a pattern (regex)? Don't found anything on this topic.
loxy
  • 373
  • 3
  • 9
6
votes
3 answers

How to reuse objects in schema of API BluePrint?

I have created an API that delivers a resource named "Thumbnail" (/thumbnails) { "name": "toto", "uri": "http://xxx" } In other hand I have multiple resources that includes that Thumbnail resource in them (like /articles, /videos ...): { …
Stéphane Pessin
  • 79
  • 1
  • 3
5
votes
1 answer

How to reference enum value in API Blueprint(MSON)

I'm using API Blueprint and Agilo to render my API documentation. When using enum type, I'm observing a weird behavior. The response is not shown with the defined enum value whereas the schema is showing all the enum values (which is expected) along…
Haran
  • 1,040
  • 2
  • 13
  • 26
3
votes
1 answer

Rendering attributes on aglio?

I'm new to aglio I was trying to render attributes for my documentation, but it does not work. ## Modify User [/users/{id}.json?{token}=API_TOKEN] Modify any accessible fields if authorized ### Modify User [PUT] + Parameters + id: 1 (required,…
Jonathan Bouchard
  • 423
  • 1
  • 4
  • 15
3
votes
0 answers

Errors trying to install aglio with node.js

I am running Node.js 0.10.36 on my windows 7 machine. I also have grunt v0.4.5 and grunt-cli v0.1.13 installed. Python is 2.7.3 and Microsoft Visual studio is 2012. I am trying to install aglio globally. The command I run is npm install -g…
OrwellHindenberg
  • 4,988
  • 8
  • 38
  • 58
2
votes
1 answer

api-blueprint does not show nested "One of" attributes correctly

This is my api blueprint file: FORMAT: 1A # system API These endpoints are use to get contents from the system crawler ## Get posts [/posts/{?publish_gte,publish_lte,publish_gt,publish_lt,page,page_size}] ### Get posts which crawled [GET] You…
Emad Helmi
  • 652
  • 8
  • 25
2
votes
0 answers

API Blueprint Data Structures Enum Output to Schema

I have defined an Enum at Data Structures and then compile with aglio. The output schema somehow adds a null. How can I get rid of that null? ## StatusType (enum[string]) + Verified + Unverified + VerifiedLikely + Invalid But at the generated…
angelokh
  • 9,426
  • 9
  • 69
  • 139
2
votes
1 answer

Aglio builder does not put object to schema if this object was defined as an array option

Here I'm defining a property in object Page Index called chartControllers which must be an array of objects called chartController. # Page Index (Page Base) - bundle: `site-index` (string, required) - название страницы на фронтенде - nav…
Andrey Ponomarenko
  • 553
  • 7
  • 20
2
votes
1 answer

Can I live reload styles, templates, and variables with Aglio?

I am unable to live-reload LESS and Jade files using Aglio's --server option or gulp paired with connect's livereload option and the gulp-aglio plugin. Is this due to caching? Or a limitation of connect's live reload capability? The only way to make…
jchook
  • 6,690
  • 5
  • 38
  • 40
2
votes
1 answer

Primitive type as data structure for API Blueprint

I want to use primitive type for describe data structure. Like so: # Data Structures ## Video Delete (enum[number]) + `0` - Successful deletion. + `1` - Error occured. And the output is. { "enum": [ 1, 0 ], "$schema":…
witzawitz
  • 416
  • 1
  • 5
  • 11
2
votes
1 answer

Data abstraction in API Blueprint + Aglio?

Reading the API Blueprint specification, it seems set up to allow one to specify 'Data Structures' like: Address street: 100 Main Str. (string) - street address zip: 77777-7777 (string) - zip / postal code ... Customer: handle: mrchirpy…
zanerock
  • 3,042
  • 3
  • 26
  • 35
1
vote
1 answer

Error when Trying to install aglio with npm

npm WARN This failure might be due to the use of legacy binary "node" npm WARN For further explanations, please read /usr/share/doc/nodejs/README.Debian npm ERR! Error: ENOENT, lstat…
kyty
  • 76
  • 1
  • 9
1
vote
2 answers

How to override MSON Sample values

If I define a resource type with sample values, how can I override them for specific examples? I tried this, but the rendered output ignores the Body and uses the global Sample instead. ### Read item [GET] + Response 200 + Attributes (A,…
OrangeDog
  • 36,653
  • 12
  • 122
  • 207
1
vote
0 answers

How to extend rather than replace parent Parameters?

I've got a resource with multiple parameters, and a single action with one extra. How can I write this with the minimal repeats? Something like this, but that actually works: ## Items [/item{?type}] + Parameters + type (enum[string], optional) …
OrangeDog
  • 36,653
  • 12
  • 122
  • 207
1
vote
1 answer

Aglio Render Markdown after Request / Response section

Here's a snippet of my apib document. Essentially, I want to be able to put additional descriptive information after the Request and Response sections, however this information is not rendered. Instead any further text under a new heading is…
Cameron Lonsdale
  • 13
  • 2
1
2