apiblueprint - Dangling message-body asset error -


i trying apiblueprint document apis encountering error (on line 31) says "dangling message-body asset, expected pre-formatted code block, indent every of it's line 8 spaces or 2 tabs". started seeing error after added table of contents.

if remove line (34) " ", error gone. may missing here or may not clear. on appreciable. thanks

below sample markdown.

format: 1a ---   ## [i. introduction](#def-intro) 1. [group 1](#def-g1)     1. [g1 resource 1](#def-g1-res1)     2. [g1 resource 2](#def-g1-res2) 2. [group 2](#def-g2)     1. [g2 resource 1](#def-g2-res1)     2. [g2 resource 2](#def-g2-res2) ---  <a name="def-intro"> </a> # i. introduction test api  <a name="def-g1"> </a> # 1. group 1 group 1 api  <a name="def-g1-res1"> </a> ## 1. g1 resource 1 [/g1api1] ### g1api1 [get] g1api1  + response 200 (application/json)          {             "response": "ok",             "resource": "g1api1"         }  <a name="def-g1-res1"> </a> ## 2. g1 resource 2 [/g1api2] g1api2 ### g1api2 [get]   + response 200 (application/json)          {         "response": "ok",         "resource": "g1api2"         } 

one of problems using anchors, in particular 1 right before:

2. g1 resource 2 [/g1api2]

you don't need this. if render documentation without anchors , @ left hand column, can click on links there. notice related fragment in browser address bar. can use these fragments in markdown links like:

format: 1a  # api test api  ## table of contents 1. [introduction section](#introduction/introduction-section) 1. [group 1](#reference/one)      1. [g1 resource 1](#reference/one/resource-1)     2. [g1 resource 2](#reference/one/resource-2)  ## introduction section blah blah   # group 1 group 1 api  ## resource 1 [/g1api1] ### g1api1 [get] g1api1  + response 200 (application/json)          {             "response": "ok",             "resource": "g1api1"         }  ## resource 2 [/g1api2] g1api2 ### g1api2 [get]   + response 200 (application/json)          {         "response": "ok",         "resource": "g1api2"         } 

also, read: https://apiary.io/blueprint

you should not putting numbers before "group" , "resource" keywords must come first in defining sections. apiary render short-cuts in left column , said above can re-use associated fragments in own markdown links per example above.


Comments

Popular posts from this blog

Payment information shows nothing in one page checkout page magento -

tcpdump - How to check if server received packet (acknowledged) -