Stack Overflow
Stack Overflow

Questions tagged [apiblueprint]

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

Documentation, opensourced parser and other utilities available at http://apiblueprint.org/

250 questions
2
votes
0 answers

Document POST request with API blueprint and Apiary

I am documenting a service with API endpoints which need to be accessed with a POST request in application/x-form-urlencoded format with Apiary. The issue is, no matter how much I looked, I could not find any mention of that, or any sort of…
frogstair
  • 444
  • 5
  • 20
2
votes
0 answers

Is there a way we can auto-generate create swagger spec or api blueprint for graphql

https://api.graph.cool/simple/v1/swapi This is a sample graphql endpoint. Is there a way we can auto-generate create swagger spec or api blueprint for graphql
Veerankutty VP
  • 29
  • 2
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
1 answer

How to create object field in api-blueprint?

I am trying to document POST request with one object field and one predefined. How can I do it properly? This solution breaks the Schema after api-blueprint parsing. ### Create order [POST] Create a new order + Request Post new patient…
Daria Bulanova
  • 547
  • 1
  • 5
  • 16
2
votes
1 answer

api blueprint mson object with different values

I have a collection response which gives back an array of user objects and want to have different values for the user attributes without to create multiple user objects. Is there a way to do this? # Group Users ## Users Collection…
SteveObrian
  • 41
  • 4
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

Referencing a property inside a defined data structure in API Blueprint/MSON

I've been working with the API Blueprint format for designing an API and have had a lot of fun working with it. When I was declaring my data structures I came upon a code reuse or model reuse issue. According to the documentation when declaring a…
Arnold Balliu
  • 1,099
  • 10
  • 21
2
votes
1 answer

Api blueprint failing with dredd on a realtime api?

I am in the middle of upgrading dredd from 1.08 to the latest version, while at it, I am trying to validate our api documentation, written in blueprint with the realtime test api and it is failing. Since the tests are running against a real time…
Nauman Bashir
  • 1,732
  • 3
  • 18
  • 26
2
votes
1 answer

How to reconfigure Ambari services values with blueprint.json file

we have many Ambari LAB clusters - Apache Ambari Version 2.5.0.3 , while ambari agent installed on Linux redhat machines my target is to find a way to update the values of services , on all the Ambari clusters , by automate the process what we do…
King David
  • 500
  • 1
  • 7
  • 20
2
votes
2 answers

Dredd / apiary / MSON array of any size

we're struggling describing an array of any size in our API. Using API Blueprint and MSON format for Dredd testing. Endpoint /spots should return an array of "Spots" (those are objects). We don't know how many though. Currently we have only been…
vicdup
  • 151
  • 5
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

How to supply example value for string array parameter in api-blueprint

I'm working with this API in api-blueprint. ## Variables [/Variables{?names}] ### Retrieve the variables [GET] + Parameter + names: `First` (array[string]) - The variables names. I'm trying to set the default value for names to be multiple…
sixeyes
  • 483
  • 3
  • 14
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

How to generate API html documentation from mocha BDD tests?

I worked on a project with Spring Boot java framework where guys automated API docs generation. Every time you run BDD/Integration style tests, there was api blue print file created out from mocha tests. Then it ran generate-html-from-api blueprint.…
Centurion
  • 14,106
  • 31
  • 105
  • 197
2
votes
1 answer

How can I specify a shared Headers section across all Apiary/Blueprint API requests?

I have a large API document and each request has the same request headers like Accept: application/json and Cookies: SessionID. Is there a way I can declare these globally to avoid the duplication?
Art
  • 5,864
  • 3
  • 30
  • 32
1 2 3
…
16 17