apiblueprint - Trying to describe the request and response using Data Structures in API Blueprint -


i'm trying document endpoint api blueprint, using new attributes , datastructures sections of spec.

my request payload looks this:

{     "url": "http://requestb.in/11v7i7e1",     "active": true,     "types": [         {             "name": "sales",             "version": "2.0"         },         {             "name": "products",             "version": "2.0"         }     ] }

my response payload looks that:

{   "data": {     "id": "dc85058a-a683-11e4-ef46-e9431a15be8c",     "url": "http://requestb.in/11v7i7e1",     "active": true,     "types": [       {         "name": "products",         "version": "2.0"       },       {         "name": "sales",         "version": "2.0"       }     ]   } }

i tried following api blueprint markdown:

format: 1a  # vend rest api 2.0  # group webhooks  ## api/2.0/webhooks [/webhooks]  ### list webhooks [get] returns list of webhooks created authorised application.  + response 200 (application/json)     + attributes (webhook collection)  ### add new webhook [post] creates new webhook.  + attributes (webhook base)  + request (application/json)     + attributes (webhook base)  + response 200 (application/json)     + attributes (webhook response)  # data structures  ## webhook base (object) + url: https://example.com/webhook (string, required) - address webhooks requests should submitted. + active: true (boolean, required) - field can used inspect or edit state of webhook. + types: array[webhook type] (array[webhook type], required) - collection of webhook types should trigger webhook event.  ## webhook response base (webhook base) + id: dc85058a-a683-11e4-ef46-e8b98f1a7ae4 (string, required) - webhook `id`.  ## webhook response (object) + data: webhook (webhook response base, required)  ## webhook type (object) + name: sales (string, required) - 1 of: products, sales, customers, taxes + version: 2.0 (string, required) - version of payload delivered. supported value "2.0".  ## webhook collection (object) + data: array[webhook response base] (array[webhook response base], required) - array of webhook objects.

now, when looking @ in apiary, tells me valid api blueprint document, doesn't how me json previews request , response. structures possible represent in api blueprint , able render nicely in apiary?

this combination of 2 problems:

  1. incorrect syntax
  2. bug in rendering

1. syntax

the problem seems here:

## webhook collection (object) + data: array[webhook response base] (array[webhook response base], required) - array of webhook objects.

looking @ + data: array[webhook response base] (array[webhook response base]). basicaly when value expected (after :) value should provided. instead – in case – have there type array[webhook response base].

let me demonstrate on simpler example: 

+ data: number (array[number])

is incorrect.

correct version be

+ data: 42 (array[number])

or

+ data (array[number])     + 42

or

+ data (array)     + 42 (number)

2. bug in rendering

even if correct blueprint won't rendered in apairy. bug have discovered in our json renderer. has been reported here https://github.com/apiaryio/drafter.js/issues/26 plan fix asap.

this has been fixed now

corrected blueprint

format: 1a  # vend rest api 2.0  # group webhooks  ## api/2.0/webhooks [/webhooks]  ### list webhooks [get] returns list of webhooks created authorised application.  + response 200 (application/json)     + attributes (webhook collection)  ### add new webhook [post] creates new webhook.  + attributes (webhook base)  + request (application/json)     + attributes (webhook base)  + response 200 (application/json)     + attributes (webhook response)  # data structures  ## webhook base (object) + url: https://example.com/webhook (string, required) - address webhooks requests should submitted. + active: true (boolean, required) - field can used inspect or edit state of webhook. + types (array[webhook type], required) - collection of webhook types should trigger webhook event.  ## webhook response base (webhook base) + id: dc85058a-a683-11e4-ef46-e8b98f1a7ae4 (string, required) - webhook `id`.  ## webhook response (object) + data (webhook response base, required)  ## webhook type (object) + name: sales (string, required) - 1 of: products, sales, customers, taxes + version: 2.0 (string, required) - version of payload delivered. supported value "2.0".  ## webhook collection (object) + data (array[webhook response base], required) - array of webhook objects.

hope answers question. please let me know if further clarification needed.


-

Popular posts from this blog

c# - ODP.NET Oracle.ManagedDataAccess causes ORA-12537 network session end of file -

overview i want replace oracle.dataaccess orcale. managed dataaccess, opening connection latter throws ora-12537 network session end of file exception. exception message / stack trace {oracleinternal.network.networkexception (0x000030f9): ora-12537 : netzwerksession: dateiende @ oracleinternal.network.readerstream.read(orabuf ob) @ oracleinternal.ttc.orabufreader.getdatafromnetwork() @ oracleinternal.ttc.orabufreader.read(boolean bignoredata) @ oracleinternal.ttc.marshallingengine.unmarshalub1(boolean bignoredata) @ oracleinternal.ttc.ttcprotocolnegotiation.readresponse()} i trying connect oracle 11g database , not have client installed on local machine. working test application (unmanaged) using oracle.dataaccess works fine . using system; using oracle.dataaccess.client; namespace app.odp.unmanaged { internal class program { private static void main(string[] args) { //dummy connection string...
Read more

matlab - Compression and Decompression of ECG Signal using HUFFMAN ALGORITHM -

i want compress , decompress ecg signal stored text message text file , find out file size, cr,prd ratio,and qs. here code compression , decompression of ecg signal using huffman algorithm. i'm trying find out file size, compression ratio,prd ratio,qs. but error i'm getting the ecg file in text format. %clearing variables , screen enter code here clear all; close all; clc; [file1]=uigetfile('*.txt'); %fprintf('enter ecg file name :%s',file1); p=file1; t=sprintf('%s',p); b1=dlmread([file1]); len=length(b1); lead=input('enter lead number :'); %lead=str2double(lead); col2=b1(1:end,lead); e=fix(sqrt(len)); m=1; i=1:e j=1:e g2(i,j)=fix(col2(m)*1000); %amplifying 1000 m=m+1; end end g3=g2; i=1:e j=1:e ...
Read more

utf 8 - split utf-8 string into bytes in python -

i trying split utf-8 string bytes in python 3. problem is, when use bytearray, byte, encode etc functions array size of element 14 bytes, not 1 byte expected. need split text file sequence of bytes , send them byte after byte using sockets. tried this: infile = open (file, "r") str = infile.read() byte_str = bytes(str, 'utf-8') print("size of byte_str",sys.getsizeof(byte_str[0])) print gives me 14, need 1... suggestion? quoting official documentation : sys.getsizeof(object[, default]) return size of object in bytes. object can type of object. built-in objects return correct results, not have hold true third-party extensions implementation specific. only memory consumption directly attributed object accounted for, not memory consumption of objects refers to. if given, default returned if object not provide means retrieve size. otherwise typeerror raised. getsizeof() calls object’s __sizeof__ method , adds ...
Read more