apiblueprint - How do I get Apiary model details from the rendered documentation? -



apiblueprint - How do I get Apiary model details from the rendered documentation? -

i have api contract defined in apiary , i'm using resource model syntax enable reuse of payloads.

the documentation rendered apiary shows model name though (eg response 200 returns [foo][]) - without farther details on foo is, or link view attributes in foo model.

given model, how see attributes in rendered documentation?

update relevant part of contract below:

### manipulating specific organisation [/organisations/{id}] operations retrieve , update specific organisation. + parameters + id (required, guid, `f339ada5-e836-40fe-8e90-bef06892762e`) ... guid organisation `id`. + model (application/json) + headers link : <http://foobar.com/organisations/f339ada5-e836-40fe-8e90-bef06892762e>;rel="self" + body { "id" : "f339ada5-e836-40fe-8e90-bef06892762e", "name" : "joe's gardening supplies" } ### retrieve organisation [get] + response 200 [organisation][] ### update organisation [patch] + request [organisation][] + response 204

unless provide example, it's guessing, first guess wrong level of indentation. how illustration design like:

format: 1a host: http://www.google.com # model illustration notes api *short texts saving* service similar physical paper presence on table. # grouping notes notes related resources of **notes api** ## note [/notes/{id}] single note object details + parameters + id (required, number, `1`) ... numeric `id` of note perform action with. has illustration value. + model + header x-my-header: value + body { "id": 2, "title": "pick-up posters post-office" } ### retrieve note [get] + response 200 (application/json) [note][] ### remove note [delete] + response 204

code above results in this documentation, model correctly incorporated on places it's referenced (and such reference supported - i.e. definition of payload).

sometimes it's helpful read raw version of apiary's docs on github, because it's easier spot right, exact format way.

apiblueprint apiary.io

Comments

Post a Comment

Popular posts from this blog

model view controller - MVC Rails Planning -

model view controller - MVC Rails Planning - i'm starting rails , i'm building app stores films info, user can watch film , give grade on web application. i have coded cinema model, controller , views. now, have 2 questions: should need create model , controller grading? in case, should create or should wait , create first users model , controller? yes, on model , controller grades. that'd feasible way maintain track of who's graded what. it's create first, i'd start users, since grades depend on both films , users. ruby-on-rails model-view-controller
Read more

ruby on rails - Devise Logout Error in RoR -

ruby on rails - Devise Logout Error in RoR - while using devise in ror, encountering unusual error when trying log out url different root url. displays me : actioncontroller::invalidauthenticitytoken in devise::sessionscontroller#destroy" for illustration if rooting path after log in '/structure', , seek log out '/general' error, while logging out '/structure' fine. any help highly appreciated. ruby-on-rails ruby devise
Read more

html - Submenu setup with jquery and effect 'fold' -

html - Submenu setup with jquery and effect 'fold' - i want open submenu jquery effect fold, problem if user "hover effect" fast menu remain open, how can avoid this, jquery code is: $('ul.mainmenu li').hover( function() { $(this).children('ul').show('fold', 570); }, function() { $(this).children('ul').hide('fold', 500); } ); my jsfiddle link is: http://jsfiddle.net/9wkbf/ updated fiddle the reason behind problem is, first event $(this).children('ul').show('fold', 570); queued , until completes, sec animation not start. the next snippet can workaround $('ul.mainmenu > li').hover( function() { $(this).children('ul').show('fold', 570); }, function() { $('ul:not(.mainmenu)').hide('fold', 500); } ); *important note : work current scenario. jquery html css
Read more