How to specify request headers in API Blueprint
I'm not sure if I understand what you want to achieve but I'd say that you want to specify header for request and you can do that by specifying request the same way as response. ## Offer [/offers/{offerCode}] + Parameters + offerCode: summer2015 (required, string) - alphanumeric offer code ###...
Aglio does not allow parameters in the body to be defined as parameters
rest,markdown,apiblueprint,aglio
The correct way to specify message body attributes is using the new MSON attribute syntax, which currently does not render in Aglio (but I am working on adding it). ### Create journey [POST] Create a new journey + Parameters + origin (required) - origin location of journey + Attributes +...
How do you specify request body attributes in Apiary.io / API Blueprint?
markdown,apiblueprint,apiary.io
Below is how they have probably done it. Please take a look at the API Blueprint specification at https://github.com/apiaryio/api-blueprint to know more. + Request (application/json) You can have any description here. This is based on markdown. + Even a list + `name` Name of the metaproperty, should be alphanumeric only....
Can sole resources be added to the table of contents?
This is not possible in the current Apiary interactive documentation. However we are working on the next-gen documentation where resource are indeed part of the TOC. E.g: To opt-in for the next-gen documentation beta look for the "New Documentation" switch in your API settings....
Is it possible to center tables in a markdown file?
markdown,github-flavored-markdown,apiblueprint,apiary.io
My solution detailed by Gaffney in an Apiary.io issue comment. Basically I add custom stylesheets and scripts within apiary.apib HTML blocks to style the page with HTML instead of headwalling that a Markdown dialect isn't CSS. Also "How to Center Anything in CSS"....
What is the purpose of the Host: parameter in Apiary?
HOST header states what is the final intended deployment of your API. It's used on Apiary as an upstream location for debugging proxy, and appears in code snippets as a location for requests. You can also add suffixes that are then propagated to all resources if you are not running...
How do I document a multipart request with apiary?
To create a multipart request with API Blueprint simply create a request with multipart/form-data; boundary=---BOUNDARY Content-type and use the respective boundary markers in the body asset like so: # POST /images + Request (multipart/form-data; boundary=---BOUNDARY) -----BOUNDARY Content-Disposition: form-data; name="image[file]"; filename="image.jpg" Content-Type: image/jpeg Content-Transfer-Encoding: base64 /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a...
API Blueprint resource definition not working correctly
This error is because you have defined a "Request" with no headers or body. The Parameters section belongs outside of the "Request". You can remove the Request section and add the Parameters section in the outer level as follows to remove this error: ## Inbound SMS [/api/v1/inboundSMS{?number,message,key}] ### Receive [GET]...
what is difference between spring & blueprint & router in apache camel?
apache-camel,spring-amqp,jbossfuse,apiblueprint
Spring and blueprint are dependency injection frameworks. You use them to configure all the dependencies you will use in your JBoss Fuse application (just as jms queues or java Datasources). Spring is a popular framework, whereas blueprint is OSGi-specific (that's why it is used in JBoss Fuse). A router controls...
Specify nested (object)s in Blueprint?
At the moment, MSON support in Apiary is still in beta stage. We (Apiary) are working on a nice and interactive interface for it. Please look at https://github.com/apiaryio/api-blueprint/issues/191 for more information. Thanks....
How can I use apiary with JSON-RPC
From what I understand from JSON-RPC spec and examples, multiple requests and responses could work for you better than defining POST endpoints multiple times. # My API ## JSON-RPC [/endpoint] ### Doing something [POST] + Request Sum of numbers (application/json-rpc) {"method": "sum", "params": {"a":3, "b":4}, "id":0} + Response 200 (application/json-rpc)...
Apiary: Is there a way to define options for parameters?
parameters,options,apiblueprint,apiary.io,apiary
You can enumerate the possible values of an URI query parameter and discuss it in the parameter discussion like so: + Parameters + measurement = `m` (optional, string) ... measurement units Any discussion here... e.g. explanation of **values** listed bellow are. + Values + `m` + `mi` + `yd` Also...
Apiary.io - multiple responses (200) with different parameters
rest,restful-architecture,apiblueprint,apiary.io,apiary
Nothing is wrong with your blueprint. I am afraid the Apiary Mock is rather simplistic and always returns the first response specified (content-negotiation permitting) as default. See "Invoking non-default responses" at Apiary http://support.apiary.io/knowledgebase/articles/117119-handling-multiple-actions-on-a-single-resource to see how to invoke (on demand) another response. Also note there is a proposed syntax in...
How do I get Apiary model details from the rendered documentation?
Unless you provide an example, it's just guessing, but my first guess would be wrong level of indentation. How example blueprint could look like: FORMAT: 1A HOST: http://www.google.com # Model Example Notes API is a *short texts saving* service similar to its physical paper presence on your table. # Group...
Indicate end of a group
At this point, that is not supported. You have to start a new group as in your example.
More [GET] request-response examples with different URI parameters
parameters,apiblueprint,blueprint,apiary.io,apiary
This is not currently possible with API Blueprint. But we have a feature request about this at https://github.com/apiaryio/api-blueprint/issues/58 and we are planning to implement this very soon. Thanks....
Documenting Request Payload in apiblueprint
If I understand you correctly, you are looking for a way to documen your request paramters (headers, body, etc.) If that's the case, then use the Schema section, and write a well documented JSON-Schema for example you current simple request will look like this: Request + Headers Content-Type: application/json +...
Why doesn't the Apiary Console give a correct response for this API Blueprint?
There is a tiny mistake in Blueprint in GET parameters. Parameters should be written like: {?param1,param2} (See: URI Templates) So if you just change ## Weather data [/weatherdata{?lat}{?lng}] to ## Weather data [/weatherdata{?lat,lng}] it works....
Does Apiary.io throttle responses?
From their docs: API Call Limit API calls are subject to the default limit of 15 requests per second and exceeding this limit will result in all endpoints returning an HTTP status code of 429. Limits are per API key. If the limit is exceeding then the API Key will...
apiary: Ignoring unrecognized block
rest,request,response,apiblueprint,apiary
Method names must be all-caps, as in the spec and on wire. Therefore, the "Assign access rights" line should be written as follows: ### Assign access rights [POST] ...
How To Define API Blueprint X-Auth-Token Header
You are right about not being able to define a schema for headers. Unfortunately, API Blueprint doesn't support it yet. Until something like that is supported, you can use the literal value for the header like the following: + Headers X-Auth-Token: 2e5db4a3-c80f-4cfe-ad35-7e781928f7a2 API Blueprint also does not support any Traits...
How To Show Nested Attribute Definition In Apiary.io
AFAIK it's a beta feature and the UI is not finished yet, see this github issue for more information and sneak preview of the birght future.
apiblueprint structures to achieve desired description
Seems your blueprint is not 100% correct. Please use Drafter CLI tool or Apiary.io to lint your file. As for MSON syntax – to specify a sample value of a property use: + SampleId: 123456789 (number, required) To specify a default value use: + SampleId: 123456789 (number, required) + Default:...