Content of header.md file.
\n" 10 | }, 11 | "footer": { 12 | "title": "My own footer title", 13 | "content": "Content of footer.md file.
\n" 14 | }, 15 | "order": [ 16 | "Error", 17 | "Define", 18 | "PostTitleAndError", 19 | "NotExistingEntry", 20 | "PostError", 21 | "GetParam" 22 | ], 23 | "apidoc": "0.2.0", 24 | "generator": { 25 | "name": "apidoc", 26 | "time": "2016-02-17T09:47:50.288Z", 27 | "url": "http://apidocjs.com", 28 | "version": "0.15.1" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /v0.2.0/fixtures/api_project.js: -------------------------------------------------------------------------------- 1 | define({ 2 | "name": "test", 3 | "version": "0.13.0", 4 | "description": "RESTful web API Documentation Generator", 5 | "url": "https://api.github.com/v1", 6 | "sampleUrl": "https://api.github.com/v1", 7 | "header": { 8 | "title": "My own header title", 9 | "content": "Content of header.md file.
\n" 10 | }, 11 | "footer": { 12 | "title": "My own footer title", 13 | "content": "Content of footer.md file.
\n" 14 | }, 15 | "order": [ 16 | "Error", 17 | "Define", 18 | "PostTitleAndError", 19 | "NotExistingEntry", 20 | "PostError", 21 | "GetParam" 22 | ], 23 | "apidoc": "0.2.0", 24 | "generator": { 25 | "name": "apidoc", 26 | "time": "2016-02-17T09:47:50.288Z", 27 | "url": "http://apidocjs.com", 28 | "version": "0.15.1" 29 | } 30 | }); 31 | -------------------------------------------------------------------------------- /v0.3.0/fixtures/api_project.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "test", 3 | "version": "0.13.0", 4 | "description": "RESTful web API Documentation Generator", 5 | "url": "https://api.github.com/v1", 6 | "sampleUrl": "https://api.github.com/v1", 7 | "header": { 8 | "title": "My own header title", 9 | "content": "Content of header.md file.
\n" 10 | }, 11 | "footer": { 12 | "title": "My own footer title", 13 | "content": "Content of footer.md file.
\n" 14 | }, 15 | "order": [ 16 | "Error", 17 | "Define", 18 | "PostTitleAndError", 19 | "NotExistingEntry", 20 | "PostError", 21 | "GetParam" 22 | ], 23 | "defaultVersion": "0.0.0", 24 | "apidoc": "0.3.0", 25 | "generator": { 26 | "name": "apidoc", 27 | "time": "2017-05-19T09:34:32.325Z", 28 | "url": "https://apidocjs.com", 29 | "version": "0.17.5" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /v0.3.0/fixtures/api_project.js: -------------------------------------------------------------------------------- 1 | define({ 2 | "name": "test", 3 | "version": "0.13.0", 4 | "description": "RESTful web API Documentation Generator", 5 | "url": "https://api.github.com/v1", 6 | "sampleUrl": "https://api.github.com/v1", 7 | "header": { 8 | "title": "My own header title", 9 | "content": "Content of header.md file.
\n" 10 | }, 11 | "footer": { 12 | "title": "My own footer title", 13 | "content": "Content of footer.md file.
\n" 14 | }, 15 | "order": [ 16 | "Error", 17 | "Define", 18 | "PostTitleAndError", 19 | "NotExistingEntry", 20 | "PostError", 21 | "GetParam" 22 | ], 23 | "defaultVersion": "0.0.0", 24 | "apidoc": "0.3.0", 25 | "generator": { 26 | "name": "apidoc", 27 | "time": "2017-05-19T09:34:32.325Z", 28 | "url": "https://apidocjs.com", 29 | "version": "0.17.5" 30 | } 31 | }); 32 | -------------------------------------------------------------------------------- /v0.2.0/src/language.rb: -------------------------------------------------------------------------------- 1 | # Test for programming language: Ruby 2 | 3 | =begin 4 | @api {get} /language/ruby Ruby 5 | @apiName GetLanguageRuby 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Ruby Comment-Syntax. 9 | =end 10 | 11 | =begin 12 | @api {get} /language/ruby/indented1 Ruby indented 1 13 | @apiName GetLanguageRubyIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | =end 23 | 24 | =begin 25 | @api {get} /language/ruby/indented2 Ruby indented 2 26 | @apiName GetLanguageRubyIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | =end 36 | -------------------------------------------------------------------------------- /v0.3.0/src/language.rb: -------------------------------------------------------------------------------- 1 | # Test for programming language: Ruby 2 | 3 | =begin 4 | @api {get} /language/ruby Ruby 5 | @apiName GetLanguageRuby 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Ruby Comment-Syntax. 9 | =end 10 | 11 | =begin 12 | @api {get} /language/ruby/indented1 Ruby indented 1 13 | @apiName GetLanguageRubyIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | =end 23 | 24 | =begin 25 | @api {get} /language/ruby/indented2 Ruby indented 2 26 | @apiName GetLanguageRubyIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | =end 36 | -------------------------------------------------------------------------------- /v0.2.0/src/language.py: -------------------------------------------------------------------------------- 1 | # Test for programming language: Python 2 | 3 | """ 4 | @api {get} /language/python Python 5 | @apiName GetLanguagePython 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Python Comment-Syntax. 9 | """ 10 | 11 | """ 12 | @api {get} /language/python/indented1 Python indented 1 13 | @apiName GetLanguagePythonIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | """ 23 | 24 | """ 25 | @api {get} /language/python/indented2 Python indented 2 26 | @apiName GetLanguagePythonIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | """ 36 | -------------------------------------------------------------------------------- /v0.3.0/src/language.py: -------------------------------------------------------------------------------- 1 | # Test for programming language: Python 2 | 3 | """ 4 | @api {get} /language/python Python 5 | @apiName GetLanguagePython 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Python Comment-Syntax. 9 | """ 10 | 11 | """ 12 | @api {get} /language/python/indented1 Python indented 1 13 | @apiName GetLanguagePythonIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | """ 23 | 24 | """ 25 | @api {get} /language/python/indented2 Python indented 2 26 | @apiName GetLanguagePythonIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | """ 36 | -------------------------------------------------------------------------------- /v0.2.0/src/language.erl: -------------------------------------------------------------------------------- 1 | % Test for programming language: Erlang 2 | 3 | %{ 4 | @api {get} /language/erlang Erlang 5 | @apiName GetLanguageErlang 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Erlang Comment-Syntax. 9 | %} 10 | 11 | %{ 12 | % @api {get} /language/erlang/indented1 Erlang indented 1 13 | % @apiName GetLanguageErlangIndented1 14 | % @apiGroup Language 15 | % @apiVersion 0.4.0 16 | % @apiExample Test for indented comment. 17 | % This is example line 2. 18 | % This is example line 3. 19 | % Line 4 indented (with tab at beginning). 20 | % Line 5 indented. 21 | % This is example line 6. 22 | %} 23 | 24 | %{ 25 | @api {get} /language/erlang/indented2 Erlang indented 2 26 | @apiName GetLanguageErlangIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | %} 36 | -------------------------------------------------------------------------------- /v0.3.0/src/language.erl: -------------------------------------------------------------------------------- 1 | % Test for programming language: Erlang 2 | 3 | %{ 4 | @api {get} /language/erlang Erlang 5 | @apiName GetLanguageErlang 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for Erlang Comment-Syntax. 9 | %} 10 | 11 | %{ 12 | % @api {get} /language/erlang/indented1 Erlang indented 1 13 | % @apiName GetLanguageErlangIndented1 14 | % @apiGroup Language 15 | % @apiVersion 0.4.0 16 | % @apiExample Test for indented comment. 17 | % This is example line 2. 18 | % This is example line 3. 19 | % Line 4 indented (with tab at beginning). 20 | % Line 5 indented. 21 | % This is example line 6. 22 | %} 23 | 24 | %{ 25 | @api {get} /language/erlang/indented2 Erlang indented 2 26 | @apiName GetLanguageErlangIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | %} 36 | -------------------------------------------------------------------------------- /v0.2.0/src/language.coffee: -------------------------------------------------------------------------------- 1 | # Test for programming language: CoffeeScript 2 | 3 | ### 4 | @api {get} /language/coffeescript CoffeeScript 5 | @apiName GetLanguageCoffeeScript 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for CoffeeScript Comment-Syntax. 9 | ### 10 | 11 | ### 12 | @api {get} /language/coffeescript/indented1 CoffeeScript indented 1 13 | @apiName GetLanguageCoffeeScriptIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | ### 23 | 24 | ### 25 | @api {get} /language/coffeescript/indented2 CoffeeScript indented 2 26 | @apiName GetLanguageCoffeeScriptIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | ### 36 | -------------------------------------------------------------------------------- /v0.3.0/src/language.coffee: -------------------------------------------------------------------------------- 1 | # Test for programming language: CoffeeScript 2 | 3 | ### 4 | @api {get} /language/coffeescript CoffeeScript 5 | @apiName GetLanguageCoffeeScript 6 | @apiGroup Language 7 | @apiVersion 0.4.0 8 | @apiDescription Test for CoffeeScript Comment-Syntax. 9 | ### 10 | 11 | ### 12 | @api {get} /language/coffeescript/indented1 CoffeeScript indented 1 13 | @apiName GetLanguageCoffeeScriptIndented1 14 | @apiGroup Language 15 | @apiVersion 0.4.0 16 | @apiExample Test for indented comment. 17 | This is example line 2. 18 | This is example line 3. 19 | Line 4 indented (with tab at beginning). 20 | Line 5 indented. 21 | This is example line 6. 22 | ### 23 | 24 | ### 25 | @api {get} /language/coffeescript/indented2 CoffeeScript indented 2 26 | @apiName GetLanguageCoffeeScriptIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | ### 36 | -------------------------------------------------------------------------------- /v0.2.0/src/language.js: -------------------------------------------------------------------------------- 1 | // Test for programming language: JavaScript 2 | 3 | /** 4 | * @api {get} /language/javascript JavaScript 5 | * @apiName GetLanguageJavaScript 6 | * @apiGroup Language 7 | * @apiVersion 0.4.0 8 | * @apiDescription Test for JavaScript Comment-Syntax. 9 | */ 10 | 11 | /** 12 | * @api {get} /language/javascript/indented1 JavaScript indented 1 13 | * @apiName GetLanguageJavaScriptIndented1 14 | * @apiGroup Language 15 | * @apiVersion 0.4.0 16 | * @apiExample Test for indented comment. 17 | * This is example line 2. 18 | * This is example line 3. 19 | * Line 4 indented (with tab at beginning). 20 | * Line 5 indented. 21 | * This is example line 6. 22 | */ 23 | 24 | /** 25 | @api {get} /language/javascript/indented2 JavaScript indented 2 26 | @apiName GetLanguageJavaScriptIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | */ 36 | -------------------------------------------------------------------------------- /v0.3.0/src/language.js: -------------------------------------------------------------------------------- 1 | // Test for programming language: JavaScript 2 | 3 | /** 4 | * @api {get} /language/javascript JavaScript 5 | * @apiName GetLanguageJavaScript 6 | * @apiGroup Language 7 | * @apiVersion 0.4.0 8 | * @apiDescription Test for JavaScript Comment-Syntax. 9 | */ 10 | 11 | /** 12 | * @api {get} /language/javascript/indented1 JavaScript indented 1 13 | * @apiName GetLanguageJavaScriptIndented1 14 | * @apiGroup Language 15 | * @apiVersion 0.4.0 16 | * @apiExample Test for indented comment. 17 | * This is example line 2. 18 | * This is example line 3. 19 | * Line 4 indented (with tab at beginning). 20 | * Line 5 indented. 21 | * This is example line 6. 22 | */ 23 | 24 | /** 25 | @api {get} /language/javascript/indented2 JavaScript indented 2 26 | @apiName GetLanguageJavaScriptIndented2 27 | @apiGroup Language 28 | @apiVersion 0.4.0 29 | @apiExample Test for indented comment. 30 | This is example line 2. 31 | This is example line 3. 32 | Line 4 indented (with tab at beginning). 33 | Line 5 indented. 34 | This is example line 6. 35 | */ 36 | -------------------------------------------------------------------------------- /v0.2.0/src/indent.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @apiDefine indent Indent 3 | */ 4 | 5 | /** 6 | * @api {get} /indent/word Indent a word 7 | * @apiGroup indent 8 | * @apiDescription text. 9 | */ 10 | 11 | /** 12 | * @api {get} /indent/trim/single Trim single line 13 | * @apiGroup indent 14 | * @apiDescription Text line 1 (Begin: 3xSpaces (3 removed), End: 1xSpace). 15 | */ 16 | 17 | /** 18 | * @api {get} /indent/trim/multi/spaces Trim multi line (spaces) 19 | * @apiGroup indent 20 | * @apiDescription Text line 1 (Begin: 4xSpaces (3 removed)). 21 | * Text line 2 (Begin: 3xSpaces (3 removed), End: 2xSpaces). 22 | */ 23 | 24 | /** 25 | * @api {get} /indent/trim/multi/tabs Trim multi line (tabs) 26 | * @apiGroup indent 27 | * @apiDescription Text line 1 (Begin: 3xTab (2 removed)). 28 | * Text line 2 (Begin: 2x Tab (2 removed), End: 1xTab). 29 | */ 30 | 31 | /** 32 | * @api {get} /indent/trim/multi/tabs/and/space Trim multi line (tabs and space) 33 | * @apiGroup indent 34 | * @apiDescription Text line 1 (Begin: 1xTab, 2xSpaces). 35 | * Text line 2 (Begin: 3xSpaces, End: 1xTab). 36 | */ 37 | -------------------------------------------------------------------------------- /v0.3.0/src/indent.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @apiDefine indent Indent 3 | */ 4 | 5 | /** 6 | * @api {get} /indent/word Indent a word 7 | * @apiGroup indent 8 | * @apiDescription text. 9 | */ 10 | 11 | /** 12 | * @api {get} /indent/trim/single Trim single line 13 | * @apiGroup indent 14 | * @apiDescription Text line 1 (Begin: 3xSpaces (3 removed), End: 1xSpace). 15 | */ 16 | 17 | /** 18 | * @api {get} /indent/trim/multi/spaces Trim multi line (spaces) 19 | * @apiGroup indent 20 | * @apiDescription Text line 1 (Begin: 4xSpaces (3 removed)). 21 | * Text line 2 (Begin: 3xSpaces (3 removed), End: 2xSpaces). 22 | */ 23 | 24 | /** 25 | * @api {get} /indent/trim/multi/tabs Trim multi line (tabs) 26 | * @apiGroup indent 27 | * @apiDescription Text line 1 (Begin: 3xTab (2 removed)). 28 | * Text line 2 (Begin: 2x Tab (2 removed), End: 1xTab). 29 | */ 30 | 31 | /** 32 | * @api {get} /indent/trim/multi/tabs/and/space Trim multi line (tabs and space) 33 | * @apiGroup indent 34 | * @apiDescription Text line 1 (Begin: 1xTab, 2xSpaces). 35 | * Text line 2 (Begin: 3xSpaces, End: 1xTab). 36 | */ 37 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2013-2017 inveris OHG 2 | Author Peter RottmannExample of @apiDefine and @apiUse
", 10 | "parameter": { 11 | "fields": { 12 | "Parameter": [ 13 | { 14 | "group": "Parameter", 15 | "optional": false, 16 | "field": "field3", 17 | "description": "This is Field 3 (local).
" 18 | }, 19 | { 20 | "group": "Parameter", 21 | "optional": false, 22 | "field": "field1", 23 | "description": "This is Field 1.
" 24 | }, 25 | { 26 | "group": "Parameter", 27 | "optional": false, 28 | "field": "field2", 29 | "description": "This is Field 2.
" 30 | } 31 | ] 32 | } 33 | }, 34 | "filename": "src/api_define.js", 35 | "groupTitle": "Define", 36 | "sampleRequest": [ 37 | { 38 | "url": "https://api.github.com/v1/define" 39 | } 40 | ] 41 | }, 42 | { 43 | "type": "get", 44 | "url": "/test/escape", 45 | "title": "Escape Example", 46 | "name": "GetEscape", 47 | "group": "Escape", 48 | "version": "0.6.0", 49 | "description": "Escape Example data.
", 50 | "examples": [ 51 | { 52 | "title": "Example usage:", 53 | "content": "curl -i http://localhost/escape/text\ncurl -i http://localhost/escape/html\nEscape Example data - with comparison.
", 82 | "examples": [ 83 | { 84 | "title": "Example usage:", 85 | "content": "curl -i http://localhost/escape/text-old\ncurl -i http://localhost/escape/html-old\nExtended usage of @apiExample with different example types.
", 114 | "examples": [ 115 | { 116 | "title": "PHP Example (new)", 117 | "content": "echo 'This is the content. (new)';", 118 | "type": "PHP" 119 | }, 120 | { 121 | "title": "JS Example", 122 | "content": "console.log('This is the content.');", 123 | "type": "JS" 124 | } 125 | ], 126 | "success": { 127 | "examples": [ 128 | { 129 | "title": "PHP Success Example (new)", 130 | "content": "echo 'This is the success content. (new)';", 131 | "type": "PHP" 132 | }, 133 | { 134 | "title": "JS Success Example", 135 | "content": "console.log('This is the success content.');", 136 | "type": "JS" 137 | } 138 | ] 139 | }, 140 | "error": { 141 | "examples": [ 142 | { 143 | "title": "PHP Error Example", 144 | "content": "echo 'This is the error content.';", 145 | "type": "PHP" 146 | }, 147 | { 148 | "title": "JS Error Example", 149 | "content": "console.log('This is the error content.');", 150 | "type": "JS" 151 | } 152 | ] 153 | }, 154 | "filename": "src/api_example.js", 155 | "groupTitle": "Example", 156 | "sampleRequest": [ 157 | { 158 | "url": "https://api.github.com/v1/example/" 159 | } 160 | ] 161 | }, 162 | { 163 | "type": "get", 164 | "url": "/example/", 165 | "title": "Example", 166 | "name": "GetExample", 167 | "group": "Example", 168 | "version": "0.7.0", 169 | "description": "Extended usage of @apiExample with different example types.
", 170 | "examples": [ 171 | { 172 | "title": "PHP Example", 173 | "content": "echo 'This is the content.';", 174 | "type": "PHP" 175 | }, 176 | { 177 | "title": "JS Example (removed)", 178 | "content": "console.log('This is the content. (removed)');", 179 | "type": "JS" 180 | } 181 | ], 182 | "success": { 183 | "examples": [ 184 | { 185 | "title": "PHP Success Example", 186 | "content": "echo 'This is the success content.';", 187 | "type": "PHP" 188 | }, 189 | { 190 | "title": "JS Success Example", 191 | "content": "console.log('This is the success content.');", 192 | "type": "JS" 193 | } 194 | ] 195 | }, 196 | "error": { 197 | "examples": [ 198 | { 199 | "title": "PHP Error Example (removed)", 200 | "content": "echo 'This is the error content. (removed)';", 201 | "type": "PHP" 202 | }, 203 | { 204 | "title": "JS Error Example", 205 | "content": "console.log('This is the error content.');", 206 | "type": "JS" 207 | } 208 | ] 209 | }, 210 | "filename": "src/api_example.js", 211 | "groupTitle": "Example", 212 | "sampleRequest": [ 213 | { 214 | "url": "https://api.github.com/v1/example/" 215 | } 216 | ] 217 | }, 218 | { 219 | "type": "get", 220 | "url": "/group/:id", 221 | "title": "Group and Description", 222 | "name": "GetGroup", 223 | "group": "Group", 224 | "version": "0.5.0", 225 | "filename": "src/api_group.js", 226 | "groupTitle": "Group Title", 227 | "groupDescription": "This is a Group Description. It is Markdown capable.
", 228 | "sampleRequest": [ 229 | { 230 | "url": "https://api.github.com/v1/group/:id" 231 | } 232 | ] 233 | }, 234 | { 235 | "type": "get", 236 | "url": "/test/:id", 237 | "title": "Grouping", 238 | "name": "GetGrouping", 239 | "group": "Grouping", 240 | "version": "0.1.0", 241 | "description": "Title and Grouping of param, success and error
", 242 | "parameter": { 243 | "fields": { 244 | "Parameter": [ 245 | { 246 | "group": "Parameter", 247 | "type": "String", 248 | "optional": false, 249 | "field": "param1", 250 | "description": "No Group, automatically set Group to "Parameter"
" 251 | } 252 | ], 253 | "Replace \"login\" with this text.": [ 254 | { 255 | "group": "login", 256 | "type": "String", 257 | "optional": false, 258 | "field": "param2", 259 | "description": "Group "login"
" 260 | }, 261 | { 262 | "group": "login", 263 | "type": "String", 264 | "optional": false, 265 | "field": "param3", 266 | "defaultValue": "Default Value", 267 | "description": "Group "login" with default Value
" 268 | } 269 | ] 270 | } 271 | }, 272 | "success": { 273 | "fields": { 274 | "201 - Everything ok, replace \"201\" with this text.": [ 275 | { 276 | "group": "201", 277 | "type": "String", 278 | "optional": false, 279 | "field": "success2", 280 | "description": "Group "201"
" 281 | }, 282 | { 283 | "group": "201", 284 | "type": "String", 285 | "optional": false, 286 | "field": "success3", 287 | "defaultValue": "Default Value", 288 | "description": "Group "201" with default Value
" 289 | } 290 | ], 291 | "Success 200": [ 292 | { 293 | "group": "Success 200", 294 | "type": "String", 295 | "optional": false, 296 | "field": "success1", 297 | "description": "No Group, automatically set "Success 200"
" 298 | } 299 | ] 300 | } 301 | }, 302 | "error": { 303 | "fields": { 304 | "400": [ 305 | { 306 | "group": "400", 307 | "type": "String", 308 | "optional": false, 309 | "field": "error2", 310 | "description": "Undefined Group "400"
" 311 | } 312 | ], 313 | "401 - Oh oh, replace \"401\" with this text": [ 314 | { 315 | "group": "401", 316 | "type": "String", 317 | "optional": false, 318 | "field": "error3", 319 | "description": "Group "401"
" 320 | } 321 | ], 322 | "Error 4xx": [ 323 | { 324 | "group": "Error 4xx", 325 | "type": "String", 326 | "optional": false, 327 | "field": "error1", 328 | "description": "No Group automatically set "Error 4xx"
" 329 | } 330 | ] 331 | } 332 | }, 333 | "filename": "src/parameter_grouping.js", 334 | "groupTitle": "Grouping", 335 | "sampleRequest": [ 336 | { 337 | "url": "https://api.github.com/v1/test/:id" 338 | } 339 | ] 340 | }, 341 | { 342 | "type": "get", 343 | "url": "/header/:id", 344 | "title": "Parameters", 345 | "name": "GetHeader", 346 | "group": "Header", 347 | "version": "0.5.0", 348 | "description": "Test for @apiHeader (same as @apiParam)
", 349 | "header": { 350 | "fields": { 351 | "Header": [ 352 | { 353 | "group": "Header", 354 | "type": "String", 355 | "optional": false, 356 | "field": "header1", 357 | "description": "Parameter with type and description.
" 358 | }, 359 | { 360 | "group": "Header", 361 | "type": "String", 362 | "optional": false, 363 | "field": "header2", 364 | "description": "" 365 | }, 366 | { 367 | "group": "Header", 368 | "type": "String", 369 | "optional": false, 370 | "field": "header3", 371 | "defaultValue": "Default Value", 372 | "description": "Parameter with type, description and default value.
" 373 | }, 374 | { 375 | "group": "Header", 376 | "type": "String", 377 | "optional": false, 378 | "field": "header4", 379 | "defaultValue": "Default Value", 380 | "description": "" 381 | }, 382 | { 383 | "group": "Header", 384 | "optional": false, 385 | "field": "header5", 386 | "description": "Basic Parameter with description.
" 387 | }, 388 | { 389 | "group": "Header", 390 | "optional": false, 391 | "field": "header6", 392 | "description": "" 393 | }, 394 | { 395 | "group": "Header", 396 | "optional": false, 397 | "field": "header7", 398 | "defaultValue": "Default Value", 399 | "description": "Basic Parameter with description and default value.
" 400 | }, 401 | { 402 | "group": "Header", 403 | "optional": false, 404 | "field": "header8", 405 | "defaultValue": "Default Value", 406 | "description": "" 407 | }, 408 | { 409 | "group": "Header", 410 | "optional": true, 411 | "field": "header9", 412 | "description": "Optional basic Parameter with description.
" 413 | }, 414 | { 415 | "group": "Header", 416 | "optional": true, 417 | "field": "header10", 418 | "description": "" 419 | }, 420 | { 421 | "group": "Header", 422 | "optional": true, 423 | "field": "header11", 424 | "defaultValue": "Default Value", 425 | "description": "Optional basic Parameter with description and default value.
" 426 | }, 427 | { 428 | "group": "Header", 429 | "optional": true, 430 | "field": "header12", 431 | "defaultValue": "Default Value", 432 | "description": "" 433 | }, 434 | { 435 | "group": "Header", 436 | "type": "String", 437 | "optional": true, 438 | "field": "header13", 439 | "description": "Optional Parameter with type and description.
" 440 | }, 441 | { 442 | "group": "Header", 443 | "type": "String", 444 | "optional": true, 445 | "field": "header14", 446 | "description": "" 447 | }, 448 | { 449 | "group": "Header", 450 | "type": "String", 451 | "optional": true, 452 | "field": "header15", 453 | "defaultValue": "Default Value", 454 | "description": "Optional Parameter with type, description and default value.
" 455 | }, 456 | { 457 | "group": "Header", 458 | "type": "String", 459 | "optional": true, 460 | "field": "header16", 461 | "defaultValue": "Default Value", 462 | "description": "" 463 | } 464 | ] 465 | } 466 | }, 467 | "filename": "src/api_header.js", 468 | "groupTitle": "Header", 469 | "sampleRequest": [ 470 | { 471 | "url": "https://api.github.com/v1/header/:id" 472 | } 473 | ] 474 | }, 475 | { 476 | "type": "get", 477 | "url": "/header/example/", 478 | "title": "Header Example", 479 | "name": "GetHeaderExample", 480 | "group": "Header", 481 | "version": "0.5.0", 482 | "description": "Usage of @headerExample.
", 483 | "header": { 484 | "examples": [ 485 | { 486 | "title": "An example:", 487 | "content": "curl -i http://localhost/header/example/", 488 | "type": "json" 489 | } 490 | ] 491 | }, 492 | "filename": "src/api_header_example.js", 493 | "groupTitle": "Header", 494 | "sampleRequest": [ 495 | { 496 | "url": "https://api.github.com/v1/header/example/" 497 | } 498 | ] 499 | }, 500 | { 501 | "type": "get", 502 | "url": "/language/clojure", 503 | "title": "Clojure", 504 | "name": "GetLanguageClojure", 505 | "group": "Language", 506 | "version": "0.4.0", 507 | "description": "Test for Clojure Comment-Syntax.
", 508 | "filename": "src/language.clj", 509 | "groupTitle": "Language", 510 | "sampleRequest": [ 511 | { 512 | "url": "https://api.github.com/v1/language/clojure" 513 | } 514 | ] 515 | }, 516 | { 517 | "type": "get", 518 | "url": "/language/clojure/indented1", 519 | "title": "Clojure indented 1", 520 | "name": "GetLanguageClojureIndented1", 521 | "group": "Language", 522 | "version": "0.4.0", 523 | "examples": [ 524 | { 525 | "title": "Test for indented comment.", 526 | "content": "This is example line 2.\nThis is example line 3.\n\t\t Line 4 indented (with tab at beginning).\n\t Line 5 indented.\nThis is example line 6.", 527 | "type": "json" 528 | } 529 | ], 530 | "filename": "src/language.clj", 531 | "groupTitle": "Language", 532 | "sampleRequest": [ 533 | { 534 | "url": "https://api.github.com/v1/language/clojure/indented1" 535 | } 536 | ] 537 | }, 538 | { 539 | "type": "get", 540 | "url": "/language/coffeescript", 541 | "title": "CoffeeScript", 542 | "name": "GetLanguageCoffeeScript", 543 | "group": "Language", 544 | "version": "0.4.0", 545 | "description": "Test for CoffeeScript Comment-Syntax.
", 546 | "filename": "src/language.coffee", 547 | "groupTitle": "Language", 548 | "sampleRequest": [ 549 | { 550 | "url": "https://api.github.com/v1/language/coffeescript" 551 | } 552 | ] 553 | }, 554 | { 555 | "type": "get", 556 | "url": "/language/coffeescript/indented1", 557 | "title": "CoffeeScript indented 1", 558 | "name": "GetLanguageCoffeeScriptIndented1", 559 | "group": "Language", 560 | "version": "0.4.0", 561 | "examples": [ 562 | { 563 | "title": "Test for indented comment.", 564 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 565 | "type": "json" 566 | } 567 | ], 568 | "filename": "src/language.coffee", 569 | "groupTitle": "Language", 570 | "sampleRequest": [ 571 | { 572 | "url": "https://api.github.com/v1/language/coffeescript/indented1" 573 | } 574 | ] 575 | }, 576 | { 577 | "type": "get", 578 | "url": "/language/coffeescript/indented2", 579 | "title": "CoffeeScript indented 2", 580 | "name": "GetLanguageCoffeeScriptIndented2", 581 | "group": "Language", 582 | "version": "0.4.0", 583 | "examples": [ 584 | { 585 | "title": "Test for indented comment.", 586 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 587 | "type": "json" 588 | } 589 | ], 590 | "filename": "src/language.coffee", 591 | "groupTitle": "Language", 592 | "sampleRequest": [ 593 | { 594 | "url": "https://api.github.com/v1/language/coffeescript/indented2" 595 | } 596 | ] 597 | }, 598 | { 599 | "type": "get", 600 | "url": "/language/erlang", 601 | "title": "Erlang", 602 | "name": "GetLanguageErlang", 603 | "group": "Language", 604 | "version": "0.4.0", 605 | "description": "Test for Erlang Comment-Syntax.
", 606 | "filename": "src/language.erl", 607 | "groupTitle": "Language", 608 | "sampleRequest": [ 609 | { 610 | "url": "https://api.github.com/v1/language/erlang" 611 | } 612 | ] 613 | }, 614 | { 615 | "type": "get", 616 | "url": "/language/erlang/indented1", 617 | "title": "Erlang indented 1", 618 | "name": "GetLanguageErlangIndented1", 619 | "group": "Language", 620 | "version": "0.4.0", 621 | "examples": [ 622 | { 623 | "title": "Test for indented comment.", 624 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 625 | "type": "json" 626 | } 627 | ], 628 | "filename": "src/language.erl", 629 | "groupTitle": "Language", 630 | "sampleRequest": [ 631 | { 632 | "url": "https://api.github.com/v1/language/erlang/indented1" 633 | } 634 | ] 635 | }, 636 | { 637 | "type": "get", 638 | "url": "/language/erlang/indented2", 639 | "title": "Erlang indented 2", 640 | "name": "GetLanguageErlangIndented2", 641 | "group": "Language", 642 | "version": "0.4.0", 643 | "examples": [ 644 | { 645 | "title": "Test for indented comment.", 646 | "content": "This is example line 2.\nThis is example line 3.\nLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.", 647 | "type": "json" 648 | } 649 | ], 650 | "filename": "src/language.erl", 651 | "groupTitle": "Language", 652 | "sampleRequest": [ 653 | { 654 | "url": "https://api.github.com/v1/language/erlang/indented2" 655 | } 656 | ] 657 | }, 658 | { 659 | "type": "get", 660 | "url": "/language/javascript", 661 | "title": "JavaScript", 662 | "name": "GetLanguageJavaScript", 663 | "group": "Language", 664 | "version": "0.4.0", 665 | "description": "Test for JavaScript Comment-Syntax.
", 666 | "filename": "src/language.js", 667 | "groupTitle": "Language", 668 | "sampleRequest": [ 669 | { 670 | "url": "https://api.github.com/v1/language/javascript" 671 | } 672 | ] 673 | }, 674 | { 675 | "type": "get", 676 | "url": "/language/javascript/indented1", 677 | "title": "JavaScript indented 1", 678 | "name": "GetLanguageJavaScriptIndented1", 679 | "group": "Language", 680 | "version": "0.4.0", 681 | "examples": [ 682 | { 683 | "title": "Test for indented comment.", 684 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 685 | "type": "json" 686 | } 687 | ], 688 | "filename": "src/language.js", 689 | "groupTitle": "Language", 690 | "sampleRequest": [ 691 | { 692 | "url": "https://api.github.com/v1/language/javascript/indented1" 693 | } 694 | ] 695 | }, 696 | { 697 | "type": "get", 698 | "url": "/language/javascript/indented2", 699 | "title": "JavaScript indented 2", 700 | "name": "GetLanguageJavaScriptIndented2", 701 | "group": "Language", 702 | "version": "0.4.0", 703 | "examples": [ 704 | { 705 | "title": "Test for indented comment.", 706 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 707 | "type": "json" 708 | } 709 | ], 710 | "filename": "src/language.js", 711 | "groupTitle": "Language", 712 | "sampleRequest": [ 713 | { 714 | "url": "https://api.github.com/v1/language/javascript/indented2" 715 | } 716 | ] 717 | }, 718 | { 719 | "type": "get", 720 | "url": "/language/perl", 721 | "title": "Perl", 722 | "name": "GetLanguagePerl", 723 | "group": "Language", 724 | "version": "0.4.0", 725 | "description": "Test for Perl Comment-Syntax.
", 726 | "filename": "src/language.pm", 727 | "groupTitle": "Language", 728 | "sampleRequest": [ 729 | { 730 | "url": "https://api.github.com/v1/language/perl" 731 | } 732 | ] 733 | }, 734 | { 735 | "type": "get", 736 | "url": "/language/perl/indented1", 737 | "title": "Perl indented 1", 738 | "name": "GetLanguagePerlIndented1", 739 | "group": "Language", 740 | "version": "0.4.0", 741 | "examples": [ 742 | { 743 | "title": "Test for indented comment.", 744 | "content": "This is example line 2.\nThis is example line 3.\n\t\tLine 4 indented (with tab at beginning).\n\tLine 5 indented.\nThis is example line 6.", 745 | "type": "json" 746 | } 747 | ], 748 | "filename": "src/language.pm", 749 | "groupTitle": "Language", 750 | "sampleRequest": [ 751 | { 752 | "url": "https://api.github.com/v1/language/perl/indented1" 753 | } 754 | ] 755 | }, 756 | { 757 | "type": "get", 758 | "url": "/language/perl/indented2", 759 | "title": "Perl indented 2", 760 | "name": "GetLanguagePerlIndented2", 761 | "group": "Language", 762 | "version": "0.4.0", 763 | "examples": [ 764 | { 765 | "title": "Test for indented comment.", 766 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 767 | "type": "json" 768 | } 769 | ], 770 | "filename": "src/language.pm", 771 | "groupTitle": "Language", 772 | "sampleRequest": [ 773 | { 774 | "url": "https://api.github.com/v1/language/perl/indented2" 775 | } 776 | ] 777 | }, 778 | { 779 | "type": "get", 780 | "url": "/language/perl/podcut", 781 | "title": "Perl comment with pod and cut", 782 | "name": "GetLanguagePerlPodCut", 783 | "group": "Language", 784 | "version": "0.4.0", 785 | "examples": [ 786 | { 787 | "title": "Test for indented comment.", 788 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 789 | "type": "json" 790 | } 791 | ], 792 | "filename": "src/language.pm", 793 | "groupTitle": "Language", 794 | "sampleRequest": [ 795 | { 796 | "url": "https://api.github.com/v1/language/perl/podcut" 797 | } 798 | ] 799 | }, 800 | { 801 | "type": "get", 802 | "url": "/language/python", 803 | "title": "Python", 804 | "name": "GetLanguagePython", 805 | "group": "Language", 806 | "version": "0.4.0", 807 | "description": "Test for Python Comment-Syntax.
", 808 | "filename": "src/language.py", 809 | "groupTitle": "Language", 810 | "sampleRequest": [ 811 | { 812 | "url": "https://api.github.com/v1/language/python" 813 | } 814 | ] 815 | }, 816 | { 817 | "type": "get", 818 | "url": "/language/python/indented1", 819 | "title": "Python indented 1", 820 | "name": "GetLanguagePythonIndented1", 821 | "group": "Language", 822 | "version": "0.4.0", 823 | "examples": [ 824 | { 825 | "title": "Test for indented comment.", 826 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 827 | "type": "json" 828 | } 829 | ], 830 | "filename": "src/language.py", 831 | "groupTitle": "Language", 832 | "sampleRequest": [ 833 | { 834 | "url": "https://api.github.com/v1/language/python/indented1" 835 | } 836 | ] 837 | }, 838 | { 839 | "type": "get", 840 | "url": "/language/python/indented2", 841 | "title": "Python indented 2", 842 | "name": "GetLanguagePythonIndented2", 843 | "group": "Language", 844 | "version": "0.4.0", 845 | "examples": [ 846 | { 847 | "title": "Test for indented comment.", 848 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 849 | "type": "json" 850 | } 851 | ], 852 | "filename": "src/language.py", 853 | "groupTitle": "Language", 854 | "sampleRequest": [ 855 | { 856 | "url": "https://api.github.com/v1/language/python/indented2" 857 | } 858 | ] 859 | }, 860 | { 861 | "type": "get", 862 | "url": "/language/ruby", 863 | "title": "Ruby", 864 | "name": "GetLanguageRuby", 865 | "group": "Language", 866 | "version": "0.4.0", 867 | "description": "Test for Ruby Comment-Syntax.
", 868 | "filename": "src/language.rb", 869 | "groupTitle": "Language", 870 | "sampleRequest": [ 871 | { 872 | "url": "https://api.github.com/v1/language/ruby" 873 | } 874 | ] 875 | }, 876 | { 877 | "type": "get", 878 | "url": "/language/ruby/indented1", 879 | "title": "Ruby indented 1", 880 | "name": "GetLanguageRubyIndented1", 881 | "group": "Language", 882 | "version": "0.4.0", 883 | "examples": [ 884 | { 885 | "title": "Test for indented comment.", 886 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 887 | "type": "json" 888 | } 889 | ], 890 | "filename": "src/language.rb", 891 | "groupTitle": "Language", 892 | "sampleRequest": [ 893 | { 894 | "url": "https://api.github.com/v1/language/ruby/indented1" 895 | } 896 | ] 897 | }, 898 | { 899 | "type": "get", 900 | "url": "/language/ruby/indented2", 901 | "title": "Ruby indented 2", 902 | "name": "GetLanguageRubyIndented2", 903 | "group": "Language", 904 | "version": "0.4.0", 905 | "examples": [ 906 | { 907 | "title": "Test for indented comment.", 908 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 909 | "type": "json" 910 | } 911 | ], 912 | "filename": "src/language.rb", 913 | "groupTitle": "Language", 914 | "sampleRequest": [ 915 | { 916 | "url": "https://api.github.com/v1/language/ruby/indented2" 917 | } 918 | ] 919 | }, 920 | { 921 | "type": "get", 922 | "url": "/markdown/:id", 923 | "title": "Markdown", 924 | "name": "GetMarkdown", 925 | "group": "Markdown", 926 | "version": "0.6.0", 927 | "description": "Enable markdown for all description fields.
This text is in a separate p.
Multiline markdown text, output in one line.
", 928 | "parameter": { 929 | "fields": { 930 | "Parameter": [ 931 | { 932 | "group": "Parameter", 933 | "type": "String", 934 | "optional": false, 935 | "field": "param1", 936 | "description": "This is a markdown apiParam
Separate line.
" 937 | } 938 | ] 939 | } 940 | }, 941 | "filename": "src/markdown.js", 942 | "groupTitle": "Markdown", 943 | "sampleRequest": [ 944 | { 945 | "url": "https://api.github.com/v1/markdown/:id" 946 | } 947 | ] 948 | }, 949 | { 950 | "type": "get", 951 | "url": "/param/:id", 952 | "title": "Errors", 953 | "name": "GetError", 954 | "group": "Param", 955 | "version": "0.1.0", 956 | "description": "Returned error parameters. Syntax is the same as for @apiParam
", 957 | "error": { 958 | "fields": { 959 | "Error 4xx": [ 960 | { 961 | "group": "Error 4xx", 962 | "optional": false, 963 | "field": "error1Error", 964 | "description": "This is Error 1.
" 965 | }, 966 | { 967 | "group": "Error 4xx", 968 | "optional": false, 969 | "field": "error2Error", 970 | "description": "This is Error 2.
" 971 | } 972 | ] 973 | } 974 | }, 975 | "filename": "src/api_param.js", 976 | "groupTitle": "Param", 977 | "sampleRequest": [ 978 | { 979 | "url": "https://api.github.com/v1/param/:id" 980 | } 981 | ] 982 | }, 983 | { 984 | "type": "get", 985 | "url": "/param/:id", 986 | "title": "Parameters", 987 | "name": "GetParam", 988 | "group": "Param", 989 | "version": "0.1.1", 990 | "description": "Parameters and different Versions: 0.1.1
", 991 | "parameter": { 992 | "fields": { 993 | "Parameter": [ 994 | { 995 | "group": "Parameter", 996 | "optional": false, 997 | "field": "param1", 998 | "description": "Parameter and description.
" 999 | }, 1000 | { 1001 | "group": "Parameter", 1002 | "optional": false, 1003 | "field": "param2", 1004 | "description": "" 1005 | }, 1006 | { 1007 | "group": "Parameter", 1008 | "optional": false, 1009 | "field": "param3", 1010 | "defaultValue": "Default Value", 1011 | "description": "Parameter, default value and description.
" 1012 | }, 1013 | { 1014 | "group": "Parameter", 1015 | "optional": false, 1016 | "field": "param4", 1017 | "defaultValue": "Default Value", 1018 | "description": "" 1019 | }, 1020 | { 1021 | "group": "Parameter", 1022 | "optional": true, 1023 | "field": "param5", 1024 | "description": "Optional parameter and description.
" 1025 | }, 1026 | { 1027 | "group": "Parameter", 1028 | "optional": true, 1029 | "field": "param6", 1030 | "description": "" 1031 | }, 1032 | { 1033 | "group": "Parameter", 1034 | "optional": true, 1035 | "field": "param7", 1036 | "defaultValue": "Default Value", 1037 | "description": "Optional parameter, default value and description.
" 1038 | }, 1039 | { 1040 | "group": "Parameter", 1041 | "optional": true, 1042 | "field": "param8", 1043 | "defaultValue": "Default Value", 1044 | "description": "" 1045 | }, 1046 | { 1047 | "group": "Parameter", 1048 | "type": "String", 1049 | "optional": false, 1050 | "field": "param9", 1051 | "description": "Type, parameter and description.
" 1052 | }, 1053 | { 1054 | "group": "Parameter", 1055 | "type": "String", 1056 | "optional": false, 1057 | "field": "param10", 1058 | "description": "" 1059 | }, 1060 | { 1061 | "group": "Parameter", 1062 | "type": "String", 1063 | "optional": false, 1064 | "field": "param11", 1065 | "defaultValue": "Default Value", 1066 | "description": "Type, parameter and default value.
" 1067 | }, 1068 | { 1069 | "group": "Parameter", 1070 | "type": "String", 1071 | "optional": false, 1072 | "field": "param12", 1073 | "defaultValue": "Default Value", 1074 | "description": "" 1075 | }, 1076 | { 1077 | "group": "Parameter", 1078 | "type": "String", 1079 | "optional": true, 1080 | "field": "param13", 1081 | "description": "Type, optional parameter and description.
" 1082 | }, 1083 | { 1084 | "group": "Parameter", 1085 | "type": "String", 1086 | "optional": true, 1087 | "field": "param14", 1088 | "description": "" 1089 | }, 1090 | { 1091 | "group": "Parameter", 1092 | "type": "String", 1093 | "optional": true, 1094 | "field": "param15", 1095 | "defaultValue": "Default Value", 1096 | "description": "Type, optional parameter, default value and description.
" 1097 | }, 1098 | { 1099 | "group": "Parameter", 1100 | "type": "String", 1101 | "optional": true, 1102 | "field": "param26", 1103 | "defaultValue": "Default Value", 1104 | "description": "" 1105 | }, 1106 | { 1107 | "group": "Parameter", 1108 | "type": "String", 1109 | "size": "4,8", 1110 | "optional": false, 1111 | "field": "param17", 1112 | "description": "Type, size, parameter and description.
" 1113 | }, 1114 | { 1115 | "group": "Parameter", 1116 | "type": "Number", 1117 | "size": "1-3", 1118 | "optional": false, 1119 | "field": "param18", 1120 | "description": "Type, size, parameter and description.
" 1121 | }, 1122 | { 1123 | "group": "Parameter", 1124 | "type": "String", 1125 | "size": "4,8", 1126 | "optional": false, 1127 | "field": "param19", 1128 | "defaultValue": "Default Value", 1129 | "description": "Type, size, parameter, default value and description.
" 1130 | }, 1131 | { 1132 | "group": "Parameter", 1133 | "type": "Number", 1134 | "size": "1-3", 1135 | "optional": false, 1136 | "field": "param20", 1137 | "defaultValue": "1", 1138 | "description": "Type, size, parameter, default value and description.
" 1139 | }, 1140 | { 1141 | "group": "Parameter", 1142 | "type": "String", 1143 | "allowedValues": [ 1144 | "\"value 1\"" 1145 | ], 1146 | "optional": false, 1147 | "field": "param21", 1148 | "description": "Type, parameter and allowed string value.
" 1149 | }, 1150 | { 1151 | "group": "Parameter", 1152 | "type": "String", 1153 | "allowedValues": [ 1154 | "\"value 1\"", 1155 | "\"value 2\"" 1156 | ], 1157 | "optional": false, 1158 | "field": "param22", 1159 | "description": "Type, parameter and allowed list of string values.
" 1160 | }, 1161 | { 1162 | "group": "Parameter", 1163 | "type": "Number", 1164 | "allowedValues": [ 1165 | "4711" 1166 | ], 1167 | "optional": false, 1168 | "field": "param23", 1169 | "description": "Type, parameter and allowed value.
" 1170 | }, 1171 | { 1172 | "group": "Parameter", 1173 | "type": "Number", 1174 | "allowedValues": [ 1175 | "4711", 1176 | "4712" 1177 | ], 1178 | "optional": false, 1179 | "field": "param24", 1180 | "description": "Type, parameter and allowed list of values.
" 1181 | }, 1182 | { 1183 | "group": "Parameter", 1184 | "type": "String", 1185 | "size": "1,10", 1186 | "allowedValues": [ 1187 | "\"value 1\"" 1188 | ], 1189 | "optional": false, 1190 | "field": "param25", 1191 | "description": "Type, size, parameter and allowed string value.
" 1192 | }, 1193 | { 1194 | "group": "Parameter", 1195 | "type": "Number", 1196 | "size": "1-9999", 1197 | "allowedValues": [ 1198 | "4711" 1199 | ], 1200 | "optional": false, 1201 | "field": "param27", 1202 | "description": "Type, size, parameter and allowed value.
" 1203 | }, 1204 | { 1205 | "group": "Parameter", 1206 | "type": "Number", 1207 | "size": "1-9999", 1208 | "allowedValues": [ 1209 | "4711", 1210 | "4712" 1211 | ], 1212 | "optional": false, 1213 | "field": "param28", 1214 | "description": "Type, size, parameter and allowed list of values.
" 1215 | }, 1216 | { 1217 | "group": "Parameter", 1218 | "type": "Custom", 1219 | "optional": false, 1220 | "field": "param29", 1221 | "description": "Type with markdown link.
" 1222 | } 1223 | ] 1224 | } 1225 | }, 1226 | "filename": "src/api_param.js", 1227 | "groupTitle": "Param", 1228 | "sampleRequest": [ 1229 | { 1230 | "url": "https://api.github.com/v1/param/:id" 1231 | } 1232 | ] 1233 | }, 1234 | { 1235 | "type": "get", 1236 | "url": "/param/:id", 1237 | "title": "Parameters", 1238 | "name": "GetParam", 1239 | "group": "Param", 1240 | "version": "0.1.0", 1241 | "description": "Parameters and different Versions: 0.1.0
", 1242 | "parameter": { 1243 | "fields": { 1244 | "Parameter": [ 1245 | { 1246 | "group": "Parameter", 1247 | "type": "String", 1248 | "optional": false, 1249 | "field": "param0", 1250 | "description": "This param is removed in 0.1.1.
" 1251 | }, 1252 | { 1253 | "group": "Parameter", 1254 | "type": "String", 1255 | "optional": false, 1256 | "field": "param1", 1257 | "description": "This is an old text.
" 1258 | }, 1259 | { 1260 | "group": "Parameter", 1261 | "type": "String", 1262 | "optional": false, 1263 | "field": "param2", 1264 | "description": "" 1265 | }, 1266 | { 1267 | "group": "Parameter", 1268 | "type": "String", 1269 | "optional": false, 1270 | "field": "param3", 1271 | "defaultValue": "Default Value", 1272 | "description": "Parameter with type, description and default value.
" 1273 | }, 1274 | { 1275 | "group": "Parameter", 1276 | "type": "String", 1277 | "optional": false, 1278 | "field": "param4", 1279 | "defaultValue": "Default Value", 1280 | "description": "" 1281 | }, 1282 | { 1283 | "group": "Parameter", 1284 | "optional": false, 1285 | "field": "param5", 1286 | "description": "Basic Parameter with description.
" 1287 | }, 1288 | { 1289 | "group": "Parameter", 1290 | "optional": false, 1291 | "field": "param6", 1292 | "description": "" 1293 | }, 1294 | { 1295 | "group": "Parameter", 1296 | "optional": false, 1297 | "field": "param7", 1298 | "defaultValue": "Default Value", 1299 | "description": "Basic Parameter with description and default value.
" 1300 | }, 1301 | { 1302 | "group": "Parameter", 1303 | "optional": false, 1304 | "field": "param8", 1305 | "defaultValue": "Default Value", 1306 | "description": "" 1307 | }, 1308 | { 1309 | "group": "Parameter", 1310 | "optional": true, 1311 | "field": "param9", 1312 | "description": "Optional basic Parameter with description.
" 1313 | }, 1314 | { 1315 | "group": "Parameter", 1316 | "optional": true, 1317 | "field": "param10", 1318 | "description": "" 1319 | }, 1320 | { 1321 | "group": "Parameter", 1322 | "optional": true, 1323 | "field": "param11", 1324 | "defaultValue": "Default Value", 1325 | "description": "Optional basic Parameter with description and default value.
" 1326 | }, 1327 | { 1328 | "group": "Parameter", 1329 | "optional": true, 1330 | "field": "param12", 1331 | "defaultValue": "Default Value", 1332 | "description": "" 1333 | }, 1334 | { 1335 | "group": "Parameter", 1336 | "type": "String", 1337 | "optional": true, 1338 | "field": "param13", 1339 | "description": "Optional Parameter with type and description.
" 1340 | }, 1341 | { 1342 | "group": "Parameter", 1343 | "type": "String", 1344 | "optional": true, 1345 | "field": "param14", 1346 | "description": "" 1347 | }, 1348 | { 1349 | "group": "Parameter", 1350 | "type": "String", 1351 | "optional": true, 1352 | "field": "param15", 1353 | "defaultValue": "Default Value", 1354 | "description": "Optional Parameter with type, description and default value.
" 1355 | }, 1356 | { 1357 | "group": "Parameter", 1358 | "type": "String", 1359 | "optional": true, 1360 | "field": "param16", 1361 | "defaultValue": "Default Value", 1362 | "description": "" 1363 | } 1364 | ] 1365 | } 1366 | }, 1367 | "filename": "src/api_param.js", 1368 | "groupTitle": "Param", 1369 | "sampleRequest": [ 1370 | { 1371 | "url": "https://api.github.com/v1/param/:id" 1372 | } 1373 | ] 1374 | }, 1375 | { 1376 | "type": "get", 1377 | "url": "/param/example/", 1378 | "title": "Param Example", 1379 | "name": "GetParamExample", 1380 | "group": "Param", 1381 | "version": "0.8.0", 1382 | "description": "Usage of @apiParamExample.
", 1383 | "examples": [ 1384 | { 1385 | "title": "A common example:", 1386 | "content": "curl -i http://localhost/param/example/", 1387 | "type": "json" 1388 | } 1389 | ], 1390 | "parameter": { 1391 | "fields": { 1392 | "Parameter": [ 1393 | { 1394 | "group": "Parameter", 1395 | "type": "String", 1396 | "optional": false, 1397 | "field": "name", 1398 | "description": "Fullname.
" 1399 | } 1400 | ] 1401 | }, 1402 | "examples": [ 1403 | { 1404 | "title": "A JSON example:", 1405 | "content": "{\n \"name\": \"John Doe\"\n}", 1406 | "type": "json" 1407 | } 1408 | ] 1409 | }, 1410 | "filename": "src/api_param_example.js", 1411 | "groupTitle": "Param", 1412 | "sampleRequest": [ 1413 | { 1414 | "url": "https://api.github.com/v1/param/example/" 1415 | } 1416 | ] 1417 | }, 1418 | { 1419 | "type": "get", 1420 | "url": "/param/:id", 1421 | "title": "Success", 1422 | "name": "GetSuccess", 1423 | "group": "Param", 1424 | "version": "0.1.0", 1425 | "description": "Returned success parameters. Syntax is the same as for @apiParam
", 1426 | "error": { 1427 | "fields": { 1428 | "Error 4xx": [ 1429 | { 1430 | "group": "Error 4xx", 1431 | "optional": false, 1432 | "field": "success1", 1433 | "description": "This is Success 1.
" 1434 | }, 1435 | { 1436 | "group": "Error 4xx", 1437 | "optional": false, 1438 | "field": "success2", 1439 | "description": "This is Success 2.
" 1440 | } 1441 | ] 1442 | } 1443 | }, 1444 | "filename": "src/api_param.js", 1445 | "groupTitle": "Param", 1446 | "sampleRequest": [ 1447 | { 1448 | "url": "https://api.github.com/v1/param/:id" 1449 | } 1450 | ] 1451 | }, 1452 | { 1453 | "type": "get", 1454 | "url": "/permission/", 1455 | "title": "Permission", 1456 | "name": "GetPermission", 1457 | "group": "Permission", 1458 | "version": "0.8.0", 1459 | "description": "@apiPermission test.
", 1460 | "permission": [ 1461 | { 1462 | "name": "permission_admin", 1463 | "title": "Admin access.", 1464 | "description": "Some description.
" 1465 | } 1466 | ], 1467 | "filename": "src/api_permission.js", 1468 | "groupTitle": "Permission", 1469 | "sampleRequest": [ 1470 | { 1471 | "url": "https://api.github.com/v1/permission/" 1472 | } 1473 | ] 1474 | }, 1475 | { 1476 | "type": "get", 1477 | "url": "/permission/", 1478 | "title": "Permission", 1479 | "name": "GetPermission", 1480 | "group": "Permission", 1481 | "version": "0.8.0", 1482 | "description": "@apiPermission test.
", 1483 | "permission": [ 1484 | { 1485 | "name": "permission_admin", 1486 | "title": "Admin access.", 1487 | "description": "Some description.
" 1488 | }, 1489 | { 1490 | "name": "permission_user", 1491 | "title": "User access.", 1492 | "description": "" 1493 | } 1494 | ], 1495 | "filename": "src/api_permission.js", 1496 | "groupTitle": "Permission", 1497 | "sampleRequest": [ 1498 | { 1499 | "url": "https://api.github.com/v1/permission/" 1500 | } 1501 | ] 1502 | }, 1503 | { 1504 | "type": "get", 1505 | "url": "/indent/trim/multi/spaces", 1506 | "title": "Trim multi line (spaces)", 1507 | "group": "indent", 1508 | "description": "Text line 1 (Begin: 4xSpaces (3 removed)). Text line 2 (Begin: 3xSpaces (3 removed), End: 2xSpaces).
", 1509 | "version": "0.0.0", 1510 | "filename": "src/indent.js", 1511 | "groupTitle": "Indent", 1512 | "name": "GetIndentTrimMultiSpaces", 1513 | "sampleRequest": [ 1514 | { 1515 | "url": "https://api.github.com/v1/indent/trim/multi/spaces" 1516 | } 1517 | ] 1518 | }, 1519 | { 1520 | "type": "get", 1521 | "url": "/indent/trim/multi/tabs", 1522 | "title": "Trim multi line (tabs)", 1523 | "group": "indent", 1524 | "description": "Text line 1 (Begin: 3xTab (2 removed)). \t\tText line 2 (Begin: 2x Tab (2 removed), End: 1xTab).
", 1525 | "version": "0.0.0", 1526 | "filename": "src/indent.js", 1527 | "groupTitle": "Indent", 1528 | "name": "GetIndentTrimMultiTabs", 1529 | "sampleRequest": [ 1530 | { 1531 | "url": "https://api.github.com/v1/indent/trim/multi/tabs" 1532 | } 1533 | ] 1534 | }, 1535 | { 1536 | "type": "get", 1537 | "url": "/indent/trim/multi/tabs/and/space", 1538 | "title": "Trim multi line (tabs and space)", 1539 | "group": "indent", 1540 | "description": "Text line 1 (Begin: 1xTab, 2xSpaces). Text line 2 (Begin: 3xSpaces, End: 1xTab).
", 1541 | "version": "0.0.0", 1542 | "filename": "src/indent.js", 1543 | "groupTitle": "Indent", 1544 | "name": "GetIndentTrimMultiTabsAndSpace", 1545 | "sampleRequest": [ 1546 | { 1547 | "url": "https://api.github.com/v1/indent/trim/multi/tabs/and/space" 1548 | } 1549 | ] 1550 | }, 1551 | { 1552 | "type": "get", 1553 | "url": "/indent/trim/single", 1554 | "title": "Trim single line", 1555 | "group": "indent", 1556 | "description": "Text line 1 (Begin: 3xSpaces (3 removed), End: 1xSpace).
", 1557 | "version": "0.0.0", 1558 | "filename": "src/indent.js", 1559 | "groupTitle": "Indent", 1560 | "name": "GetIndentTrimSingle", 1561 | "sampleRequest": [ 1562 | { 1563 | "url": "https://api.github.com/v1/indent/trim/single" 1564 | } 1565 | ] 1566 | }, 1567 | { 1568 | "type": "get", 1569 | "url": "/indent/word", 1570 | "title": "Indent a word", 1571 | "group": "indent", 1572 | "description": "text.
", 1573 | "version": "0.0.0", 1574 | "filename": "src/indent.js", 1575 | "groupTitle": "Indent", 1576 | "name": "GetIndentWord", 1577 | "sampleRequest": [ 1578 | { 1579 | "url": "https://api.github.com/v1/indent/word" 1580 | } 1581 | ] 1582 | } 1583 | ] 1584 | -------------------------------------------------------------------------------- /v0.2.0/fixtures/api_data.js: -------------------------------------------------------------------------------- 1 | define({ "api": [ 2 | { 3 | "type": "get", 4 | "url": "/define", 5 | "title": "Define", 6 | "name": "GetDefine", 7 | "group": "Define", 8 | "version": "0.8.0", 9 | "description": "Example of @apiDefine and @apiUse
", 10 | "parameter": { 11 | "fields": { 12 | "Parameter": [ 13 | { 14 | "group": "Parameter", 15 | "optional": false, 16 | "field": "field3", 17 | "description": "This is Field 3 (local).
" 18 | }, 19 | { 20 | "group": "Parameter", 21 | "optional": false, 22 | "field": "field1", 23 | "description": "This is Field 1.
" 24 | }, 25 | { 26 | "group": "Parameter", 27 | "optional": false, 28 | "field": "field2", 29 | "description": "This is Field 2.
" 30 | } 31 | ] 32 | } 33 | }, 34 | "filename": "src/api_define.js", 35 | "groupTitle": "Define", 36 | "sampleRequest": [ 37 | { 38 | "url": "https://api.github.com/v1/define" 39 | } 40 | ] 41 | }, 42 | { 43 | "type": "get", 44 | "url": "/test/escape", 45 | "title": "Escape Example", 46 | "name": "GetEscape", 47 | "group": "Escape", 48 | "version": "0.6.0", 49 | "description": "Escape Example data.
", 50 | "examples": [ 51 | { 52 | "title": "Example usage:", 53 | "content": "curl -i http://localhost/escape/text\ncurl -i http://localhost/escape/html\nEscape Example data - with comparison.
", 82 | "examples": [ 83 | { 84 | "title": "Example usage:", 85 | "content": "curl -i http://localhost/escape/text-old\ncurl -i http://localhost/escape/html-old\nExtended usage of @apiExample with different example types.
", 114 | "examples": [ 115 | { 116 | "title": "PHP Example (new)", 117 | "content": "echo 'This is the content. (new)';", 118 | "type": "PHP" 119 | }, 120 | { 121 | "title": "JS Example", 122 | "content": "console.log('This is the content.');", 123 | "type": "JS" 124 | } 125 | ], 126 | "success": { 127 | "examples": [ 128 | { 129 | "title": "PHP Success Example (new)", 130 | "content": "echo 'This is the success content. (new)';", 131 | "type": "PHP" 132 | }, 133 | { 134 | "title": "JS Success Example", 135 | "content": "console.log('This is the success content.');", 136 | "type": "JS" 137 | } 138 | ] 139 | }, 140 | "error": { 141 | "examples": [ 142 | { 143 | "title": "PHP Error Example", 144 | "content": "echo 'This is the error content.';", 145 | "type": "PHP" 146 | }, 147 | { 148 | "title": "JS Error Example", 149 | "content": "console.log('This is the error content.');", 150 | "type": "JS" 151 | } 152 | ] 153 | }, 154 | "filename": "src/api_example.js", 155 | "groupTitle": "Example", 156 | "sampleRequest": [ 157 | { 158 | "url": "https://api.github.com/v1/example/" 159 | } 160 | ] 161 | }, 162 | { 163 | "type": "get", 164 | "url": "/example/", 165 | "title": "Example", 166 | "name": "GetExample", 167 | "group": "Example", 168 | "version": "0.7.0", 169 | "description": "Extended usage of @apiExample with different example types.
", 170 | "examples": [ 171 | { 172 | "title": "PHP Example", 173 | "content": "echo 'This is the content.';", 174 | "type": "PHP" 175 | }, 176 | { 177 | "title": "JS Example (removed)", 178 | "content": "console.log('This is the content. (removed)');", 179 | "type": "JS" 180 | } 181 | ], 182 | "success": { 183 | "examples": [ 184 | { 185 | "title": "PHP Success Example", 186 | "content": "echo 'This is the success content.';", 187 | "type": "PHP" 188 | }, 189 | { 190 | "title": "JS Success Example", 191 | "content": "console.log('This is the success content.');", 192 | "type": "JS" 193 | } 194 | ] 195 | }, 196 | "error": { 197 | "examples": [ 198 | { 199 | "title": "PHP Error Example (removed)", 200 | "content": "echo 'This is the error content. (removed)';", 201 | "type": "PHP" 202 | }, 203 | { 204 | "title": "JS Error Example", 205 | "content": "console.log('This is the error content.');", 206 | "type": "JS" 207 | } 208 | ] 209 | }, 210 | "filename": "src/api_example.js", 211 | "groupTitle": "Example", 212 | "sampleRequest": [ 213 | { 214 | "url": "https://api.github.com/v1/example/" 215 | } 216 | ] 217 | }, 218 | { 219 | "type": "get", 220 | "url": "/group/:id", 221 | "title": "Group and Description", 222 | "name": "GetGroup", 223 | "group": "Group", 224 | "version": "0.5.0", 225 | "filename": "src/api_group.js", 226 | "groupTitle": "Group Title", 227 | "groupDescription": "This is a Group Description. It is Markdown capable.
", 228 | "sampleRequest": [ 229 | { 230 | "url": "https://api.github.com/v1/group/:id" 231 | } 232 | ] 233 | }, 234 | { 235 | "type": "get", 236 | "url": "/test/:id", 237 | "title": "Grouping", 238 | "name": "GetGrouping", 239 | "group": "Grouping", 240 | "version": "0.1.0", 241 | "description": "Title and Grouping of param, success and error
", 242 | "parameter": { 243 | "fields": { 244 | "Parameter": [ 245 | { 246 | "group": "Parameter", 247 | "type": "String", 248 | "optional": false, 249 | "field": "param1", 250 | "description": "No Group, automatically set Group to "Parameter"
" 251 | } 252 | ], 253 | "Replace \"login\" with this text.": [ 254 | { 255 | "group": "login", 256 | "type": "String", 257 | "optional": false, 258 | "field": "param2", 259 | "description": "Group "login"
" 260 | }, 261 | { 262 | "group": "login", 263 | "type": "String", 264 | "optional": false, 265 | "field": "param3", 266 | "defaultValue": "Default Value", 267 | "description": "Group "login" with default Value
" 268 | } 269 | ] 270 | } 271 | }, 272 | "success": { 273 | "fields": { 274 | "201 - Everything ok, replace \"201\" with this text.": [ 275 | { 276 | "group": "201", 277 | "type": "String", 278 | "optional": false, 279 | "field": "success2", 280 | "description": "Group "201"
" 281 | }, 282 | { 283 | "group": "201", 284 | "type": "String", 285 | "optional": false, 286 | "field": "success3", 287 | "defaultValue": "Default Value", 288 | "description": "Group "201" with default Value
" 289 | } 290 | ], 291 | "Success 200": [ 292 | { 293 | "group": "Success 200", 294 | "type": "String", 295 | "optional": false, 296 | "field": "success1", 297 | "description": "No Group, automatically set "Success 200"
" 298 | } 299 | ] 300 | } 301 | }, 302 | "error": { 303 | "fields": { 304 | "400": [ 305 | { 306 | "group": "400", 307 | "type": "String", 308 | "optional": false, 309 | "field": "error2", 310 | "description": "Undefined Group "400"
" 311 | } 312 | ], 313 | "401 - Oh oh, replace \"401\" with this text": [ 314 | { 315 | "group": "401", 316 | "type": "String", 317 | "optional": false, 318 | "field": "error3", 319 | "description": "Group "401"
" 320 | } 321 | ], 322 | "Error 4xx": [ 323 | { 324 | "group": "Error 4xx", 325 | "type": "String", 326 | "optional": false, 327 | "field": "error1", 328 | "description": "No Group automatically set "Error 4xx"
" 329 | } 330 | ] 331 | } 332 | }, 333 | "filename": "src/parameter_grouping.js", 334 | "groupTitle": "Grouping", 335 | "sampleRequest": [ 336 | { 337 | "url": "https://api.github.com/v1/test/:id" 338 | } 339 | ] 340 | }, 341 | { 342 | "type": "get", 343 | "url": "/header/:id", 344 | "title": "Parameters", 345 | "name": "GetHeader", 346 | "group": "Header", 347 | "version": "0.5.0", 348 | "description": "Test for @apiHeader (same as @apiParam)
", 349 | "header": { 350 | "fields": { 351 | "Header": [ 352 | { 353 | "group": "Header", 354 | "type": "String", 355 | "optional": false, 356 | "field": "header1", 357 | "description": "Parameter with type and description.
" 358 | }, 359 | { 360 | "group": "Header", 361 | "type": "String", 362 | "optional": false, 363 | "field": "header2", 364 | "description": "" 365 | }, 366 | { 367 | "group": "Header", 368 | "type": "String", 369 | "optional": false, 370 | "field": "header3", 371 | "defaultValue": "Default Value", 372 | "description": "Parameter with type, description and default value.
" 373 | }, 374 | { 375 | "group": "Header", 376 | "type": "String", 377 | "optional": false, 378 | "field": "header4", 379 | "defaultValue": "Default Value", 380 | "description": "" 381 | }, 382 | { 383 | "group": "Header", 384 | "optional": false, 385 | "field": "header5", 386 | "description": "Basic Parameter with description.
" 387 | }, 388 | { 389 | "group": "Header", 390 | "optional": false, 391 | "field": "header6", 392 | "description": "" 393 | }, 394 | { 395 | "group": "Header", 396 | "optional": false, 397 | "field": "header7", 398 | "defaultValue": "Default Value", 399 | "description": "Basic Parameter with description and default value.
" 400 | }, 401 | { 402 | "group": "Header", 403 | "optional": false, 404 | "field": "header8", 405 | "defaultValue": "Default Value", 406 | "description": "" 407 | }, 408 | { 409 | "group": "Header", 410 | "optional": true, 411 | "field": "header9", 412 | "description": "Optional basic Parameter with description.
" 413 | }, 414 | { 415 | "group": "Header", 416 | "optional": true, 417 | "field": "header10", 418 | "description": "" 419 | }, 420 | { 421 | "group": "Header", 422 | "optional": true, 423 | "field": "header11", 424 | "defaultValue": "Default Value", 425 | "description": "Optional basic Parameter with description and default value.
" 426 | }, 427 | { 428 | "group": "Header", 429 | "optional": true, 430 | "field": "header12", 431 | "defaultValue": "Default Value", 432 | "description": "" 433 | }, 434 | { 435 | "group": "Header", 436 | "type": "String", 437 | "optional": true, 438 | "field": "header13", 439 | "description": "Optional Parameter with type and description.
" 440 | }, 441 | { 442 | "group": "Header", 443 | "type": "String", 444 | "optional": true, 445 | "field": "header14", 446 | "description": "" 447 | }, 448 | { 449 | "group": "Header", 450 | "type": "String", 451 | "optional": true, 452 | "field": "header15", 453 | "defaultValue": "Default Value", 454 | "description": "Optional Parameter with type, description and default value.
" 455 | }, 456 | { 457 | "group": "Header", 458 | "type": "String", 459 | "optional": true, 460 | "field": "header16", 461 | "defaultValue": "Default Value", 462 | "description": "" 463 | } 464 | ] 465 | } 466 | }, 467 | "filename": "src/api_header.js", 468 | "groupTitle": "Header", 469 | "sampleRequest": [ 470 | { 471 | "url": "https://api.github.com/v1/header/:id" 472 | } 473 | ] 474 | }, 475 | { 476 | "type": "get", 477 | "url": "/header/example/", 478 | "title": "Header Example", 479 | "name": "GetHeaderExample", 480 | "group": "Header", 481 | "version": "0.5.0", 482 | "description": "Usage of @headerExample.
", 483 | "header": { 484 | "examples": [ 485 | { 486 | "title": "An example:", 487 | "content": "curl -i http://localhost/header/example/", 488 | "type": "json" 489 | } 490 | ] 491 | }, 492 | "filename": "src/api_header_example.js", 493 | "groupTitle": "Header", 494 | "sampleRequest": [ 495 | { 496 | "url": "https://api.github.com/v1/header/example/" 497 | } 498 | ] 499 | }, 500 | { 501 | "type": "get", 502 | "url": "/language/clojure", 503 | "title": "Clojure", 504 | "name": "GetLanguageClojure", 505 | "group": "Language", 506 | "version": "0.4.0", 507 | "description": "Test for Clojure Comment-Syntax.
", 508 | "filename": "src/language.clj", 509 | "groupTitle": "Language", 510 | "sampleRequest": [ 511 | { 512 | "url": "https://api.github.com/v1/language/clojure" 513 | } 514 | ] 515 | }, 516 | { 517 | "type": "get", 518 | "url": "/language/clojure/indented1", 519 | "title": "Clojure indented 1", 520 | "name": "GetLanguageClojureIndented1", 521 | "group": "Language", 522 | "version": "0.4.0", 523 | "examples": [ 524 | { 525 | "title": "Test for indented comment.", 526 | "content": "This is example line 2.\nThis is example line 3.\n\t\t Line 4 indented (with tab at beginning).\n\t Line 5 indented.\nThis is example line 6.", 527 | "type": "json" 528 | } 529 | ], 530 | "filename": "src/language.clj", 531 | "groupTitle": "Language", 532 | "sampleRequest": [ 533 | { 534 | "url": "https://api.github.com/v1/language/clojure/indented1" 535 | } 536 | ] 537 | }, 538 | { 539 | "type": "get", 540 | "url": "/language/coffeescript", 541 | "title": "CoffeeScript", 542 | "name": "GetLanguageCoffeeScript", 543 | "group": "Language", 544 | "version": "0.4.0", 545 | "description": "Test for CoffeeScript Comment-Syntax.
", 546 | "filename": "src/language.coffee", 547 | "groupTitle": "Language", 548 | "sampleRequest": [ 549 | { 550 | "url": "https://api.github.com/v1/language/coffeescript" 551 | } 552 | ] 553 | }, 554 | { 555 | "type": "get", 556 | "url": "/language/coffeescript/indented1", 557 | "title": "CoffeeScript indented 1", 558 | "name": "GetLanguageCoffeeScriptIndented1", 559 | "group": "Language", 560 | "version": "0.4.0", 561 | "examples": [ 562 | { 563 | "title": "Test for indented comment.", 564 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 565 | "type": "json" 566 | } 567 | ], 568 | "filename": "src/language.coffee", 569 | "groupTitle": "Language", 570 | "sampleRequest": [ 571 | { 572 | "url": "https://api.github.com/v1/language/coffeescript/indented1" 573 | } 574 | ] 575 | }, 576 | { 577 | "type": "get", 578 | "url": "/language/coffeescript/indented2", 579 | "title": "CoffeeScript indented 2", 580 | "name": "GetLanguageCoffeeScriptIndented2", 581 | "group": "Language", 582 | "version": "0.4.0", 583 | "examples": [ 584 | { 585 | "title": "Test for indented comment.", 586 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 587 | "type": "json" 588 | } 589 | ], 590 | "filename": "src/language.coffee", 591 | "groupTitle": "Language", 592 | "sampleRequest": [ 593 | { 594 | "url": "https://api.github.com/v1/language/coffeescript/indented2" 595 | } 596 | ] 597 | }, 598 | { 599 | "type": "get", 600 | "url": "/language/erlang", 601 | "title": "Erlang", 602 | "name": "GetLanguageErlang", 603 | "group": "Language", 604 | "version": "0.4.0", 605 | "description": "Test for Erlang Comment-Syntax.
", 606 | "filename": "src/language.erl", 607 | "groupTitle": "Language", 608 | "sampleRequest": [ 609 | { 610 | "url": "https://api.github.com/v1/language/erlang" 611 | } 612 | ] 613 | }, 614 | { 615 | "type": "get", 616 | "url": "/language/erlang/indented1", 617 | "title": "Erlang indented 1", 618 | "name": "GetLanguageErlangIndented1", 619 | "group": "Language", 620 | "version": "0.4.0", 621 | "examples": [ 622 | { 623 | "title": "Test for indented comment.", 624 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 625 | "type": "json" 626 | } 627 | ], 628 | "filename": "src/language.erl", 629 | "groupTitle": "Language", 630 | "sampleRequest": [ 631 | { 632 | "url": "https://api.github.com/v1/language/erlang/indented1" 633 | } 634 | ] 635 | }, 636 | { 637 | "type": "get", 638 | "url": "/language/erlang/indented2", 639 | "title": "Erlang indented 2", 640 | "name": "GetLanguageErlangIndented2", 641 | "group": "Language", 642 | "version": "0.4.0", 643 | "examples": [ 644 | { 645 | "title": "Test for indented comment.", 646 | "content": "This is example line 2.\nThis is example line 3.\nLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.", 647 | "type": "json" 648 | } 649 | ], 650 | "filename": "src/language.erl", 651 | "groupTitle": "Language", 652 | "sampleRequest": [ 653 | { 654 | "url": "https://api.github.com/v1/language/erlang/indented2" 655 | } 656 | ] 657 | }, 658 | { 659 | "type": "get", 660 | "url": "/language/javascript", 661 | "title": "JavaScript", 662 | "name": "GetLanguageJavaScript", 663 | "group": "Language", 664 | "version": "0.4.0", 665 | "description": "Test for JavaScript Comment-Syntax.
", 666 | "filename": "src/language.js", 667 | "groupTitle": "Language", 668 | "sampleRequest": [ 669 | { 670 | "url": "https://api.github.com/v1/language/javascript" 671 | } 672 | ] 673 | }, 674 | { 675 | "type": "get", 676 | "url": "/language/javascript/indented1", 677 | "title": "JavaScript indented 1", 678 | "name": "GetLanguageJavaScriptIndented1", 679 | "group": "Language", 680 | "version": "0.4.0", 681 | "examples": [ 682 | { 683 | "title": "Test for indented comment.", 684 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 685 | "type": "json" 686 | } 687 | ], 688 | "filename": "src/language.js", 689 | "groupTitle": "Language", 690 | "sampleRequest": [ 691 | { 692 | "url": "https://api.github.com/v1/language/javascript/indented1" 693 | } 694 | ] 695 | }, 696 | { 697 | "type": "get", 698 | "url": "/language/javascript/indented2", 699 | "title": "JavaScript indented 2", 700 | "name": "GetLanguageJavaScriptIndented2", 701 | "group": "Language", 702 | "version": "0.4.0", 703 | "examples": [ 704 | { 705 | "title": "Test for indented comment.", 706 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 707 | "type": "json" 708 | } 709 | ], 710 | "filename": "src/language.js", 711 | "groupTitle": "Language", 712 | "sampleRequest": [ 713 | { 714 | "url": "https://api.github.com/v1/language/javascript/indented2" 715 | } 716 | ] 717 | }, 718 | { 719 | "type": "get", 720 | "url": "/language/perl", 721 | "title": "Perl", 722 | "name": "GetLanguagePerl", 723 | "group": "Language", 724 | "version": "0.4.0", 725 | "description": "Test for Perl Comment-Syntax.
", 726 | "filename": "src/language.pm", 727 | "groupTitle": "Language", 728 | "sampleRequest": [ 729 | { 730 | "url": "https://api.github.com/v1/language/perl" 731 | } 732 | ] 733 | }, 734 | { 735 | "type": "get", 736 | "url": "/language/perl/indented1", 737 | "title": "Perl indented 1", 738 | "name": "GetLanguagePerlIndented1", 739 | "group": "Language", 740 | "version": "0.4.0", 741 | "examples": [ 742 | { 743 | "title": "Test for indented comment.", 744 | "content": "This is example line 2.\nThis is example line 3.\n\t\tLine 4 indented (with tab at beginning).\n\tLine 5 indented.\nThis is example line 6.", 745 | "type": "json" 746 | } 747 | ], 748 | "filename": "src/language.pm", 749 | "groupTitle": "Language", 750 | "sampleRequest": [ 751 | { 752 | "url": "https://api.github.com/v1/language/perl/indented1" 753 | } 754 | ] 755 | }, 756 | { 757 | "type": "get", 758 | "url": "/language/perl/indented2", 759 | "title": "Perl indented 2", 760 | "name": "GetLanguagePerlIndented2", 761 | "group": "Language", 762 | "version": "0.4.0", 763 | "examples": [ 764 | { 765 | "title": "Test for indented comment.", 766 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 767 | "type": "json" 768 | } 769 | ], 770 | "filename": "src/language.pm", 771 | "groupTitle": "Language", 772 | "sampleRequest": [ 773 | { 774 | "url": "https://api.github.com/v1/language/perl/indented2" 775 | } 776 | ] 777 | }, 778 | { 779 | "type": "get", 780 | "url": "/language/perl/podcut", 781 | "title": "Perl comment with pod and cut", 782 | "name": "GetLanguagePerlPodCut", 783 | "group": "Language", 784 | "version": "0.4.0", 785 | "examples": [ 786 | { 787 | "title": "Test for indented comment.", 788 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 789 | "type": "json" 790 | } 791 | ], 792 | "filename": "src/language.pm", 793 | "groupTitle": "Language", 794 | "sampleRequest": [ 795 | { 796 | "url": "https://api.github.com/v1/language/perl/podcut" 797 | } 798 | ] 799 | }, 800 | { 801 | "type": "get", 802 | "url": "/language/python", 803 | "title": "Python", 804 | "name": "GetLanguagePython", 805 | "group": "Language", 806 | "version": "0.4.0", 807 | "description": "Test for Python Comment-Syntax.
", 808 | "filename": "src/language.py", 809 | "groupTitle": "Language", 810 | "sampleRequest": [ 811 | { 812 | "url": "https://api.github.com/v1/language/python" 813 | } 814 | ] 815 | }, 816 | { 817 | "type": "get", 818 | "url": "/language/python/indented1", 819 | "title": "Python indented 1", 820 | "name": "GetLanguagePythonIndented1", 821 | "group": "Language", 822 | "version": "0.4.0", 823 | "examples": [ 824 | { 825 | "title": "Test for indented comment.", 826 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 827 | "type": "json" 828 | } 829 | ], 830 | "filename": "src/language.py", 831 | "groupTitle": "Language", 832 | "sampleRequest": [ 833 | { 834 | "url": "https://api.github.com/v1/language/python/indented1" 835 | } 836 | ] 837 | }, 838 | { 839 | "type": "get", 840 | "url": "/language/python/indented2", 841 | "title": "Python indented 2", 842 | "name": "GetLanguagePythonIndented2", 843 | "group": "Language", 844 | "version": "0.4.0", 845 | "examples": [ 846 | { 847 | "title": "Test for indented comment.", 848 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 849 | "type": "json" 850 | } 851 | ], 852 | "filename": "src/language.py", 853 | "groupTitle": "Language", 854 | "sampleRequest": [ 855 | { 856 | "url": "https://api.github.com/v1/language/python/indented2" 857 | } 858 | ] 859 | }, 860 | { 861 | "type": "get", 862 | "url": "/language/ruby", 863 | "title": "Ruby", 864 | "name": "GetLanguageRuby", 865 | "group": "Language", 866 | "version": "0.4.0", 867 | "description": "Test for Ruby Comment-Syntax.
", 868 | "filename": "src/language.rb", 869 | "groupTitle": "Language", 870 | "sampleRequest": [ 871 | { 872 | "url": "https://api.github.com/v1/language/ruby" 873 | } 874 | ] 875 | }, 876 | { 877 | "type": "get", 878 | "url": "/language/ruby/indented1", 879 | "title": "Ruby indented 1", 880 | "name": "GetLanguageRubyIndented1", 881 | "group": "Language", 882 | "version": "0.4.0", 883 | "examples": [ 884 | { 885 | "title": "Test for indented comment.", 886 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 887 | "type": "json" 888 | } 889 | ], 890 | "filename": "src/language.rb", 891 | "groupTitle": "Language", 892 | "sampleRequest": [ 893 | { 894 | "url": "https://api.github.com/v1/language/ruby/indented1" 895 | } 896 | ] 897 | }, 898 | { 899 | "type": "get", 900 | "url": "/language/ruby/indented2", 901 | "title": "Ruby indented 2", 902 | "name": "GetLanguageRubyIndented2", 903 | "group": "Language", 904 | "version": "0.4.0", 905 | "examples": [ 906 | { 907 | "title": "Test for indented comment.", 908 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 909 | "type": "json" 910 | } 911 | ], 912 | "filename": "src/language.rb", 913 | "groupTitle": "Language", 914 | "sampleRequest": [ 915 | { 916 | "url": "https://api.github.com/v1/language/ruby/indented2" 917 | } 918 | ] 919 | }, 920 | { 921 | "type": "get", 922 | "url": "/markdown/:id", 923 | "title": "Markdown", 924 | "name": "GetMarkdown", 925 | "group": "Markdown", 926 | "version": "0.6.0", 927 | "description": "Enable markdown for all description fields.
This text is in a separate p.
Multiline markdown text, output in one line.
", 928 | "parameter": { 929 | "fields": { 930 | "Parameter": [ 931 | { 932 | "group": "Parameter", 933 | "type": "String", 934 | "optional": false, 935 | "field": "param1", 936 | "description": "This is a markdown apiParam
Separate line.
" 937 | } 938 | ] 939 | } 940 | }, 941 | "filename": "src/markdown.js", 942 | "groupTitle": "Markdown", 943 | "sampleRequest": [ 944 | { 945 | "url": "https://api.github.com/v1/markdown/:id" 946 | } 947 | ] 948 | }, 949 | { 950 | "type": "get", 951 | "url": "/param/:id", 952 | "title": "Errors", 953 | "name": "GetError", 954 | "group": "Param", 955 | "version": "0.1.0", 956 | "description": "Returned error parameters. Syntax is the same as for @apiParam
", 957 | "error": { 958 | "fields": { 959 | "Error 4xx": [ 960 | { 961 | "group": "Error 4xx", 962 | "optional": false, 963 | "field": "error1Error", 964 | "description": "This is Error 1.
" 965 | }, 966 | { 967 | "group": "Error 4xx", 968 | "optional": false, 969 | "field": "error2Error", 970 | "description": "This is Error 2.
" 971 | } 972 | ] 973 | } 974 | }, 975 | "filename": "src/api_param.js", 976 | "groupTitle": "Param", 977 | "sampleRequest": [ 978 | { 979 | "url": "https://api.github.com/v1/param/:id" 980 | } 981 | ] 982 | }, 983 | { 984 | "type": "get", 985 | "url": "/param/:id", 986 | "title": "Parameters", 987 | "name": "GetParam", 988 | "group": "Param", 989 | "version": "0.1.1", 990 | "description": "Parameters and different Versions: 0.1.1
", 991 | "parameter": { 992 | "fields": { 993 | "Parameter": [ 994 | { 995 | "group": "Parameter", 996 | "optional": false, 997 | "field": "param1", 998 | "description": "Parameter and description.
" 999 | }, 1000 | { 1001 | "group": "Parameter", 1002 | "optional": false, 1003 | "field": "param2", 1004 | "description": "" 1005 | }, 1006 | { 1007 | "group": "Parameter", 1008 | "optional": false, 1009 | "field": "param3", 1010 | "defaultValue": "Default Value", 1011 | "description": "Parameter, default value and description.
" 1012 | }, 1013 | { 1014 | "group": "Parameter", 1015 | "optional": false, 1016 | "field": "param4", 1017 | "defaultValue": "Default Value", 1018 | "description": "" 1019 | }, 1020 | { 1021 | "group": "Parameter", 1022 | "optional": true, 1023 | "field": "param5", 1024 | "description": "Optional parameter and description.
" 1025 | }, 1026 | { 1027 | "group": "Parameter", 1028 | "optional": true, 1029 | "field": "param6", 1030 | "description": "" 1031 | }, 1032 | { 1033 | "group": "Parameter", 1034 | "optional": true, 1035 | "field": "param7", 1036 | "defaultValue": "Default Value", 1037 | "description": "Optional parameter, default value and description.
" 1038 | }, 1039 | { 1040 | "group": "Parameter", 1041 | "optional": true, 1042 | "field": "param8", 1043 | "defaultValue": "Default Value", 1044 | "description": "" 1045 | }, 1046 | { 1047 | "group": "Parameter", 1048 | "type": "String", 1049 | "optional": false, 1050 | "field": "param9", 1051 | "description": "Type, parameter and description.
" 1052 | }, 1053 | { 1054 | "group": "Parameter", 1055 | "type": "String", 1056 | "optional": false, 1057 | "field": "param10", 1058 | "description": "" 1059 | }, 1060 | { 1061 | "group": "Parameter", 1062 | "type": "String", 1063 | "optional": false, 1064 | "field": "param11", 1065 | "defaultValue": "Default Value", 1066 | "description": "Type, parameter and default value.
" 1067 | }, 1068 | { 1069 | "group": "Parameter", 1070 | "type": "String", 1071 | "optional": false, 1072 | "field": "param12", 1073 | "defaultValue": "Default Value", 1074 | "description": "" 1075 | }, 1076 | { 1077 | "group": "Parameter", 1078 | "type": "String", 1079 | "optional": true, 1080 | "field": "param13", 1081 | "description": "Type, optional parameter and description.
" 1082 | }, 1083 | { 1084 | "group": "Parameter", 1085 | "type": "String", 1086 | "optional": true, 1087 | "field": "param14", 1088 | "description": "" 1089 | }, 1090 | { 1091 | "group": "Parameter", 1092 | "type": "String", 1093 | "optional": true, 1094 | "field": "param15", 1095 | "defaultValue": "Default Value", 1096 | "description": "Type, optional parameter, default value and description.
" 1097 | }, 1098 | { 1099 | "group": "Parameter", 1100 | "type": "String", 1101 | "optional": true, 1102 | "field": "param26", 1103 | "defaultValue": "Default Value", 1104 | "description": "" 1105 | }, 1106 | { 1107 | "group": "Parameter", 1108 | "type": "String", 1109 | "size": "4,8", 1110 | "optional": false, 1111 | "field": "param17", 1112 | "description": "Type, size, parameter and description.
" 1113 | }, 1114 | { 1115 | "group": "Parameter", 1116 | "type": "Number", 1117 | "size": "1-3", 1118 | "optional": false, 1119 | "field": "param18", 1120 | "description": "Type, size, parameter and description.
" 1121 | }, 1122 | { 1123 | "group": "Parameter", 1124 | "type": "String", 1125 | "size": "4,8", 1126 | "optional": false, 1127 | "field": "param19", 1128 | "defaultValue": "Default Value", 1129 | "description": "Type, size, parameter, default value and description.
" 1130 | }, 1131 | { 1132 | "group": "Parameter", 1133 | "type": "Number", 1134 | "size": "1-3", 1135 | "optional": false, 1136 | "field": "param20", 1137 | "defaultValue": "1", 1138 | "description": "Type, size, parameter, default value and description.
" 1139 | }, 1140 | { 1141 | "group": "Parameter", 1142 | "type": "String", 1143 | "allowedValues": [ 1144 | "\"value 1\"" 1145 | ], 1146 | "optional": false, 1147 | "field": "param21", 1148 | "description": "Type, parameter and allowed string value.
" 1149 | }, 1150 | { 1151 | "group": "Parameter", 1152 | "type": "String", 1153 | "allowedValues": [ 1154 | "\"value 1\"", 1155 | "\"value 2\"" 1156 | ], 1157 | "optional": false, 1158 | "field": "param22", 1159 | "description": "Type, parameter and allowed list of string values.
" 1160 | }, 1161 | { 1162 | "group": "Parameter", 1163 | "type": "Number", 1164 | "allowedValues": [ 1165 | "4711" 1166 | ], 1167 | "optional": false, 1168 | "field": "param23", 1169 | "description": "Type, parameter and allowed value.
" 1170 | }, 1171 | { 1172 | "group": "Parameter", 1173 | "type": "Number", 1174 | "allowedValues": [ 1175 | "4711", 1176 | "4712" 1177 | ], 1178 | "optional": false, 1179 | "field": "param24", 1180 | "description": "Type, parameter and allowed list of values.
" 1181 | }, 1182 | { 1183 | "group": "Parameter", 1184 | "type": "String", 1185 | "size": "1,10", 1186 | "allowedValues": [ 1187 | "\"value 1\"" 1188 | ], 1189 | "optional": false, 1190 | "field": "param25", 1191 | "description": "Type, size, parameter and allowed string value.
" 1192 | }, 1193 | { 1194 | "group": "Parameter", 1195 | "type": "Number", 1196 | "size": "1-9999", 1197 | "allowedValues": [ 1198 | "4711" 1199 | ], 1200 | "optional": false, 1201 | "field": "param27", 1202 | "description": "Type, size, parameter and allowed value.
" 1203 | }, 1204 | { 1205 | "group": "Parameter", 1206 | "type": "Number", 1207 | "size": "1-9999", 1208 | "allowedValues": [ 1209 | "4711", 1210 | "4712" 1211 | ], 1212 | "optional": false, 1213 | "field": "param28", 1214 | "description": "Type, size, parameter and allowed list of values.
" 1215 | }, 1216 | { 1217 | "group": "Parameter", 1218 | "type": "Custom", 1219 | "optional": false, 1220 | "field": "param29", 1221 | "description": "Type with markdown link.
" 1222 | } 1223 | ] 1224 | } 1225 | }, 1226 | "filename": "src/api_param.js", 1227 | "groupTitle": "Param", 1228 | "sampleRequest": [ 1229 | { 1230 | "url": "https://api.github.com/v1/param/:id" 1231 | } 1232 | ] 1233 | }, 1234 | { 1235 | "type": "get", 1236 | "url": "/param/:id", 1237 | "title": "Parameters", 1238 | "name": "GetParam", 1239 | "group": "Param", 1240 | "version": "0.1.0", 1241 | "description": "Parameters and different Versions: 0.1.0
", 1242 | "parameter": { 1243 | "fields": { 1244 | "Parameter": [ 1245 | { 1246 | "group": "Parameter", 1247 | "type": "String", 1248 | "optional": false, 1249 | "field": "param0", 1250 | "description": "This param is removed in 0.1.1.
" 1251 | }, 1252 | { 1253 | "group": "Parameter", 1254 | "type": "String", 1255 | "optional": false, 1256 | "field": "param1", 1257 | "description": "This is an old text.
" 1258 | }, 1259 | { 1260 | "group": "Parameter", 1261 | "type": "String", 1262 | "optional": false, 1263 | "field": "param2", 1264 | "description": "" 1265 | }, 1266 | { 1267 | "group": "Parameter", 1268 | "type": "String", 1269 | "optional": false, 1270 | "field": "param3", 1271 | "defaultValue": "Default Value", 1272 | "description": "Parameter with type, description and default value.
" 1273 | }, 1274 | { 1275 | "group": "Parameter", 1276 | "type": "String", 1277 | "optional": false, 1278 | "field": "param4", 1279 | "defaultValue": "Default Value", 1280 | "description": "" 1281 | }, 1282 | { 1283 | "group": "Parameter", 1284 | "optional": false, 1285 | "field": "param5", 1286 | "description": "Basic Parameter with description.
" 1287 | }, 1288 | { 1289 | "group": "Parameter", 1290 | "optional": false, 1291 | "field": "param6", 1292 | "description": "" 1293 | }, 1294 | { 1295 | "group": "Parameter", 1296 | "optional": false, 1297 | "field": "param7", 1298 | "defaultValue": "Default Value", 1299 | "description": "Basic Parameter with description and default value.
" 1300 | }, 1301 | { 1302 | "group": "Parameter", 1303 | "optional": false, 1304 | "field": "param8", 1305 | "defaultValue": "Default Value", 1306 | "description": "" 1307 | }, 1308 | { 1309 | "group": "Parameter", 1310 | "optional": true, 1311 | "field": "param9", 1312 | "description": "Optional basic Parameter with description.
" 1313 | }, 1314 | { 1315 | "group": "Parameter", 1316 | "optional": true, 1317 | "field": "param10", 1318 | "description": "" 1319 | }, 1320 | { 1321 | "group": "Parameter", 1322 | "optional": true, 1323 | "field": "param11", 1324 | "defaultValue": "Default Value", 1325 | "description": "Optional basic Parameter with description and default value.
" 1326 | }, 1327 | { 1328 | "group": "Parameter", 1329 | "optional": true, 1330 | "field": "param12", 1331 | "defaultValue": "Default Value", 1332 | "description": "" 1333 | }, 1334 | { 1335 | "group": "Parameter", 1336 | "type": "String", 1337 | "optional": true, 1338 | "field": "param13", 1339 | "description": "Optional Parameter with type and description.
" 1340 | }, 1341 | { 1342 | "group": "Parameter", 1343 | "type": "String", 1344 | "optional": true, 1345 | "field": "param14", 1346 | "description": "" 1347 | }, 1348 | { 1349 | "group": "Parameter", 1350 | "type": "String", 1351 | "optional": true, 1352 | "field": "param15", 1353 | "defaultValue": "Default Value", 1354 | "description": "Optional Parameter with type, description and default value.
" 1355 | }, 1356 | { 1357 | "group": "Parameter", 1358 | "type": "String", 1359 | "optional": true, 1360 | "field": "param16", 1361 | "defaultValue": "Default Value", 1362 | "description": "" 1363 | } 1364 | ] 1365 | } 1366 | }, 1367 | "filename": "src/api_param.js", 1368 | "groupTitle": "Param", 1369 | "sampleRequest": [ 1370 | { 1371 | "url": "https://api.github.com/v1/param/:id" 1372 | } 1373 | ] 1374 | }, 1375 | { 1376 | "type": "get", 1377 | "url": "/param/example/", 1378 | "title": "Param Example", 1379 | "name": "GetParamExample", 1380 | "group": "Param", 1381 | "version": "0.8.0", 1382 | "description": "Usage of @apiParamExample.
", 1383 | "examples": [ 1384 | { 1385 | "title": "A common example:", 1386 | "content": "curl -i http://localhost/param/example/", 1387 | "type": "json" 1388 | } 1389 | ], 1390 | "parameter": { 1391 | "fields": { 1392 | "Parameter": [ 1393 | { 1394 | "group": "Parameter", 1395 | "type": "String", 1396 | "optional": false, 1397 | "field": "name", 1398 | "description": "Fullname.
" 1399 | } 1400 | ] 1401 | }, 1402 | "examples": [ 1403 | { 1404 | "title": "A JSON example:", 1405 | "content": "{\n \"name\": \"John Doe\"\n}", 1406 | "type": "json" 1407 | } 1408 | ] 1409 | }, 1410 | "filename": "src/api_param_example.js", 1411 | "groupTitle": "Param", 1412 | "sampleRequest": [ 1413 | { 1414 | "url": "https://api.github.com/v1/param/example/" 1415 | } 1416 | ] 1417 | }, 1418 | { 1419 | "type": "get", 1420 | "url": "/param/:id", 1421 | "title": "Success", 1422 | "name": "GetSuccess", 1423 | "group": "Param", 1424 | "version": "0.1.0", 1425 | "description": "Returned success parameters. Syntax is the same as for @apiParam
", 1426 | "error": { 1427 | "fields": { 1428 | "Error 4xx": [ 1429 | { 1430 | "group": "Error 4xx", 1431 | "optional": false, 1432 | "field": "success1", 1433 | "description": "This is Success 1.
" 1434 | }, 1435 | { 1436 | "group": "Error 4xx", 1437 | "optional": false, 1438 | "field": "success2", 1439 | "description": "This is Success 2.
" 1440 | } 1441 | ] 1442 | } 1443 | }, 1444 | "filename": "src/api_param.js", 1445 | "groupTitle": "Param", 1446 | "sampleRequest": [ 1447 | { 1448 | "url": "https://api.github.com/v1/param/:id" 1449 | } 1450 | ] 1451 | }, 1452 | { 1453 | "type": "get", 1454 | "url": "/permission/", 1455 | "title": "Permission", 1456 | "name": "GetPermission", 1457 | "group": "Permission", 1458 | "version": "0.8.0", 1459 | "description": "@apiPermission test.
", 1460 | "permission": [ 1461 | { 1462 | "name": "permission_admin", 1463 | "title": "Admin access.", 1464 | "description": "Some description.
" 1465 | } 1466 | ], 1467 | "filename": "src/api_permission.js", 1468 | "groupTitle": "Permission", 1469 | "sampleRequest": [ 1470 | { 1471 | "url": "https://api.github.com/v1/permission/" 1472 | } 1473 | ] 1474 | }, 1475 | { 1476 | "type": "get", 1477 | "url": "/permission/", 1478 | "title": "Permission", 1479 | "name": "GetPermission", 1480 | "group": "Permission", 1481 | "version": "0.8.0", 1482 | "description": "@apiPermission test.
", 1483 | "permission": [ 1484 | { 1485 | "name": "permission_admin", 1486 | "title": "Admin access.", 1487 | "description": "Some description.
" 1488 | }, 1489 | { 1490 | "name": "permission_user", 1491 | "title": "User access.", 1492 | "description": "" 1493 | } 1494 | ], 1495 | "filename": "src/api_permission.js", 1496 | "groupTitle": "Permission", 1497 | "sampleRequest": [ 1498 | { 1499 | "url": "https://api.github.com/v1/permission/" 1500 | } 1501 | ] 1502 | }, 1503 | { 1504 | "type": "get", 1505 | "url": "/indent/trim/multi/spaces", 1506 | "title": "Trim multi line (spaces)", 1507 | "group": "indent", 1508 | "description": "Text line 1 (Begin: 4xSpaces (3 removed)). Text line 2 (Begin: 3xSpaces (3 removed), End: 2xSpaces).
", 1509 | "version": "0.0.0", 1510 | "filename": "src/indent.js", 1511 | "groupTitle": "Indent", 1512 | "name": "GetIndentTrimMultiSpaces", 1513 | "sampleRequest": [ 1514 | { 1515 | "url": "https://api.github.com/v1/indent/trim/multi/spaces" 1516 | } 1517 | ] 1518 | }, 1519 | { 1520 | "type": "get", 1521 | "url": "/indent/trim/multi/tabs", 1522 | "title": "Trim multi line (tabs)", 1523 | "group": "indent", 1524 | "description": "Text line 1 (Begin: 3xTab (2 removed)). \t\tText line 2 (Begin: 2x Tab (2 removed), End: 1xTab).
", 1525 | "version": "0.0.0", 1526 | "filename": "src/indent.js", 1527 | "groupTitle": "Indent", 1528 | "name": "GetIndentTrimMultiTabs", 1529 | "sampleRequest": [ 1530 | { 1531 | "url": "https://api.github.com/v1/indent/trim/multi/tabs" 1532 | } 1533 | ] 1534 | }, 1535 | { 1536 | "type": "get", 1537 | "url": "/indent/trim/multi/tabs/and/space", 1538 | "title": "Trim multi line (tabs and space)", 1539 | "group": "indent", 1540 | "description": "Text line 1 (Begin: 1xTab, 2xSpaces). Text line 2 (Begin: 3xSpaces, End: 1xTab).
", 1541 | "version": "0.0.0", 1542 | "filename": "src/indent.js", 1543 | "groupTitle": "Indent", 1544 | "name": "GetIndentTrimMultiTabsAndSpace", 1545 | "sampleRequest": [ 1546 | { 1547 | "url": "https://api.github.com/v1/indent/trim/multi/tabs/and/space" 1548 | } 1549 | ] 1550 | }, 1551 | { 1552 | "type": "get", 1553 | "url": "/indent/trim/single", 1554 | "title": "Trim single line", 1555 | "group": "indent", 1556 | "description": "Text line 1 (Begin: 3xSpaces (3 removed), End: 1xSpace).
", 1557 | "version": "0.0.0", 1558 | "filename": "src/indent.js", 1559 | "groupTitle": "Indent", 1560 | "name": "GetIndentTrimSingle", 1561 | "sampleRequest": [ 1562 | { 1563 | "url": "https://api.github.com/v1/indent/trim/single" 1564 | } 1565 | ] 1566 | }, 1567 | { 1568 | "type": "get", 1569 | "url": "/indent/word", 1570 | "title": "Indent a word", 1571 | "group": "indent", 1572 | "description": "text.
", 1573 | "version": "0.0.0", 1574 | "filename": "src/indent.js", 1575 | "groupTitle": "Indent", 1576 | "name": "GetIndentWord", 1577 | "sampleRequest": [ 1578 | { 1579 | "url": "https://api.github.com/v1/indent/word" 1580 | } 1581 | ] 1582 | } 1583 | ] }); 1584 | -------------------------------------------------------------------------------- /v0.3.0/fixtures/api_data.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "type": "get", 4 | "url": "/define", 5 | "title": "Define", 6 | "name": "GetDefine", 7 | "group": "Define", 8 | "version": "0.8.0", 9 | "description": "Example of @apiDefine and @apiUse
", 10 | "parameter": { 11 | "fields": { 12 | "Parameter": [ 13 | { 14 | "group": "Parameter", 15 | "optional": false, 16 | "field": "field3", 17 | "description": "This is Field 3 (local).
" 18 | }, 19 | { 20 | "group": "Parameter", 21 | "optional": false, 22 | "field": "field1", 23 | "description": "This is Field 1.
" 24 | }, 25 | { 26 | "group": "Parameter", 27 | "optional": false, 28 | "field": "field2", 29 | "description": "This is Field 2.
" 30 | } 31 | ] 32 | } 33 | }, 34 | "filename": "src/api_define.js", 35 | "groupTitle": "Define", 36 | "sampleRequest": [ 37 | { 38 | "url": "https://api.github.com/v1/define" 39 | } 40 | ] 41 | }, 42 | { 43 | "deprecated": { 44 | "content": "Link to a method with a markdown link or autolink with (#Param:GetParam)" 45 | }, 46 | "type": "get", 47 | "url": "/deprecated/bar/:id", 48 | "title": "Deprecated + content", 49 | "name": "GetBarDeprecated", 50 | "group": "Deprecated", 51 | "version": "0.20.0", 52 | "description": "This is a deprecated hint with a link to the new method.
", 53 | "parameter": { 54 | "fields": { 55 | "Parameter": [ 56 | { 57 | "group": "Parameter", 58 | "optional": false, 59 | "field": "param1", 60 | "description": "Parameter and description.
" 61 | } 62 | ] 63 | } 64 | }, 65 | "filename": "src/api_deprecated.js", 66 | "groupTitle": "Deprecated", 67 | "sampleRequest": [ 68 | { 69 | "url": "https://api.github.com/v1/deprecated/bar/:id" 70 | } 71 | ] 72 | }, 73 | { 74 | "deprecated": true, 75 | "type": "get", 76 | "url": "/deprecated/foo/:id", 77 | "title": "Deprecated", 78 | "name": "GetFooDeprecated", 79 | "group": "Deprecated", 80 | "version": "0.20.0", 81 | "description": "This is a simple deprecated hint.
", 82 | "parameter": { 83 | "fields": { 84 | "Parameter": [ 85 | { 86 | "group": "Parameter", 87 | "optional": false, 88 | "field": "param1", 89 | "description": "Parameter and description.
" 90 | } 91 | ] 92 | } 93 | }, 94 | "filename": "src/api_deprecated.js", 95 | "groupTitle": "Deprecated", 96 | "sampleRequest": [ 97 | { 98 | "url": "https://api.github.com/v1/deprecated/foo/:id" 99 | } 100 | ] 101 | }, 102 | { 103 | "type": "get", 104 | "url": "/test/escape", 105 | "title": "Escape Example", 106 | "name": "GetEscape", 107 | "group": "Escape", 108 | "version": "0.6.0", 109 | "description": "Escape Example data.
", 110 | "examples": [ 111 | { 112 | "title": "Example usage:", 113 | "content": "curl -i http://localhost/escape/text\ncurl -i http://localhost/escape/html\nEscape Example data - with comparison.
", 142 | "examples": [ 143 | { 144 | "title": "Example usage:", 145 | "content": "curl -i http://localhost/escape/text-old\ncurl -i http://localhost/escape/html-old\nExtended usage of @apiExample with different example types.
", 174 | "examples": [ 175 | { 176 | "title": "PHP Example (new)", 177 | "content": "echo 'This is the content. (new)';", 178 | "type": "PHP" 179 | }, 180 | { 181 | "title": "JS Example", 182 | "content": "console.log('This is the content.');", 183 | "type": "JS" 184 | } 185 | ], 186 | "success": { 187 | "examples": [ 188 | { 189 | "title": "PHP Success Example (new)", 190 | "content": "echo 'This is the success content. (new)';", 191 | "type": "PHP" 192 | }, 193 | { 194 | "title": "JS Success Example", 195 | "content": "console.log('This is the success content.');", 196 | "type": "JS" 197 | } 198 | ] 199 | }, 200 | "error": { 201 | "examples": [ 202 | { 203 | "title": "PHP Error Example", 204 | "content": "echo 'This is the error content.';", 205 | "type": "PHP" 206 | }, 207 | { 208 | "title": "JS Error Example", 209 | "content": "console.log('This is the error content.');", 210 | "type": "JS" 211 | } 212 | ] 213 | }, 214 | "filename": "src/api_example.js", 215 | "groupTitle": "Example", 216 | "sampleRequest": [ 217 | { 218 | "url": "https://api.github.com/v1/example/" 219 | } 220 | ] 221 | }, 222 | { 223 | "type": "get", 224 | "url": "/example/", 225 | "title": "Example", 226 | "name": "GetExample", 227 | "group": "Example", 228 | "version": "0.7.0", 229 | "description": "Extended usage of @apiExample with different example types.
", 230 | "examples": [ 231 | { 232 | "title": "PHP Example", 233 | "content": "echo 'This is the content.';", 234 | "type": "PHP" 235 | }, 236 | { 237 | "title": "JS Example (removed)", 238 | "content": "console.log('This is the content. (removed)');", 239 | "type": "JS" 240 | } 241 | ], 242 | "success": { 243 | "examples": [ 244 | { 245 | "title": "PHP Success Example", 246 | "content": "echo 'This is the success content.';", 247 | "type": "PHP" 248 | }, 249 | { 250 | "title": "JS Success Example", 251 | "content": "console.log('This is the success content.');", 252 | "type": "JS" 253 | } 254 | ] 255 | }, 256 | "error": { 257 | "examples": [ 258 | { 259 | "title": "PHP Error Example (removed)", 260 | "content": "echo 'This is the error content. (removed)';", 261 | "type": "PHP" 262 | }, 263 | { 264 | "title": "JS Error Example", 265 | "content": "console.log('This is the error content.');", 266 | "type": "JS" 267 | } 268 | ] 269 | }, 270 | "filename": "src/api_example.js", 271 | "groupTitle": "Example", 272 | "sampleRequest": [ 273 | { 274 | "url": "https://api.github.com/v1/example/" 275 | } 276 | ] 277 | }, 278 | { 279 | "type": "get", 280 | "url": "/group/:id", 281 | "title": "Group and Description", 282 | "name": "GetGroup", 283 | "group": "Group", 284 | "version": "0.5.0", 285 | "filename": "src/api_group.js", 286 | "groupTitle": "Group Title", 287 | "groupDescription": "This is a Group Description. It is Markdown capable.
", 288 | "sampleRequest": [ 289 | { 290 | "url": "https://api.github.com/v1/group/:id" 291 | } 292 | ] 293 | }, 294 | { 295 | "type": "get", 296 | "url": "/test/:id", 297 | "title": "Grouping", 298 | "name": "GetGrouping", 299 | "group": "Grouping", 300 | "version": "0.1.0", 301 | "description": "Title and Grouping of param, success and error
", 302 | "parameter": { 303 | "fields": { 304 | "Parameter": [ 305 | { 306 | "group": "Parameter", 307 | "type": "String", 308 | "optional": false, 309 | "field": "param1", 310 | "description": "No Group, automatically set Group to "Parameter"
" 311 | } 312 | ], 313 | "Replace \"login\" with this text.": [ 314 | { 315 | "group": "login", 316 | "type": "String", 317 | "optional": false, 318 | "field": "param2", 319 | "description": "Group "login"
" 320 | }, 321 | { 322 | "group": "login", 323 | "type": "String", 324 | "optional": false, 325 | "field": "param3", 326 | "defaultValue": "Default Value", 327 | "description": "Group "login" with default Value
" 328 | } 329 | ] 330 | } 331 | }, 332 | "success": { 333 | "fields": { 334 | "201 - Everything ok, replace \"201\" with this text.": [ 335 | { 336 | "group": "201", 337 | "type": "String", 338 | "optional": false, 339 | "field": "success2", 340 | "description": "Group "201"
" 341 | }, 342 | { 343 | "group": "201", 344 | "type": "String", 345 | "optional": false, 346 | "field": "success3", 347 | "defaultValue": "Default Value", 348 | "description": "Group "201" with default Value
" 349 | } 350 | ], 351 | "Success 200": [ 352 | { 353 | "group": "Success 200", 354 | "type": "String", 355 | "optional": false, 356 | "field": "success1", 357 | "description": "No Group, automatically set "Success 200"
" 358 | } 359 | ] 360 | } 361 | }, 362 | "error": { 363 | "fields": { 364 | "400": [ 365 | { 366 | "group": "400", 367 | "type": "String", 368 | "optional": false, 369 | "field": "error2", 370 | "description": "Undefined Group "400"
" 371 | } 372 | ], 373 | "401 - Oh oh, replace \"401\" with this text": [ 374 | { 375 | "group": "401", 376 | "type": "String", 377 | "optional": false, 378 | "field": "error3", 379 | "description": "Group "401"
" 380 | } 381 | ], 382 | "Error 4xx": [ 383 | { 384 | "group": "Error 4xx", 385 | "type": "String", 386 | "optional": false, 387 | "field": "error1", 388 | "description": "No Group automatically set "Error 4xx"
" 389 | } 390 | ] 391 | } 392 | }, 393 | "filename": "src/parameter_grouping.js", 394 | "groupTitle": "Grouping", 395 | "sampleRequest": [ 396 | { 397 | "url": "https://api.github.com/v1/test/:id" 398 | } 399 | ] 400 | }, 401 | { 402 | "type": "get", 403 | "url": "/header/:id", 404 | "title": "Parameters", 405 | "name": "GetHeader", 406 | "group": "Header", 407 | "version": "0.5.0", 408 | "description": "Test for @apiHeader (same as @apiParam)
", 409 | "header": { 410 | "fields": { 411 | "Header": [ 412 | { 413 | "group": "Header", 414 | "type": "String", 415 | "optional": false, 416 | "field": "header1", 417 | "description": "Parameter with type and description.
" 418 | }, 419 | { 420 | "group": "Header", 421 | "type": "String", 422 | "optional": false, 423 | "field": "header2", 424 | "description": "" 425 | }, 426 | { 427 | "group": "Header", 428 | "type": "String", 429 | "optional": false, 430 | "field": "header3", 431 | "defaultValue": "Default Value", 432 | "description": "Parameter with type, description and default value.
" 433 | }, 434 | { 435 | "group": "Header", 436 | "type": "String", 437 | "optional": false, 438 | "field": "header4", 439 | "defaultValue": "Default Value", 440 | "description": "" 441 | }, 442 | { 443 | "group": "Header", 444 | "optional": false, 445 | "field": "header5", 446 | "description": "Basic Parameter with description.
" 447 | }, 448 | { 449 | "group": "Header", 450 | "optional": false, 451 | "field": "header6", 452 | "description": "" 453 | }, 454 | { 455 | "group": "Header", 456 | "optional": false, 457 | "field": "header7", 458 | "defaultValue": "Default Value", 459 | "description": "Basic Parameter with description and default value.
" 460 | }, 461 | { 462 | "group": "Header", 463 | "optional": false, 464 | "field": "header8", 465 | "defaultValue": "Default Value", 466 | "description": "" 467 | }, 468 | { 469 | "group": "Header", 470 | "optional": true, 471 | "field": "header9", 472 | "description": "Optional basic Parameter with description.
" 473 | }, 474 | { 475 | "group": "Header", 476 | "optional": true, 477 | "field": "header10", 478 | "description": "" 479 | }, 480 | { 481 | "group": "Header", 482 | "optional": true, 483 | "field": "header11", 484 | "defaultValue": "Default Value", 485 | "description": "Optional basic Parameter with description and default value.
" 486 | }, 487 | { 488 | "group": "Header", 489 | "optional": true, 490 | "field": "header12", 491 | "defaultValue": "Default Value", 492 | "description": "" 493 | }, 494 | { 495 | "group": "Header", 496 | "type": "String", 497 | "optional": true, 498 | "field": "header13", 499 | "description": "Optional Parameter with type and description.
" 500 | }, 501 | { 502 | "group": "Header", 503 | "type": "String", 504 | "optional": true, 505 | "field": "header14", 506 | "description": "" 507 | }, 508 | { 509 | "group": "Header", 510 | "type": "String", 511 | "optional": true, 512 | "field": "header15", 513 | "defaultValue": "Default Value", 514 | "description": "Optional Parameter with type, description and default value.
" 515 | }, 516 | { 517 | "group": "Header", 518 | "type": "String", 519 | "optional": true, 520 | "field": "header16", 521 | "defaultValue": "Default Value", 522 | "description": "" 523 | } 524 | ] 525 | } 526 | }, 527 | "filename": "src/api_header.js", 528 | "groupTitle": "Header", 529 | "sampleRequest": [ 530 | { 531 | "url": "https://api.github.com/v1/header/:id" 532 | } 533 | ] 534 | }, 535 | { 536 | "type": "get", 537 | "url": "/header/example/", 538 | "title": "Header Example", 539 | "name": "GetHeaderExample", 540 | "group": "Header", 541 | "version": "0.5.0", 542 | "description": "Usage of @headerExample.
", 543 | "header": { 544 | "examples": [ 545 | { 546 | "title": "An example:", 547 | "content": "curl -i http://localhost/header/example/", 548 | "type": "json" 549 | } 550 | ] 551 | }, 552 | "filename": "src/api_header_example.js", 553 | "groupTitle": "Header", 554 | "sampleRequest": [ 555 | { 556 | "url": "https://api.github.com/v1/header/example/" 557 | } 558 | ] 559 | }, 560 | { 561 | "type": "get", 562 | "url": "/language/clojure", 563 | "title": "Clojure", 564 | "name": "GetLanguageClojure", 565 | "group": "Language", 566 | "version": "0.4.0", 567 | "description": "Test for Clojure Comment-Syntax.
", 568 | "filename": "src/language.clj", 569 | "groupTitle": "Language", 570 | "sampleRequest": [ 571 | { 572 | "url": "https://api.github.com/v1/language/clojure" 573 | } 574 | ] 575 | }, 576 | { 577 | "type": "get", 578 | "url": "/language/clojure/indented1", 579 | "title": "Clojure indented 1", 580 | "name": "GetLanguageClojureIndented1", 581 | "group": "Language", 582 | "version": "0.4.0", 583 | "examples": [ 584 | { 585 | "title": "Test for indented comment.", 586 | "content": "This is example line 2.\nThis is example line 3.\n\t\t Line 4 indented (with tab at beginning).\n\t Line 5 indented.\nThis is example line 6.", 587 | "type": "json" 588 | } 589 | ], 590 | "filename": "src/language.clj", 591 | "groupTitle": "Language", 592 | "sampleRequest": [ 593 | { 594 | "url": "https://api.github.com/v1/language/clojure/indented1" 595 | } 596 | ] 597 | }, 598 | { 599 | "type": "get", 600 | "url": "/language/coffeescript", 601 | "title": "CoffeeScript", 602 | "name": "GetLanguageCoffeeScript", 603 | "group": "Language", 604 | "version": "0.4.0", 605 | "description": "Test for CoffeeScript Comment-Syntax.
", 606 | "filename": "src/language.coffee", 607 | "groupTitle": "Language", 608 | "sampleRequest": [ 609 | { 610 | "url": "https://api.github.com/v1/language/coffeescript" 611 | } 612 | ] 613 | }, 614 | { 615 | "type": "get", 616 | "url": "/language/coffeescript/indented1", 617 | "title": "CoffeeScript indented 1", 618 | "name": "GetLanguageCoffeeScriptIndented1", 619 | "group": "Language", 620 | "version": "0.4.0", 621 | "examples": [ 622 | { 623 | "title": "Test for indented comment.", 624 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 625 | "type": "json" 626 | } 627 | ], 628 | "filename": "src/language.coffee", 629 | "groupTitle": "Language", 630 | "sampleRequest": [ 631 | { 632 | "url": "https://api.github.com/v1/language/coffeescript/indented1" 633 | } 634 | ] 635 | }, 636 | { 637 | "type": "get", 638 | "url": "/language/coffeescript/indented2", 639 | "title": "CoffeeScript indented 2", 640 | "name": "GetLanguageCoffeeScriptIndented2", 641 | "group": "Language", 642 | "version": "0.4.0", 643 | "examples": [ 644 | { 645 | "title": "Test for indented comment.", 646 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 647 | "type": "json" 648 | } 649 | ], 650 | "filename": "src/language.coffee", 651 | "groupTitle": "Language", 652 | "sampleRequest": [ 653 | { 654 | "url": "https://api.github.com/v1/language/coffeescript/indented2" 655 | } 656 | ] 657 | }, 658 | { 659 | "type": "get", 660 | "url": "/language/erlang", 661 | "title": "Erlang", 662 | "name": "GetLanguageErlang", 663 | "group": "Language", 664 | "version": "0.4.0", 665 | "description": "Test for Erlang Comment-Syntax.
", 666 | "filename": "src/language.erl", 667 | "groupTitle": "Language", 668 | "sampleRequest": [ 669 | { 670 | "url": "https://api.github.com/v1/language/erlang" 671 | } 672 | ] 673 | }, 674 | { 675 | "type": "get", 676 | "url": "/language/erlang/indented1", 677 | "title": "Erlang indented 1", 678 | "name": "GetLanguageErlangIndented1", 679 | "group": "Language", 680 | "version": "0.4.0", 681 | "examples": [ 682 | { 683 | "title": "Test for indented comment.", 684 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 685 | "type": "json" 686 | } 687 | ], 688 | "filename": "src/language.erl", 689 | "groupTitle": "Language", 690 | "sampleRequest": [ 691 | { 692 | "url": "https://api.github.com/v1/language/erlang/indented1" 693 | } 694 | ] 695 | }, 696 | { 697 | "type": "get", 698 | "url": "/language/erlang/indented2", 699 | "title": "Erlang indented 2", 700 | "name": "GetLanguageErlangIndented2", 701 | "group": "Language", 702 | "version": "0.4.0", 703 | "examples": [ 704 | { 705 | "title": "Test for indented comment.", 706 | "content": "This is example line 2.\nThis is example line 3.\nLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.", 707 | "type": "json" 708 | } 709 | ], 710 | "filename": "src/language.erl", 711 | "groupTitle": "Language", 712 | "sampleRequest": [ 713 | { 714 | "url": "https://api.github.com/v1/language/erlang/indented2" 715 | } 716 | ] 717 | }, 718 | { 719 | "type": "get", 720 | "url": "/language/javascript", 721 | "title": "JavaScript", 722 | "name": "GetLanguageJavaScript", 723 | "group": "Language", 724 | "version": "0.4.0", 725 | "description": "Test for JavaScript Comment-Syntax.
", 726 | "filename": "src/language.js", 727 | "groupTitle": "Language", 728 | "sampleRequest": [ 729 | { 730 | "url": "https://api.github.com/v1/language/javascript" 731 | } 732 | ] 733 | }, 734 | { 735 | "type": "get", 736 | "url": "/language/javascript/indented1", 737 | "title": "JavaScript indented 1", 738 | "name": "GetLanguageJavaScriptIndented1", 739 | "group": "Language", 740 | "version": "0.4.0", 741 | "examples": [ 742 | { 743 | "title": "Test for indented comment.", 744 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 745 | "type": "json" 746 | } 747 | ], 748 | "filename": "src/language.js", 749 | "groupTitle": "Language", 750 | "sampleRequest": [ 751 | { 752 | "url": "https://api.github.com/v1/language/javascript/indented1" 753 | } 754 | ] 755 | }, 756 | { 757 | "type": "get", 758 | "url": "/language/javascript/indented2", 759 | "title": "JavaScript indented 2", 760 | "name": "GetLanguageJavaScriptIndented2", 761 | "group": "Language", 762 | "version": "0.4.0", 763 | "examples": [ 764 | { 765 | "title": "Test for indented comment.", 766 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 767 | "type": "json" 768 | } 769 | ], 770 | "filename": "src/language.js", 771 | "groupTitle": "Language", 772 | "sampleRequest": [ 773 | { 774 | "url": "https://api.github.com/v1/language/javascript/indented2" 775 | } 776 | ] 777 | }, 778 | { 779 | "type": "get", 780 | "url": "/language/perl", 781 | "title": "Perl", 782 | "name": "GetLanguagePerl", 783 | "group": "Language", 784 | "version": "0.4.0", 785 | "description": "Test for Perl Comment-Syntax.
", 786 | "filename": "src/language.pm", 787 | "groupTitle": "Language", 788 | "sampleRequest": [ 789 | { 790 | "url": "https://api.github.com/v1/language/perl" 791 | } 792 | ] 793 | }, 794 | { 795 | "type": "get", 796 | "url": "/language/perl/indented1", 797 | "title": "Perl indented 1", 798 | "name": "GetLanguagePerlIndented1", 799 | "group": "Language", 800 | "version": "0.4.0", 801 | "examples": [ 802 | { 803 | "title": "Test for indented comment.", 804 | "content": "This is example line 2.\nThis is example line 3.\n\t\tLine 4 indented (with tab at beginning).\n\tLine 5 indented.\nThis is example line 6.", 805 | "type": "json" 806 | } 807 | ], 808 | "filename": "src/language.pm", 809 | "groupTitle": "Language", 810 | "sampleRequest": [ 811 | { 812 | "url": "https://api.github.com/v1/language/perl/indented1" 813 | } 814 | ] 815 | }, 816 | { 817 | "type": "get", 818 | "url": "/language/perl/indented2", 819 | "title": "Perl indented 2", 820 | "name": "GetLanguagePerlIndented2", 821 | "group": "Language", 822 | "version": "0.4.0", 823 | "examples": [ 824 | { 825 | "title": "Test for indented comment.", 826 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 827 | "type": "json" 828 | } 829 | ], 830 | "filename": "src/language.pm", 831 | "groupTitle": "Language", 832 | "sampleRequest": [ 833 | { 834 | "url": "https://api.github.com/v1/language/perl/indented2" 835 | } 836 | ] 837 | }, 838 | { 839 | "type": "get", 840 | "url": "/language/perl/podcut", 841 | "title": "Perl comment with pod and cut", 842 | "name": "GetLanguagePerlPodCut", 843 | "group": "Language", 844 | "version": "0.4.0", 845 | "examples": [ 846 | { 847 | "title": "Test for indented comment.", 848 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 849 | "type": "json" 850 | } 851 | ], 852 | "filename": "src/language.pm", 853 | "groupTitle": "Language", 854 | "sampleRequest": [ 855 | { 856 | "url": "https://api.github.com/v1/language/perl/podcut" 857 | } 858 | ] 859 | }, 860 | { 861 | "type": "get", 862 | "url": "/language/python", 863 | "title": "Python", 864 | "name": "GetLanguagePython", 865 | "group": "Language", 866 | "version": "0.4.0", 867 | "description": "Test for Python Comment-Syntax.
", 868 | "filename": "src/language.py", 869 | "groupTitle": "Language", 870 | "sampleRequest": [ 871 | { 872 | "url": "https://api.github.com/v1/language/python" 873 | } 874 | ] 875 | }, 876 | { 877 | "type": "get", 878 | "url": "/language/python/indented1", 879 | "title": "Python indented 1", 880 | "name": "GetLanguagePythonIndented1", 881 | "group": "Language", 882 | "version": "0.4.0", 883 | "examples": [ 884 | { 885 | "title": "Test for indented comment.", 886 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 887 | "type": "json" 888 | } 889 | ], 890 | "filename": "src/language.py", 891 | "groupTitle": "Language", 892 | "sampleRequest": [ 893 | { 894 | "url": "https://api.github.com/v1/language/python/indented1" 895 | } 896 | ] 897 | }, 898 | { 899 | "type": "get", 900 | "url": "/language/python/indented2", 901 | "title": "Python indented 2", 902 | "name": "GetLanguagePythonIndented2", 903 | "group": "Language", 904 | "version": "0.4.0", 905 | "examples": [ 906 | { 907 | "title": "Test for indented comment.", 908 | "content": "This is example line 2.\nThis is example line 3.\n Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 909 | "type": "json" 910 | } 911 | ], 912 | "filename": "src/language.py", 913 | "groupTitle": "Language", 914 | "sampleRequest": [ 915 | { 916 | "url": "https://api.github.com/v1/language/python/indented2" 917 | } 918 | ] 919 | }, 920 | { 921 | "type": "get", 922 | "url": "/language/ruby", 923 | "title": "Ruby", 924 | "name": "GetLanguageRuby", 925 | "group": "Language", 926 | "version": "0.4.0", 927 | "description": "Test for Ruby Comment-Syntax.
", 928 | "filename": "src/language.rb", 929 | "groupTitle": "Language", 930 | "sampleRequest": [ 931 | { 932 | "url": "https://api.github.com/v1/language/ruby" 933 | } 934 | ] 935 | }, 936 | { 937 | "type": "get", 938 | "url": "/language/ruby/indented1", 939 | "title": "Ruby indented 1", 940 | "name": "GetLanguageRubyIndented1", 941 | "group": "Language", 942 | "version": "0.4.0", 943 | "examples": [ 944 | { 945 | "title": "Test for indented comment.", 946 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 947 | "type": "json" 948 | } 949 | ], 950 | "filename": "src/language.rb", 951 | "groupTitle": "Language", 952 | "sampleRequest": [ 953 | { 954 | "url": "https://api.github.com/v1/language/ruby/indented1" 955 | } 956 | ] 957 | }, 958 | { 959 | "type": "get", 960 | "url": "/language/ruby/indented2", 961 | "title": "Ruby indented 2", 962 | "name": "GetLanguageRubyIndented2", 963 | "group": "Language", 964 | "version": "0.4.0", 965 | "examples": [ 966 | { 967 | "title": "Test for indented comment.", 968 | "content": "This is example line 2.\nThis is example line 3.\n\t Line 4 indented (with tab at beginning).\n Line 5 indented.\nThis is example line 6.", 969 | "type": "json" 970 | } 971 | ], 972 | "filename": "src/language.rb", 973 | "groupTitle": "Language", 974 | "sampleRequest": [ 975 | { 976 | "url": "https://api.github.com/v1/language/ruby/indented2" 977 | } 978 | ] 979 | }, 980 | { 981 | "type": "get", 982 | "url": "/markdown/:id", 983 | "title": "Markdown", 984 | "name": "GetMarkdown", 985 | "group": "Markdown", 986 | "version": "0.6.0", 987 | "description": "Enable markdown for all description fields.
This text is in a separate p.
Multiline markdown text, output in one line.
", 988 | "parameter": { 989 | "fields": { 990 | "Parameter": [ 991 | { 992 | "group": "Parameter", 993 | "type": "String", 994 | "optional": false, 995 | "field": "param1", 996 | "description": "This is a markdown apiParam
Separate line.
" 997 | } 998 | ] 999 | } 1000 | }, 1001 | "filename": "src/markdown.js", 1002 | "groupTitle": "Markdown", 1003 | "sampleRequest": [ 1004 | { 1005 | "url": "https://api.github.com/v1/markdown/:id" 1006 | } 1007 | ] 1008 | }, 1009 | { 1010 | "type": "get", 1011 | "url": "/param/:id", 1012 | "title": "Errors", 1013 | "name": "GetError", 1014 | "group": "Param", 1015 | "version": "0.1.0", 1016 | "description": "Returned error parameters. Syntax is the same as for @apiParam
", 1017 | "error": { 1018 | "fields": { 1019 | "Error 4xx": [ 1020 | { 1021 | "group": "Error 4xx", 1022 | "optional": false, 1023 | "field": "error1Error", 1024 | "description": "This is Error 1.
" 1025 | }, 1026 | { 1027 | "group": "Error 4xx", 1028 | "optional": false, 1029 | "field": "error2Error", 1030 | "description": "This is Error 2.
" 1031 | } 1032 | ] 1033 | } 1034 | }, 1035 | "filename": "src/api_param.js", 1036 | "groupTitle": "Param", 1037 | "sampleRequest": [ 1038 | { 1039 | "url": "https://api.github.com/v1/param/:id" 1040 | } 1041 | ] 1042 | }, 1043 | { 1044 | "type": "get", 1045 | "url": "/param/:id", 1046 | "title": "Parameters", 1047 | "name": "GetParam", 1048 | "group": "Param", 1049 | "version": "0.1.1", 1050 | "description": "Parameters and different Versions: 0.1.1
", 1051 | "parameter": { 1052 | "fields": { 1053 | "Parameter": [ 1054 | { 1055 | "group": "Parameter", 1056 | "optional": false, 1057 | "field": "param1", 1058 | "description": "Parameter and description.
" 1059 | }, 1060 | { 1061 | "group": "Parameter", 1062 | "optional": false, 1063 | "field": "param2", 1064 | "description": "" 1065 | }, 1066 | { 1067 | "group": "Parameter", 1068 | "optional": false, 1069 | "field": "param3", 1070 | "defaultValue": "Default Value", 1071 | "description": "Parameter, default value and description.
" 1072 | }, 1073 | { 1074 | "group": "Parameter", 1075 | "optional": false, 1076 | "field": "param4", 1077 | "defaultValue": "Default Value", 1078 | "description": "" 1079 | }, 1080 | { 1081 | "group": "Parameter", 1082 | "optional": true, 1083 | "field": "param5", 1084 | "description": "Optional parameter and description.
" 1085 | }, 1086 | { 1087 | "group": "Parameter", 1088 | "optional": true, 1089 | "field": "param6", 1090 | "description": "" 1091 | }, 1092 | { 1093 | "group": "Parameter", 1094 | "optional": true, 1095 | "field": "param7", 1096 | "defaultValue": "Default Value", 1097 | "description": "Optional parameter, default value and description.
" 1098 | }, 1099 | { 1100 | "group": "Parameter", 1101 | "optional": true, 1102 | "field": "param8", 1103 | "defaultValue": "Default Value", 1104 | "description": "" 1105 | }, 1106 | { 1107 | "group": "Parameter", 1108 | "type": "String", 1109 | "optional": false, 1110 | "field": "param9", 1111 | "description": "Type, parameter and description.
" 1112 | }, 1113 | { 1114 | "group": "Parameter", 1115 | "type": "String", 1116 | "optional": false, 1117 | "field": "param10", 1118 | "description": "" 1119 | }, 1120 | { 1121 | "group": "Parameter", 1122 | "type": "String", 1123 | "optional": false, 1124 | "field": "param11", 1125 | "defaultValue": "Default Value", 1126 | "description": "Type, parameter and default value.
" 1127 | }, 1128 | { 1129 | "group": "Parameter", 1130 | "type": "String", 1131 | "optional": false, 1132 | "field": "param12", 1133 | "defaultValue": "Default Value", 1134 | "description": "" 1135 | }, 1136 | { 1137 | "group": "Parameter", 1138 | "type": "String", 1139 | "optional": true, 1140 | "field": "param13", 1141 | "description": "Type, optional parameter and description.
" 1142 | }, 1143 | { 1144 | "group": "Parameter", 1145 | "type": "String", 1146 | "optional": true, 1147 | "field": "param14", 1148 | "description": "" 1149 | }, 1150 | { 1151 | "group": "Parameter", 1152 | "type": "String", 1153 | "optional": true, 1154 | "field": "param15", 1155 | "defaultValue": "Default Value", 1156 | "description": "Type, optional parameter, default value and description.
" 1157 | }, 1158 | { 1159 | "group": "Parameter", 1160 | "type": "String", 1161 | "optional": true, 1162 | "field": "param26", 1163 | "defaultValue": "Default Value", 1164 | "description": "" 1165 | }, 1166 | { 1167 | "group": "Parameter", 1168 | "type": "String", 1169 | "size": "4,8", 1170 | "optional": false, 1171 | "field": "param17", 1172 | "description": "Type, size, parameter and description.
" 1173 | }, 1174 | { 1175 | "group": "Parameter", 1176 | "type": "Number", 1177 | "size": "1-3", 1178 | "optional": false, 1179 | "field": "param18", 1180 | "description": "Type, size, parameter and description.
" 1181 | }, 1182 | { 1183 | "group": "Parameter", 1184 | "type": "String", 1185 | "size": "4,8", 1186 | "optional": false, 1187 | "field": "param19", 1188 | "defaultValue": "Default Value", 1189 | "description": "Type, size, parameter, default value and description.
" 1190 | }, 1191 | { 1192 | "group": "Parameter", 1193 | "type": "Number", 1194 | "size": "1-3", 1195 | "optional": false, 1196 | "field": "param20", 1197 | "defaultValue": "1", 1198 | "description": "Type, size, parameter, default value and description.
" 1199 | }, 1200 | { 1201 | "group": "Parameter", 1202 | "type": "String", 1203 | "allowedValues": [ 1204 | "\"value 1\"" 1205 | ], 1206 | "optional": false, 1207 | "field": "param21", 1208 | "description": "Type, parameter and allowed string value.
" 1209 | }, 1210 | { 1211 | "group": "Parameter", 1212 | "type": "String", 1213 | "allowedValues": [ 1214 | "\"value 1\"", 1215 | "\"value 2\"" 1216 | ], 1217 | "optional": false, 1218 | "field": "param22", 1219 | "description": "Type, parameter and allowed list of string values.
" 1220 | }, 1221 | { 1222 | "group": "Parameter", 1223 | "type": "Number", 1224 | "allowedValues": [ 1225 | "4711" 1226 | ], 1227 | "optional": false, 1228 | "field": "param23", 1229 | "description": "Type, parameter and allowed value.
" 1230 | }, 1231 | { 1232 | "group": "Parameter", 1233 | "type": "Number", 1234 | "allowedValues": [ 1235 | "4711", 1236 | "4712" 1237 | ], 1238 | "optional": false, 1239 | "field": "param24", 1240 | "description": "Type, parameter and allowed list of values.
" 1241 | }, 1242 | { 1243 | "group": "Parameter", 1244 | "type": "String", 1245 | "size": "1,10", 1246 | "allowedValues": [ 1247 | "\"value 1\"" 1248 | ], 1249 | "optional": false, 1250 | "field": "param25", 1251 | "description": "Type, size, parameter and allowed string value.
" 1252 | }, 1253 | { 1254 | "group": "Parameter", 1255 | "type": "Number", 1256 | "size": "1-9999", 1257 | "allowedValues": [ 1258 | "4711" 1259 | ], 1260 | "optional": false, 1261 | "field": "param27", 1262 | "description": "Type, size, parameter and allowed value.
" 1263 | }, 1264 | { 1265 | "group": "Parameter", 1266 | "type": "Number", 1267 | "size": "1-9999", 1268 | "allowedValues": [ 1269 | "4711", 1270 | "4712" 1271 | ], 1272 | "optional": false, 1273 | "field": "param28", 1274 | "description": "Type, size, parameter and allowed list of values.
" 1275 | }, 1276 | { 1277 | "group": "Parameter", 1278 | "type": "Custom", 1279 | "optional": false, 1280 | "field": "param29", 1281 | "description": "Type with markdown link.
" 1282 | } 1283 | ] 1284 | } 1285 | }, 1286 | "filename": "src/api_param.js", 1287 | "groupTitle": "Param", 1288 | "sampleRequest": [ 1289 | { 1290 | "url": "https://api.github.com/v1/param/:id" 1291 | } 1292 | ] 1293 | }, 1294 | { 1295 | "type": "get", 1296 | "url": "/param/:id", 1297 | "title": "Parameters", 1298 | "name": "GetParam", 1299 | "group": "Param", 1300 | "version": "0.1.0", 1301 | "description": "Parameters and different Versions: 0.1.0
", 1302 | "parameter": { 1303 | "fields": { 1304 | "Parameter": [ 1305 | { 1306 | "group": "Parameter", 1307 | "type": "String", 1308 | "optional": false, 1309 | "field": "param0", 1310 | "description": "This param is removed in 0.1.1.
" 1311 | }, 1312 | { 1313 | "group": "Parameter", 1314 | "type": "String", 1315 | "optional": false, 1316 | "field": "param1", 1317 | "description": "This is an old text.
" 1318 | }, 1319 | { 1320 | "group": "Parameter", 1321 | "type": "String", 1322 | "optional": false, 1323 | "field": "param2", 1324 | "description": "" 1325 | }, 1326 | { 1327 | "group": "Parameter", 1328 | "type": "String", 1329 | "optional": false, 1330 | "field": "param3", 1331 | "defaultValue": "Default Value", 1332 | "description": "Parameter with type, description and default value.
" 1333 | }, 1334 | { 1335 | "group": "Parameter", 1336 | "type": "String", 1337 | "optional": false, 1338 | "field": "param4", 1339 | "defaultValue": "Default Value", 1340 | "description": "" 1341 | }, 1342 | { 1343 | "group": "Parameter", 1344 | "optional": false, 1345 | "field": "param5", 1346 | "description": "Basic Parameter with description.
" 1347 | }, 1348 | { 1349 | "group": "Parameter", 1350 | "optional": false, 1351 | "field": "param6", 1352 | "description": "" 1353 | }, 1354 | { 1355 | "group": "Parameter", 1356 | "optional": false, 1357 | "field": "param7", 1358 | "defaultValue": "Default Value", 1359 | "description": "Basic Parameter with description and default value.
" 1360 | }, 1361 | { 1362 | "group": "Parameter", 1363 | "optional": false, 1364 | "field": "param8", 1365 | "defaultValue": "Default Value", 1366 | "description": "" 1367 | }, 1368 | { 1369 | "group": "Parameter", 1370 | "optional": true, 1371 | "field": "param9", 1372 | "description": "Optional basic Parameter with description.
" 1373 | }, 1374 | { 1375 | "group": "Parameter", 1376 | "optional": true, 1377 | "field": "param10", 1378 | "description": "" 1379 | }, 1380 | { 1381 | "group": "Parameter", 1382 | "optional": true, 1383 | "field": "param11", 1384 | "defaultValue": "Default Value", 1385 | "description": "Optional basic Parameter with description and default value.
" 1386 | }, 1387 | { 1388 | "group": "Parameter", 1389 | "optional": true, 1390 | "field": "param12", 1391 | "defaultValue": "Default Value", 1392 | "description": "" 1393 | }, 1394 | { 1395 | "group": "Parameter", 1396 | "type": "String", 1397 | "optional": true, 1398 | "field": "param13", 1399 | "description": "Optional Parameter with type and description.
" 1400 | }, 1401 | { 1402 | "group": "Parameter", 1403 | "type": "String", 1404 | "optional": true, 1405 | "field": "param14", 1406 | "description": "" 1407 | }, 1408 | { 1409 | "group": "Parameter", 1410 | "type": "String", 1411 | "optional": true, 1412 | "field": "param15", 1413 | "defaultValue": "Default Value", 1414 | "description": "Optional Parameter with type, description and default value.
" 1415 | }, 1416 | { 1417 | "group": "Parameter", 1418 | "type": "String", 1419 | "optional": true, 1420 | "field": "param16", 1421 | "defaultValue": "Default Value", 1422 | "description": "" 1423 | } 1424 | ] 1425 | } 1426 | }, 1427 | "filename": "src/api_param.js", 1428 | "groupTitle": "Param", 1429 | "sampleRequest": [ 1430 | { 1431 | "url": "https://api.github.com/v1/param/:id" 1432 | } 1433 | ] 1434 | }, 1435 | { 1436 | "type": "get", 1437 | "url": "/param/example/", 1438 | "title": "Param Example", 1439 | "name": "GetParamExample", 1440 | "group": "Param", 1441 | "version": "0.8.0", 1442 | "description": "Usage of @apiParamExample.
", 1443 | "examples": [ 1444 | { 1445 | "title": "A common example:", 1446 | "content": "curl -i http://localhost/param/example/", 1447 | "type": "json" 1448 | } 1449 | ], 1450 | "parameter": { 1451 | "fields": { 1452 | "Parameter": [ 1453 | { 1454 | "group": "Parameter", 1455 | "type": "String", 1456 | "optional": false, 1457 | "field": "name", 1458 | "description": "Fullname.
" 1459 | } 1460 | ] 1461 | }, 1462 | "examples": [ 1463 | { 1464 | "title": "A JSON example:", 1465 | "content": "{\n \"name\": \"John Doe\"\n}", 1466 | "type": "json" 1467 | } 1468 | ] 1469 | }, 1470 | "filename": "src/api_param_example.js", 1471 | "groupTitle": "Param", 1472 | "sampleRequest": [ 1473 | { 1474 | "url": "https://api.github.com/v1/param/example/" 1475 | } 1476 | ] 1477 | }, 1478 | { 1479 | "type": "get", 1480 | "url": "/param/:id", 1481 | "title": "Success", 1482 | "name": "GetSuccess", 1483 | "group": "Param", 1484 | "version": "0.1.0", 1485 | "description": "Returned success parameters. Syntax is the same as for @apiParam
", 1486 | "error": { 1487 | "fields": { 1488 | "Error 4xx": [ 1489 | { 1490 | "group": "Error 4xx", 1491 | "optional": false, 1492 | "field": "success1", 1493 | "description": "This is Success 1.
" 1494 | }, 1495 | { 1496 | "group": "Error 4xx", 1497 | "optional": false, 1498 | "field": "success2", 1499 | "description": "This is Success 2.
" 1500 | } 1501 | ] 1502 | } 1503 | }, 1504 | "filename": "src/api_param.js", 1505 | "groupTitle": "Param", 1506 | "sampleRequest": [ 1507 | { 1508 | "url": "https://api.github.com/v1/param/:id" 1509 | } 1510 | ] 1511 | }, 1512 | { 1513 | "type": "get", 1514 | "url": "/permission/", 1515 | "title": "Permission", 1516 | "name": "GetPermission", 1517 | "group": "Permission", 1518 | "version": "0.8.0", 1519 | "description": "@apiPermission test.
", 1520 | "permission": [ 1521 | { 1522 | "name": "permission_admin", 1523 | "title": "Admin access.", 1524 | "description": "Some description.
" 1525 | } 1526 | ], 1527 | "filename": "src/api_permission.js", 1528 | "groupTitle": "Permission", 1529 | "sampleRequest": [ 1530 | { 1531 | "url": "https://api.github.com/v1/permission/" 1532 | } 1533 | ] 1534 | }, 1535 | { 1536 | "type": "get", 1537 | "url": "/permission/", 1538 | "title": "Permission", 1539 | "name": "GetPermission", 1540 | "group": "Permission", 1541 | "version": "0.8.0", 1542 | "description": "@apiPermission test.
", 1543 | "permission": [ 1544 | { 1545 | "name": "permission_admin", 1546 | "title": "Admin access.", 1547 | "description": "Some description.
" 1548 | }, 1549 | { 1550 | "name": "permission_user", 1551 | "title": "User access.", 1552 | "description": "" 1553 | } 1554 | ], 1555 | "filename": "src/api_permission.js", 1556 | "groupTitle": "Permission", 1557 | "sampleRequest": [ 1558 | { 1559 | "url": "https://api.github.com/v1/permission/" 1560 | } 1561 | ] 1562 | }, 1563 | { 1564 | "type": "get", 1565 | "url": "/indent/trim/multi/spaces", 1566 | "title": "Trim multi line (spaces)", 1567 | "group": "indent", 1568 | "description": "Text line 1 (Begin: 4xSpaces (3 removed)). Text line 2 (Begin: 3xSpaces (3 removed), End: 2xSpaces).
", 1569 | "version": "0.0.0", 1570 | "filename": "src/indent.js", 1571 | "groupTitle": "Indent", 1572 | "name": "GetIndentTrimMultiSpaces", 1573 | "sampleRequest": [ 1574 | { 1575 | "url": "https://api.github.com/v1/indent/trim/multi/spaces" 1576 | } 1577 | ] 1578 | }, 1579 | { 1580 | "type": "get", 1581 | "url": "/indent/trim/multi/tabs", 1582 | "title": "Trim multi line (tabs)", 1583 | "group": "indent", 1584 | "description": "Text line 1 (Begin: 3xTab (2 removed)). Text line 2 (Begin: 2x Tab (2 removed), End: 1xTab).
", 1585 | "version": "0.0.0", 1586 | "filename": "src/indent.js", 1587 | "groupTitle": "Indent", 1588 | "name": "GetIndentTrimMultiTabs", 1589 | "sampleRequest": [ 1590 | { 1591 | "url": "https://api.github.com/v1/indent/trim/multi/tabs" 1592 | } 1593 | ] 1594 | }, 1595 | { 1596 | "type": "get", 1597 | "url": "/indent/trim/multi/tabs/and/space", 1598 | "title": "Trim multi line (tabs and space)", 1599 | "group": "indent", 1600 | "description": "Text line 1 (Begin: 1xTab, 2xSpaces). Text line 2 (Begin: 3xSpaces, End: 1xTab).
", 1601 | "version": "0.0.0", 1602 | "filename": "src/indent.js", 1603 | "groupTitle": "Indent", 1604 | "name": "GetIndentTrimMultiTabsAndSpace", 1605 | "sampleRequest": [ 1606 | { 1607 | "url": "https://api.github.com/v1/indent/trim/multi/tabs/and/space" 1608 | } 1609 | ] 1610 | }, 1611 | { 1612 | "type": "get", 1613 | "url": "/indent/trim/single", 1614 | "title": "Trim single line", 1615 | "group": "indent", 1616 | "description": "Text line 1 (Begin: 3xSpaces (3 removed), End: 1xSpace).
", 1617 | "version": "0.0.0", 1618 | "filename": "src/indent.js", 1619 | "groupTitle": "Indent", 1620 | "name": "GetIndentTrimSingle", 1621 | "sampleRequest": [ 1622 | { 1623 | "url": "https://api.github.com/v1/indent/trim/single" 1624 | } 1625 | ] 1626 | }, 1627 | { 1628 | "type": "get", 1629 | "url": "/indent/word", 1630 | "title": "Indent a word", 1631 | "group": "indent", 1632 | "description": "text.
", 1633 | "version": "0.0.0", 1634 | "filename": "src/indent.js", 1635 | "groupTitle": "Indent", 1636 | "name": "GetIndentWord", 1637 | "sampleRequest": [ 1638 | { 1639 | "url": "https://api.github.com/v1/indent/word" 1640 | } 1641 | ] 1642 | } 1643 | ] 1644 | --------------------------------------------------------------------------------