{"_id":"546e452b0f33a80800f5854d","sync_unique":"","type":"basic","githubsync":"","hidden":false,"slug":"getting-started","body":"We're currently using a subset of the apiDoc format. You can find out more about it on the [apiDoc](http://apidocjs.com/) website.\n\nIt supports almost every language, and allows you to document your API inline and keep things synced.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"THIS IS STILL IN BETA!\",\n  \"body\": \"At any point in time, things here may change. We'll do our best not to break anything (and will email you if we do), but keep that in mind.\"\n}\n[/block]","link_external":false,"order":0,"title":"Introduction","category":"546e452a0f33a80800f5854b","createdAt":"2014-11-20T19:46:51.591Z","project":"546e452a0f33a80800f58547","updates":[],"user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","__v":4,"api":{"settings":"","try":true,"url":"","auth":"never","basic_auth":false,"params":[],"results":{"codes":[]}},"excerpt":"This page will help you get started with readme-sync. You'll be up and running in a jiffy!","link_url":"","childrenPages":[]}

Introduction

This page will help you get started with readme-sync. You'll be up and running in a jiffy!

We're currently using a subset of the apiDoc format. You can find out more about it on the [apiDoc](http://apidocjs.com/) website. It supports almost every language, and allows you to document your API inline and keep things synced. [block:callout] { "type": "danger", "title": "THIS IS STILL IN BETA!", "body": "At any point in time, things here may change. We'll do our best not to break anything (and will email you if we do), but keep that in mind." } [/block]
We're currently using a subset of the apiDoc format. You can find out more about it on the [apiDoc](http://apidocjs.com/) website. It supports almost every language, and allows you to document your API inline and keep things synced. [block:callout] { "type": "danger", "title": "THIS IS STILL IN BETA!", "body": "At any point in time, things here may change. We'll do our best not to break anything (and will email you if we do), but keep that in mind." } [/block]
{"_id":"546e5d00bf547f5a5ab38a2d","hidden":false,"link_external":false,"link_url":"","slug":"other-formats","user":"5250b3ad5ac09b3564000005","excerpt":"","sync_unique":"","version":"546e452a0f33a80800f5854a","__v":3,"body":"Eventually, we're aiming to support some of the following:\n\n  * Swagger\n  * Blueprint\n  * RAML\n\nCurrently, though, we only support apiDoc.\n\n## Why apiDoc first?\n\nWe looked at a lot of different formats (including possibly making our own), however picked apiDoc for the following reasons:\n\n  * **Closely coupled** Having the source inline (unlike Blueprint or RAML's separate files) means it's more likely to be kept updated.\n  * **Language Support** It works with every language out of the box, which makes things easy\n  * **Simple** It takes a few minutes to understand, whereas things like Swagger are incredibly complex. \n  * **Straightforward** apiDoc is very limited in scope (while still covering everything); trying to support everything Swagger/etc does would be overly complicated\n  * **Static docs** Unlike swagger, the code can be indexed without having to run it. This makes it so you can set-and-forget via GitHub connect, rather than having to generate the output locally and committing that.","createdAt":"2014-11-20T21:28:32.082Z","githubsync":"","order":1,"project":"546e452a0f33a80800f58547","api":{"basic_auth":false,"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"try":true,"url":"","auth":"never"},"category":"546e452a0f33a80800f5854b","title":"Other formats","type":"basic","updates":[],"childrenPages":[]}

Other formats


Eventually, we're aiming to support some of the following: * Swagger * Blueprint * RAML Currently, though, we only support apiDoc. ## Why apiDoc first? We looked at a lot of different formats (including possibly making our own), however picked apiDoc for the following reasons: * **Closely coupled** Having the source inline (unlike Blueprint or RAML's separate files) means it's more likely to be kept updated. * **Language Support** It works with every language out of the box, which makes things easy * **Simple** It takes a few minutes to understand, whereas things like Swagger are incredibly complex. * **Straightforward** apiDoc is very limited in scope (while still covering everything); trying to support everything Swagger/etc does would be overly complicated * **Static docs** Unlike swagger, the code can be indexed without having to run it. This makes it so you can set-and-forget via GitHub connect, rather than having to generate the output locally and committing that.
Eventually, we're aiming to support some of the following: * Swagger * Blueprint * RAML Currently, though, we only support apiDoc. ## Why apiDoc first? We looked at a lot of different formats (including possibly making our own), however picked apiDoc for the following reasons: * **Closely coupled** Having the source inline (unlike Blueprint or RAML's separate files) means it's more likely to be kept updated. * **Language Support** It works with every language out of the box, which makes things easy * **Simple** It takes a few minutes to understand, whereas things like Swagger are incredibly complex. * **Straightforward** apiDoc is very limited in scope (while still covering everything); trying to support everything Swagger/etc does would be overly complicated * **Static docs** Unlike swagger, the code can be indexed without having to run it. This makes it so you can set-and-forget via GitHub connect, rather than having to generate the output locally and committing that.
{"_id":"546e6fdfbf547f5a5ab38a2f","excerpt":"","link_external":false,"sync_unique":"","title":"Full Example","type":"basic","version":"546e452a0f33a80800f5854a","api":{"basic_auth":false,"try":true,"params":[],"url":"","auth":"never","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2014-11-20T22:49:03.829Z","slug":"full-example","user":"5250b3ad5ac09b3564000005","__v":0,"body":"Here's what it might look like to use all the supported apiDoc parameters.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id Request User information\\n * @apiName GetUser\\n * @apiGroup User\\n *\\n * @apiParam {Number} id Users unique ID.\\n *\\n * @apiExample {shell} Example usage:\\n *     curl -i http://localhost/user/4711\\n *\\n * @apiSuccessExample {json} 200 Success-Response\\n *     HTTP/1.1 200 OK\\n *     {\\n *       \\\"firstname\\\": \\\"John\\\",\\n *       \\\"lastname\\\": \\\"Doe\\\"\\n *     }\\n \\n  * @apiErrorExample {json} 404 Error-Response\\n *     HTTP/1.1 404 Not Found\\n *     {\\n *       \\\"error\\\": \\\"UserNotFound\\\"\\n *     }\\n */\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"546e452a0f33a80800f5854b","githubsync":"","link_url":"","project":"546e452a0f33a80800f58547","hidden":false,"order":2,"updates":[],"childrenPages":[]}

Full Example


Here's what it might look like to use all the supported apiDoc parameters. [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id Request User information\n * @apiName GetUser\n * @apiGroup User\n *\n * @apiParam {Number} id Users unique ID.\n *\n * @apiExample {shell} Example usage:\n * curl -i http://localhost/user/4711\n *\n * @apiSuccessExample {json} 200 Success-Response\n * HTTP/1.1 200 OK\n * {\n * \"firstname\": \"John\",\n * \"lastname\": \"Doe\"\n * }\n \n * @apiErrorExample {json} 404 Error-Response\n * HTTP/1.1 404 Not Found\n * {\n * \"error\": \"UserNotFound\"\n * }\n */", "language": "javascript" } ] } [/block]
Here's what it might look like to use all the supported apiDoc parameters. [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id Request User information\n * @apiName GetUser\n * @apiGroup User\n *\n * @apiParam {Number} id Users unique ID.\n *\n * @apiExample {shell} Example usage:\n * curl -i http://localhost/user/4711\n *\n * @apiSuccessExample {json} 200 Success-Response\n * HTTP/1.1 200 OK\n * {\n * \"firstname\": \"John\",\n * \"lastname\": \"Doe\"\n * }\n \n * @apiErrorExample {json} 404 Error-Response\n * HTTP/1.1 404 Not Found\n * {\n * \"error\": \"UserNotFound\"\n * }\n */", "language": "javascript" } ] } [/block]
{"_id":"546e7996a94f55cd7355426e","version":"546e452a0f33a80800f5854a","createdAt":"2014-11-20T23:30:30.772Z","slug":"testing-locally","body":"Before setting up GitHub Sync, you may want to test it locally. This will also help with debugging, since currently there are no tools on ReadMe for seeing what went wrong.\n\n## Installation\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm install apidoc -g\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n## Running\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"apidoc && cat ./doc/api_data.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThis will write the output to `./doc/`, and print out the results. ReadMe reads the file `./doc/api_data.json`, and ignores everything else.\n\n(Note: There will be some other data in it that we ignore.)\n\nWithout any parameter, apiDoc generate a documentation from all .cs .dart .erl .go .java .js .php .py .rb .ts file. If you need other files, contact us!","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"api":{"auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"try":true,"url":""},"updates":[],"project":"546e452a0f33a80800f58547","title":"Testing Locally","excerpt":"","sync_unique":"","type":"basic","__v":4,"category":"546e452a0f33a80800f5854b","user":"5250b3ad5ac09b3564000005","childrenPages":[]}

Testing Locally


Before setting up GitHub Sync, you may want to test it locally. This will also help with debugging, since currently there are no tools on ReadMe for seeing what went wrong. ## Installation [block:code] { "codes": [ { "code": "npm install apidoc -g", "language": "text" } ] } [/block] ## Running [block:code] { "codes": [ { "code": "apidoc && cat ./doc/api_data.json", "language": "text" } ] } [/block] This will write the output to `./doc/`, and print out the results. ReadMe reads the file `./doc/api_data.json`, and ignores everything else. (Note: There will be some other data in it that we ignore.) Without any parameter, apiDoc generate a documentation from all .cs .dart .erl .go .java .js .php .py .rb .ts file. If you need other files, contact us!
Before setting up GitHub Sync, you may want to test it locally. This will also help with debugging, since currently there are no tools on ReadMe for seeing what went wrong. ## Installation [block:code] { "codes": [ { "code": "npm install apidoc -g", "language": "text" } ] } [/block] ## Running [block:code] { "codes": [ { "code": "apidoc && cat ./doc/api_data.json", "language": "text" } ] } [/block] This will write the output to `./doc/`, and print out the results. ReadMe reads the file `./doc/api_data.json`, and ignores everything else. (Note: There will be some other data in it that we ignore.) Without any parameter, apiDoc generate a documentation from all .cs .dart .erl .go .java .js .php .py .rb .ts file. If you need other files, contact us!
{"_id":"546e7149bf547f5a5ab38a31","order":4,"githubsync":"","link_url":"","body":"apiDoc supports (almost) every language. If you're using a unique language, your filetypes may not be supported by default – just email us.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id Request User information\\n * @apiName GetUser\\n * @apiGroup User\\n *\\n * @apiParam {Number} id Users unique ID.\\n *\\n * @apiSuccess {String} firstname Firstname of the User.\\n * @apiSuccess {String} lastname  Lastname of the User.\\n */\\n\\n//Java, JavaScript, PHP, C#, Dart, Go, etc\",\n      \"language\": \"javascript\",\n      \"name\": \"C-style\"\n    },\n    {\n      \"code\": \"###\\n@api {get} /user/:id Request User information\\n@apiName GetUser\\n@apiGroup User\\n\\n@apiParam {Number} id Users unique ID.\\n\\n@apiSuccess {String} firstname Firstname of the User.\\n@apiSuccess {String} lastname  Lastname of the User.\\n###\",\n      \"language\": \"coffeescript\"\n    },\n    {\n      \"code\": \"\\\"\\\"\\\"\\n@api {get} /user/:id Request User information\\n@apiName GetUser\\n@apiGroup User\\n\\n@apiParam {Number} id Users unique ID.\\n\\n@apiSuccess {String} firstname Firstname of the User.\\n@apiSuccess {String} lastname  Lastname of the User.\\n\\\"\\\"\\\"\",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"=begin\\n@api {get} /user/:id Request User information\\n@apiName GetUser\\n@apiGroup User\\n\\n@apiParam {Number} id Users unique ID.\\n\\n@apiSuccess {String} firstname Firstname of the User.\\n@apiSuccess {String} lastname  Lastname of the User.\\n=end\",\n      \"language\": \"ruby\"\n    }\n  ]\n}\n[/block]","project":"546e452a0f33a80800f58547","sync_unique":"","updates":["5542823ecbc48d0d001545d4"],"user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","api":{"url":"","auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"try":true},"hidden":false,"link_external":false,"slug":"supported-languages","type":"basic","category":"546e452a0f33a80800f5854b","excerpt":"","title":"Supported Languages","__v":2,"createdAt":"2014-11-20T22:55:05.057Z","childrenPages":[]}

Supported Languages


apiDoc supports (almost) every language. If you're using a unique language, your filetypes may not be supported by default – just email us. [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id Request User information\n * @apiName GetUser\n * @apiGroup User\n *\n * @apiParam {Number} id Users unique ID.\n *\n * @apiSuccess {String} firstname Firstname of the User.\n * @apiSuccess {String} lastname Lastname of the User.\n */\n\n//Java, JavaScript, PHP, C#, Dart, Go, etc", "language": "javascript", "name": "C-style" }, { "code": "###\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n###", "language": "coffeescript" }, { "code": "\"\"\"\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n\"\"\"", "language": "python" }, { "code": "=begin\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n=end", "language": "ruby" } ] } [/block]
apiDoc supports (almost) every language. If you're using a unique language, your filetypes may not be supported by default – just email us. [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id Request User information\n * @apiName GetUser\n * @apiGroup User\n *\n * @apiParam {Number} id Users unique ID.\n *\n * @apiSuccess {String} firstname Firstname of the User.\n * @apiSuccess {String} lastname Lastname of the User.\n */\n\n//Java, JavaScript, PHP, C#, Dart, Go, etc", "language": "javascript", "name": "C-style" }, { "code": "###\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n###", "language": "coffeescript" }, { "code": "\"\"\"\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n\"\"\"", "language": "python" }, { "code": "=begin\n@api {get} /user/:id Request User information\n@apiName GetUser\n@apiGroup User\n\n@apiParam {Number} id Users unique ID.\n\n@apiSuccess {String} firstname Firstname of the User.\n@apiSuccess {String} lastname Lastname of the User.\n=end", "language": "ruby" } ] } [/block]
{"_id":"546e46250f33a80800f5854e","__v":6,"category":"546e45b906f25c080075bc2b","type":"basic","api":{"basic_auth":false,"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"","auth":"never"},"link_external":false,"title":"@api","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@api {method} path [title]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nWithout that indicator, apiDoc parser ignores the documentation block.\n\nExcept definition blocks like `@apiDefineStructure`, they not need `@api`.\n\nUsage: `@api {get} /user/:id Users unique ID.`\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"method\",\n    \"0-1\": \"Request method name: `DELETE`, `GET`, `POST`, `PUT`, ...\\n\\nMore info [Wikipedia HTTP-Request_methods](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","githubsync":"","link_url":"","project":"546e452a0f33a80800f58547","slug":"api","user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","createdAt":"2014-11-20T19:51:01.191Z","hidden":false,"order":1,"sync_unique":"","updates":["546e759506f25c080075bd02"],"childrenPages":[]}

@api


[block:code] { "codes": [ { "code": "@api {method} path [title]", "language": "text" } ] } [/block] Without that indicator, apiDoc parser ignores the documentation block. Except definition blocks like `@apiDefineStructure`, they not need `@api`. Usage: `@api {get} /user/:id Users unique ID.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "method", "0-1": "Request method name: `DELETE`, `GET`, `POST`, `PUT`, ...\n\nMore info [Wikipedia HTTP-Request_methods](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods)" }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@api {method} path [title]", "language": "text" } ] } [/block] Without that indicator, apiDoc parser ignores the documentation block. Except definition blocks like `@apiDefineStructure`, they not need `@api`. Usage: `@api {get} /user/:id Users unique ID.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "method", "0-1": "Request method name: `DELETE`, `GET`, `POST`, `PUT`, ...\n\nMore info [Wikipedia HTTP-Request_methods](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods)" }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e5ad6bf547f5a5ab38a25","title":"@apiParam","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"basic_auth":false,"try":true,"params":[],"url":"","auth":"never"},"createdAt":"2014-11-20T21:19:18.380Z","version":"546e452a0f33a80800f5854a","githubsync":"","hidden":false,"sync_unique":"","updates":["546e762306f25c080075bd03"],"user":"5250b3ad5ac09b3564000005","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiParam [(group)] [{type}] [field=defaultValue] [description]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nDescribes a parameter passed to your API-Method.\n\nUsage: `@apiParam (MyGroup) {Number} id Users unique ID.`\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"(group)\",\n    \"0-1\": \"All parameters will be grouped by this name.\\nWithout a group, the default `Parameter` is set.\\n\\nYou can set a title and description with `@apiDefine`.\",\n    \"1-0\": \"{type}\",\n    \"2-0\": \"field\",\n    \"3-0\": \"[field]\",\n    \"4-0\": \"=defaultValue\",\n    \"5-0\": \"description\",\n    \"1-1\": \"Parameter type, e.g. `{Boolean}`,  `{Number}`,  `{String}`, `{Object}`, `{String[]}` (array of strings), ...\",\n    \"2-1\": \"Variable name\",\n    \"3-1\": \"Fieldname with brackets define the Variable as optional.\",\n    \"4-1\": \"The parameters default value.\",\n    \"5-1\": \"Description of the field.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiParam {Number} id Users unique ID.\\n */\\n\\n/**\\n * @api {post} /user/\\n * @apiParam {String} [firstname]  Optional Firstname of the User.\\n * @apiParam {String} lastname     Mandatory Lastname.\\n * @apiParam {String} country=\\\"DE\\\" Mandatory with default value \\\"DE\\\".\\n * @apiParam {String} [age=18]     Optional Age with default 18.\\n *\\n * @apiParam (Login) {String} pass Only logged in users can post this.\\n *                                 In generated documentation a separate\\n *                                 \\\"Login\\\" Block will be generated.\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"546e45b906f25c080075bc2b","type":"basic","link_url":"","order":2,"project":"546e452a0f33a80800f58547","slug":"apiparam","__v":1,"excerpt":"","link_external":false,"childrenPages":[]}

@apiParam


[block:code] { "codes": [ { "code": "@apiParam [(group)] [{type}] [field=defaultValue] [description]", "language": "text" } ] } [/block] Describes a parameter passed to your API-Method. Usage: `@apiParam (MyGroup) {Number} id Users unique ID.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "(group)", "0-1": "All parameters will be grouped by this name.\nWithout a group, the default `Parameter` is set.\n\nYou can set a title and description with `@apiDefine`.", "1-0": "{type}", "2-0": "field", "3-0": "[field]", "4-0": "=defaultValue", "5-0": "description", "1-1": "Parameter type, e.g. `{Boolean}`, `{Number}`, `{String}`, `{Object}`, `{String[]}` (array of strings), ...", "2-1": "Variable name", "3-1": "Fieldname with brackets define the Variable as optional.", "4-1": "The parameters default value.", "5-1": "Description of the field." }, "cols": 2, "rows": 6 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiParam {Number} id Users unique ID.\n */\n\n/**\n * @api {post} /user/\n * @apiParam {String} [firstname] Optional Firstname of the User.\n * @apiParam {String} lastname Mandatory Lastname.\n * @apiParam {String} country=\"DE\" Mandatory with default value \"DE\".\n * @apiParam {String} [age=18] Optional Age with default 18.\n *\n * @apiParam (Login) {String} pass Only logged in users can post this.\n * In generated documentation a separate\n * \"Login\" Block will be generated.\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiParam [(group)] [{type}] [field=defaultValue] [description]", "language": "text" } ] } [/block] Describes a parameter passed to your API-Method. Usage: `@apiParam (MyGroup) {Number} id Users unique ID.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "(group)", "0-1": "All parameters will be grouped by this name.\nWithout a group, the default `Parameter` is set.\n\nYou can set a title and description with `@apiDefine`.", "1-0": "{type}", "2-0": "field", "3-0": "[field]", "4-0": "=defaultValue", "5-0": "description", "1-1": "Parameter type, e.g. `{Boolean}`, `{Number}`, `{String}`, `{Object}`, `{String[]}` (array of strings), ...", "2-1": "Variable name", "3-1": "Fieldname with brackets define the Variable as optional.", "4-1": "The parameters default value.", "5-1": "Description of the field." }, "cols": 2, "rows": 6 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiParam {Number} id Users unique ID.\n */\n\n/**\n * @api {post} /user/\n * @apiParam {String} [firstname] Optional Firstname of the User.\n * @apiParam {String} lastname Mandatory Lastname.\n * @apiParam {String} country=\"DE\" Mandatory with default value \"DE\".\n * @apiParam {String} [age=18] Optional Age with default 18.\n *\n * @apiParam (Login) {String} pass Only logged in users can post this.\n * In generated documentation a separate\n * \"Login\" Block will be generated.\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e5a45bf547f5a5ab38a22","project":"546e452a0f33a80800f58547","type":"basic","version":"546e452a0f33a80800f5854a","category":"546e45b906f25c080075bc2b","excerpt":"","githubsync":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"try":true,"url":"","auth":"never","basic_auth":false},"sync_unique":"","title":"@apiName","updates":["546e76aee6613d080031bdc8","546e76e38176490e00b59b11"],"createdAt":"2014-11-20T21:16:53.914Z","link_url":"","link_external":false,"order":3,"slug":"apiname","user":"5250b3ad5ac09b3564000005","__v":3,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiName name\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Should Always Be Used\",\n  \"body\": \"Not setting @apiName from the start will result in potential syncing issues. This is a unique name used to keep track of a single API endpoint in the event that the URL or title changes.\"\n}\n[/block]\n\nDefines the name of the method documentation block. Names will be used for the Sub-Navigation in the generated output. Structure definitions do not need `@apiName`.\n\nUsage: `@apiName GetUser`\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"Unique name of the method. Same name with different `@apiVersion` can be defined.\\n\\nFormat: method + path (e.g. Get + User), only a proposal, you can name as you want.\\n\\nAlso used as navigation title.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiName GetUser\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"childrenPages":[]}

@apiName


[block:code] { "codes": [ { "code": "@apiName name", "language": "text" } ] } [/block] [block:callout] { "type": "danger", "title": "Should Always Be Used", "body": "Not setting @apiName from the start will result in potential syncing issues. This is a unique name used to keep track of a single API endpoint in the event that the URL or title changes." } [/block] Defines the name of the method documentation block. Names will be used for the Sub-Navigation in the generated output. Structure definitions do not need `@apiName`. Usage: `@apiName GetUser` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "name", "0-1": "Unique name of the method. Same name with different `@apiVersion` can be defined.\n\nFormat: method + path (e.g. Get + User), only a proposal, you can name as you want.\n\nAlso used as navigation title." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiName GetUser\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiName name", "language": "text" } ] } [/block] [block:callout] { "type": "danger", "title": "Should Always Be Used", "body": "Not setting @apiName from the start will result in potential syncing issues. This is a unique name used to keep track of a single API endpoint in the event that the URL or title changes." } [/block] Defines the name of the method documentation block. Names will be used for the Sub-Navigation in the generated output. Structure definitions do not need `@apiName`. Usage: `@apiName GetUser` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "name", "0-1": "Unique name of the method. Same name with different `@apiVersion` can be defined.\n\nFormat: method + path (e.g. Get + User), only a proposal, you can name as you want.\n\nAlso used as navigation title." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiName GetUser\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e5962bf547f5a5ab38a1e","category":"546e45b906f25c080075bc2b","link_external":false,"updates":["546e75c90f33a80800f5861c"],"createdAt":"2014-11-20T21:13:06.192Z","githubsync":"","link_url":"","order":4,"project":"546e452a0f33a80800f58547","title":"@apiGroup","__v":2,"api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"","auth":"never","basic_auth":false},"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiGroup name\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nDefines in which category the docs should reside.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"Name of the category.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiGroup User\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"slug":"apigroup","sync_unique":"","excerpt":"","type":"basic","user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","childrenPages":[]}

@apiGroup


[block:code] { "codes": [ { "code": "@apiGroup name", "language": "text" } ] } [/block] Defines in which category the docs should reside. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "name", "0-1": "Name of the category." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiGroup User\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiGroup name", "language": "text" } ] } [/block] Defines in which category the docs should reside. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "name", "0-1": "Name of the category." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiGroup User\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e5938bf547f5a5ab38a1c","sync_unique":"","title":"@apiExample","__v":0,"hidden":false,"link_external":false,"excerpt":"","order":5,"type":"basic","updates":[],"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiExample [{type}] title\\n            example\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nExample for usage of an API method. Output as a pre-formatted code.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"type [optional]\",\n    \"0-1\": \"Code language.\",\n    \"1-0\": \"title\",\n    \"1-1\": \"Short title for the example.\",\n    \"2-0\": \"example\",\n    \"2-1\": \"Detailed example, multilines capable.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiExample {curl} Example usage:\\n *     curl -i http://localhost/user/4711\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"546e45b906f25c080075bc2b","createdAt":"2014-11-20T21:12:24.188Z","link_url":"","user":"5250b3ad5ac09b3564000005","api":{"params":[],"url":"","auth":"never","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"basic_auth":false,"try":true},"githubsync":"","project":"546e452a0f33a80800f58547","slug":"apiexample","version":"546e452a0f33a80800f5854a","childrenPages":[]}

@apiExample


[block:code] { "codes": [ { "code": "@apiExample [{type}] title\n example", "language": "text" } ] } [/block] Example for usage of an API method. Output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Code language.", "1-0": "title", "1-1": "Short title for the example.", "2-0": "example", "2-1": "Detailed example, multilines capable." }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiExample {curl} Example usage:\n * curl -i http://localhost/user/4711\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiExample [{type}] title\n example", "language": "text" } ] } [/block] Example for usage of an API method. Output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Code language.", "1-0": "title", "1-1": "Short title for the example.", "2-0": "example", "2-1": "Detailed example, multilines capable." }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiExample {curl} Example usage:\n * curl -i http://localhost/user/4711\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e5b4abf547f5a5ab38a27","sync_unique":"","category":"546e45b906f25c080075bc2b","hidden":false,"link_external":false,"link_url":"","project":"546e452a0f33a80800f58547","slug":"apisuccessexample","type":"basic","api":{"basic_auth":false,"try":true,"params":[],"url":"","auth":"never","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]}},"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiSuccessExample [{type}] [title]\\n                   example\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nExample of a success return message, output as a pre-formatted code.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"type [optional]\",\n    \"0-1\": \"Response format.\",\n    \"1-0\": \"title [optional]\",\n    \"2-0\": \"example\",\n    \"1-1\": \"Short title for the example.\",\n    \"2-1\": \"Detailed example, multilines capable.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiSuccessExample {json} Success-Response:\\n *     HTTP/1.1 200 OK\\n *     {\\n *       \\\"firstname\\\": \\\"John\\\",\\n *       \\\"lastname\\\": \\\"Doe\\\"\\n *     }\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","createdAt":"2014-11-20T21:21:14.348Z","excerpt":"","githubsync":"","title":"@apiSuccessExample","user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","__v":0,"order":6,"updates":[],"childrenPages":[]}

@apiSuccessExample


[block:code] { "codes": [ { "code": "@apiSuccessExample [{type}] [title]\n example", "language": "text" } ] } [/block] Example of a success return message, output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Response format.", "1-0": "title [optional]", "2-0": "example", "1-1": "Short title for the example.", "2-1": "Detailed example, multilines capable." }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiSuccessExample {json} Success-Response:\n * HTTP/1.1 200 OK\n * {\n * \"firstname\": \"John\",\n * \"lastname\": \"Doe\"\n * }\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiSuccessExample [{type}] [title]\n example", "language": "text" } ] } [/block] Example of a success return message, output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Response format.", "1-0": "title [optional]", "2-0": "example", "1-1": "Short title for the example.", "2-1": "Detailed example, multilines capable." }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiSuccessExample {json} Success-Response:\n * HTTP/1.1 200 OK\n * {\n * \"firstname\": \"John\",\n * \"lastname\": \"Doe\"\n * }\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e58d9bf547f5a5ab38a1a","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiErrorExample [{type}] [title]\\n                 example\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nExample of an error return message, output as a pre-formatted code.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"type [optional]\",\n    \"0-1\": \"Response format\",\n    \"1-0\": \"title [optional]\",\n    \"1-1\": \"Short title for the example\",\n    \"2-0\": \"example\",\n    \"2-1\": \"Detailed example, multiline capable\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @api {get} /user/:id\\n * @apiErrorExample {json} Error-Response:\\n *     HTTP/1.1 404 Not Found\\n *     {\\n *       \\\"error\\\": \\\"UserNotFound\\\"\\n *     }\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"project":"546e452a0f33a80800f58547","createdAt":"2014-11-20T21:10:49.564Z","excerpt":"","order":7,"sync_unique":"","user":"5250b3ad5ac09b3564000005","version":"546e452a0f33a80800f5854a","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"basic_auth":false,"try":true,"params":[],"url":"","auth":"never"},"category":"546e45b906f25c080075bc2b","link_url":"","title":"@apiErrorExample","type":"basic","updates":["546e767a0f33a80800f58622"],"__v":1,"githubsync":"","link_external":false,"slug":"apierrorexample","childrenPages":[]}

@apiErrorExample


[block:code] { "codes": [ { "code": "@apiErrorExample [{type}] [title]\n example", "language": "text" } ] } [/block] Example of an error return message, output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Response format", "1-0": "title [optional]", "1-1": "Short title for the example", "2-0": "example", "2-1": "Detailed example, multiline capable" }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiErrorExample {json} Error-Response:\n * HTTP/1.1 404 Not Found\n * {\n * \"error\": \"UserNotFound\"\n * }\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiErrorExample [{type}] [title]\n example", "language": "text" } ] } [/block] Example of an error return message, output as a pre-formatted code. [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "type [optional]", "0-1": "Response format", "1-0": "title [optional]", "1-1": "Short title for the example", "2-0": "example", "2-1": "Detailed example, multiline capable" }, "cols": 2, "rows": 3 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @api {get} /user/:id\n * @apiErrorExample {json} Error-Response:\n * HTTP/1.1 404 Not Found\n * {\n * \"error\": \"UserNotFound\"\n * }\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e59bcbf547f5a5ab38a20","link_url":"","version":"546e452a0f33a80800f5854a","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"\",\n  \"body\": \"Place this on top of a block\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiIgnore [hint]\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nA block with `@apiIgnore` will not be parsed. This is useful if you leave outdated or not finished methods in your source code and do not want them published in the documentation.\n\nUsage: `@apiIgnore Not finished Method`\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"hint [optional]\",\n    \"0-1\": \"Short information why this block should be ignored.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @apiIgnore Not finished Method\\n * @api {get} /user/:id\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"546e45b906f25c080075bc2b","excerpt":"","link_external":false,"title":"@apiIgnore","type":"basic","user":"5250b3ad5ac09b3564000005","__v":1,"order":8,"updates":["546e76580f33a80800f58621"],"githubsync":"","hidden":false,"project":"546e452a0f33a80800f58547","slug":"apiignore","sync_unique":"","api":{"url":"","auth":"never","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"basic_auth":false,"try":true,"params":[]},"createdAt":"2014-11-20T21:14:36.936Z","childrenPages":[]}

@apiIgnore


[block:callout] { "type": "warning", "title": "", "body": "Place this on top of a block" } [/block] [block:code] { "codes": [ { "code": "@apiIgnore [hint]", "language": "text" } ] } [/block] A block with `@apiIgnore` will not be parsed. This is useful if you leave outdated or not finished methods in your source code and do not want them published in the documentation. Usage: `@apiIgnore Not finished Method` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "hint [optional]", "0-1": "Short information why this block should be ignored." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @apiIgnore Not finished Method\n * @api {get} /user/:id\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:callout] { "type": "warning", "title": "", "body": "Place this on top of a block" } [/block] [block:code] { "codes": [ { "code": "@apiIgnore [hint]", "language": "text" } ] } [/block] A block with `@apiIgnore` will not be parsed. This is useful if you leave outdated or not finished methods in your source code and do not want them published in the documentation. Usage: `@apiIgnore Not finished Method` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "hint [optional]", "0-1": "Short information why this block should be ignored." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @apiIgnore Not finished Method\n * @api {get} /user/:id\n */", "language": "javascript" } ], "sidebar": true } [/block]
{"_id":"546e48110f33a80800f58555","type":"basic","version":"546e452a0f33a80800f5854a","api":{"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"try":true,"url":"","auth":"never","basic_auth":false},"githubsync":"","hidden":false,"slug":"apidescription","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"@apiDescription text\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nShort description of the API method. This will be used directly under the page title.\n\nUsage: `@apiDescription This is the Description.`\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"text\",\n    \"0-1\": \"Multiline description text.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/**\\n * @apiDescription This is the Description.\\n * It is multiline capable.\\n *\\n * Last line of Description.\\n */\",\n      \"language\": \"javascript\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":["546e75ef0f33a80800f5861d"],"__v":3,"category":"546e45b906f25c080075bc2b","project":"546e452a0f33a80800f58547","title":"@apiDescription","sync_unique":"","user":"5250b3ad5ac09b3564000005","createdAt":"2014-11-20T19:59:13.637Z","excerpt":"","link_external":false,"link_url":"","order":9,"childrenPages":[]}

@apiDescription


[block:code] { "codes": [ { "code": "@apiDescription text", "language": "text" } ] } [/block] Short description of the API method. This will be used directly under the page title. Usage: `@apiDescription This is the Description.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "text", "0-1": "Multiline description text." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @apiDescription This is the Description.\n * It is multiline capable.\n *\n * Last line of Description.\n */", "language": "javascript" } ], "sidebar": true } [/block]
[block:code] { "codes": [ { "code": "@apiDescription text", "language": "text" } ] } [/block] Short description of the API method. This will be used directly under the page title. Usage: `@apiDescription This is the Description.` [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "text", "0-1": "Multiline description text." }, "cols": 2, "rows": 1 } [/block] [block:textarea] { "text": "Example:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "/**\n * @apiDescription This is the Description.\n * It is multiline capable.\n *\n * Last line of Description.\n */", "language": "javascript" } ], "sidebar": true } [/block]