Socket
Socket
Sign inDemoInstall

apidoc

Package Overview
Dependencies
Maintainers
1
Versions
96
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apidoc - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

EXAMPLES.md

5

CHANGELOG.md
# apiDoc Changelog
#### 0.8.1
* Bugfix: Python regex doublequote. (https://github.com/apidoc/apidoc/issues/151)
* Bugfix: Issue with multiple apiSuccessExample blocks. (https://github.com/apidoc/apidoc/issues/150)
#### 0.8.0

@@ -5,0 +10,0 @@

30

lib/parser.js

@@ -337,6 +337,6 @@ var fs = require('fs');

'.coffee': {
// Find document blocks between '###' and '###'
// find document blocks between '###' and '###'
docBlocksRegExp: /###\uffff?(.+?)###/g,
// Remove not needed ' ' (tabs) at the beginning
inlineRegExp: /^(\s*)?[ ]?/gm
// remove not needed tabs at the beginning
inlineRegExp: /^(\t*)?/gm
},

@@ -346,3 +346,3 @@ '.erl': {

docBlocksRegExp: /\%*\{\uffff?(.+?)\%+\}/g,
// Remove not needed ' % ' and ' ' (tabs) at the beginning
// remove not needed ' % ' and tabs at the beginning
// HINT: Not sure if erlang developer use the %, but i think it should be no problem

@@ -352,24 +352,24 @@ inlineRegExp: /^(\s*)?(\%*)[ ]?/gm

'.py': {
// Find document blocks between ''' and '''
docBlocksRegExp: /\'\'\'\uffff?(.+?)\'\'\'/g,
// Remove not needed ' ' (tabs) at the beginning
inlineRegExp: /^(\s*)?[ ]?/gm
// find document blocks between """ and """
docBlocksRegExp: /\"\"\"\uffff?(.+?)\"\"\"/g,
// remove not needed tabs at the beginning
inlineRegExp: /^(\t*)?/gm
},
'.rb': {
// Find document blocks between '=begin' and '=end'
// find document blocks between '=begin' and '=end'
docBlocksRegExp: /\=begin\uffff?(.+?)\=end/g,
// Remove not needed ' ' (tabs) at the beginning
inlineRegExp: /^(\s*)?[ ]?/gm
// remove not needed tabs at the beginning
inlineRegExp: /^(\t*)?/gm
},
'.pm': {
// Find document blocks between '#**' and '#*'
// find document blocks between '#**' and '#*'
// or between '=pod' and '=cut'
docBlocksRegExp: /#\*\*\uffff?(.+?)#\*|=pod\uffff?(.+?)=cut/g,
// Remove not needed ' # ' and ' ' (tabs) at the beginning
// remove not needed ' # ' and tabs at the beginning
inlineRegExp: /^(\s*)?(#)[ ]?/gm
},
'default': {
// Find document blocks between '#**' and '#*'
// find document blocks between '#**' and '#*'
docBlocksRegExp: /\/\*\*\uffff?(.+?)\*\//g,
// Remove not needed ' * ' and ' ' (tabs) at the beginning
// remove not needed ' * ' and tabs at the beginning
inlineRegExp: /^(\s*)?(\*)[ ]?/gm

@@ -376,0 +376,0 @@ }

57

lib/parsers/api_example.js
function parse(content, source) {
// trim
source = source.replace(/^\s*|\s*$/g, '');
// trim
source = source.replace(/^\s*|\s*$/g, '');
var title = '';
var text = '';
var type;
var title = '';
var text = '';
var type;
// Search for [@apiExample title] and content
var parseRegExp = /^(@\w*)?\s?(?:(?:\{(.+?)\})\s*)?(.*)$/gm;
// Search for @apiExample "[{type}] title and content
// /^(@\w*)?\s?(?:(?:\{(.+?)\})\s*)?(.*)$/gm;
var parseRegExpFirstLine = /(@\w*)?(?:(?:\s*\{\s*([a-zA-Z0-9\.\/\\\[\]_-]+)\s*\}\s*)?\s*(.*)?)?/;
var parseRegExpFollowing = /(^.*\s?)/gm;
var matches;
while(matches = parseRegExp.exec(source))
{
if (matches[1] && matches[3])
title += matches[3]; // @apiExample and title in the same line
if (matches[2])
type = matches[2];
else
if( ! matches[1] && matches[3])
text += matches[3] + '\n';
} // while
var matches;
if (matches = parseRegExpFirstLine.exec(source)) {
type = matches[2];
title = matches[3];
}
if (text.length === 0)
return null;
parseRegExpFollowing.exec(content); // ignore line 1
while (matches = parseRegExpFollowing.exec(source)) {
text += matches[1];
}
return {
title : title,
content: text,
type : type || 'json'
};
if (text.length === 0)
return null;
return {
title : title,
content: text,
type : type || 'json'
};
}

@@ -38,5 +39,5 @@

module.exports = {
parse : parse,
path : 'local.examples',
method: 'push'
parse : parse,
path : 'local.examples',
method: 'push'
};

2

package.json
{
"name": "apidoc",
"version": "0.8.0",
"version": "0.8.1",
"description": "RESTful web API Documentation Generator",

@@ -5,0 +5,0 @@ "author": "Peter Rottmann <rottmann@inveris.de>",

2

README.md

@@ -8,2 +8,4 @@ # apiDoc 0.8.x

**Changes from 0.7.x visit [CHANGELOG.md](https://github.com/apidoc/apidoc/blob/master/CHANGELOG.md)**
apiDoc creates a documentation from API descriptions in your source code.

@@ -10,0 +12,0 @@

120

test/fixtures/api_data.js

@@ -138,3 +138,3 @@ define({ api: [

"title": "Example usage:",
"content": " curl -i http://localhost/escape/text\n <b>curl -i http://localhost/escape/html</b>\n <xml>curl -i http://localhost/escape/xml</xml>\n",
"content": " curl -i http://localhost/escape/text\n <b>curl -i http://localhost/escape/html</b>\n <xml>curl -i http://localhost/escape/xml</xml>",
"type": "json"

@@ -147,3 +147,3 @@ }

"title": "Example Response",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}",
"type": "json"

@@ -172,3 +172,3 @@ }

"title": "Example usage:",
"content": " curl -i http://localhost/escape/text-old\n <b>curl -i http://localhost/escape/html-old</b>\n <xml>curl -i http://localhost/escape/xml-old</xml>\n",
"content": " curl -i http://localhost/escape/text-old\n <b>curl -i http://localhost/escape/html-old</b>\n <xml>curl -i http://localhost/escape/xml-old</xml>",
"type": "json"

@@ -181,3 +181,3 @@ }

"title": "Example Response",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}",
"type": "json"

@@ -206,3 +206,3 @@ }

"title": "PHP Example (new)",
"content": "echo 'This is the content. (new)';\n",
"content": "echo 'This is the content. (new)';",
"type": "PHP"

@@ -212,3 +212,3 @@ },

"title": "JS Example",
"content": "console.log('This is the content.');\n",
"content": "console.log('This is the content.');",
"type": "JS"

@@ -221,3 +221,3 @@ }

"title": "PHP Success Example (new)",
"content": "echo 'This is the success content. (new)';\n",
"content": "echo 'This is the success content. (new)';",
"type": "PHP"

@@ -227,3 +227,3 @@ },

"title": "JS Success Example",
"content": "console.log('This is the success content.');\n",
"content": "console.log('This is the success content.');",
"type": "JS"

@@ -237,3 +237,3 @@ }

"title": "PHP Error Example",
"content": "echo 'This is the error content.';\n",
"content": "echo 'This is the error content.';",
"type": "PHP"

@@ -243,3 +243,3 @@ },

"title": "JS Error Example",
"content": "console.log('This is the error content.');\n",
"content": "console.log('This is the error content.');",
"type": "JS"

@@ -268,3 +268,3 @@ }

"title": "PHP Example",
"content": "echo 'This is the content.';\n",
"content": "echo 'This is the content.';",
"type": "PHP"

@@ -274,3 +274,3 @@ },

"title": "JS Example (removed)",
"content": "console.log('This is the content. (removed)');\n",
"content": "console.log('This is the content. (removed)');",
"type": "JS"

@@ -283,3 +283,3 @@ }

"title": "PHP Success Example",
"content": "echo 'This is the success content.';\n",
"content": "echo 'This is the success content.';",
"type": "PHP"

@@ -289,3 +289,3 @@ },

"title": "JS Success Example",
"content": "console.log('This is the success content.');\n",
"content": "console.log('This is the success content.');",
"type": "JS"

@@ -299,3 +299,3 @@ }

"title": "PHP Error Example (removed)",
"content": "echo 'This is the error content. (removed)';\n",
"content": "echo 'This is the error content. (removed)';",
"type": "PHP"

@@ -305,3 +305,3 @@ },

"title": "JS Error Example",
"content": "console.log('This is the error content.');\n",
"content": "console.log('This is the error content.');",
"type": "JS"

@@ -587,3 +587,3 @@ }

"title": "An example:",
"content": " curl -i http://localhost/header/example/\n",
"content": " curl -i http://localhost/header/example/",
"type": "json"

@@ -701,3 +701,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -724,3 +724,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -763,3 +763,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"content": "\tThis is example line 2.\n\tThis is example line 3.\n\t\t Line 4 indented (with tab at beginning).\n\t Line 5 indented.\n\tThis is example line 6.",
"type": "json"

@@ -786,3 +786,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -825,3 +825,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -848,3 +848,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -887,3 +887,3 @@ }

"title": "Test for indented comment.",
"content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n",
"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.",
"type": "json"

@@ -910,3 +910,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -933,3 +933,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -948,2 +948,62 @@ }

"type": "get",
"url": "/language/python",
"title": "Python",
"name": "GetLanguagePython",
"group": "Language",
"version": "0.4.0",
"description": "<p>Test for Python Comment-Syntax.</p> ",
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python"
}
]
},
{
"type": "get",
"url": "/language/python/indented1",
"title": "Python indented 1",
"name": "GetLanguagePythonIndented1",
"group": "Language",
"version": "0.4.0",
"examples": [
{
"title": "Test for indented comment.",
"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.",
"type": "json"
}
],
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python/indented1"
}
]
},
{
"type": "get",
"url": "/language/python/indented2",
"title": "Python indented 2",
"name": "GetLanguagePythonIndented2",
"group": "Language",
"version": "0.4.0",
"examples": [
{
"title": "Test for indented comment.",
"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.",
"type": "json"
}
],
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python/indented2"
}
]
},
{
"type": "get",
"url": "/language/ruby",

@@ -973,3 +1033,3 @@ "title": "Ruby",

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -996,3 +1056,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -1434,3 +1494,3 @@ }

"title": "A common example:",
"content": " curl -i http://localhost/param/example/\n",
"content": " curl -i http://localhost/param/example/",
"type": "json"

@@ -1454,3 +1514,3 @@ }

"title": "A JSON example:",
"content": " {\n \"name\": \"John Doe\"\n }\n",
"content": " {\n \"name\": \"John Doe\"\n }",
"type": "json"

@@ -1457,0 +1517,0 @@ }

120

test/fixtures/api_data.json

@@ -138,3 +138,3 @@ [

"title": "Example usage:",
"content": " curl -i http://localhost/escape/text\n <b>curl -i http://localhost/escape/html</b>\n <xml>curl -i http://localhost/escape/xml</xml>\n",
"content": " curl -i http://localhost/escape/text\n <b>curl -i http://localhost/escape/html</b>\n <xml>curl -i http://localhost/escape/xml</xml>",
"type": "json"

@@ -147,3 +147,3 @@ }

"title": "Example Response",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}\n",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value',\n field_html: '<b>html-value</b>',\n field_xml: '<xml>xml-value</xml>'\n}",
"type": "json"

@@ -172,3 +172,3 @@ }

"title": "Example usage:",
"content": " curl -i http://localhost/escape/text-old\n <b>curl -i http://localhost/escape/html-old</b>\n <xml>curl -i http://localhost/escape/xml-old</xml>\n",
"content": " curl -i http://localhost/escape/text-old\n <b>curl -i http://localhost/escape/html-old</b>\n <xml>curl -i http://localhost/escape/xml-old</xml>",
"type": "json"

@@ -181,3 +181,3 @@ }

"title": "Example Response",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}\n",
"content": "HTTP/1.1 200 OK {\n field_text: 'text-value old',\n field_html: '<b>html-value old</b>',\n field_xml: '<xml>xml-value old</xml>'\n}",
"type": "json"

@@ -206,3 +206,3 @@ }

"title": "PHP Example (new)",
"content": "echo 'This is the content. (new)';\n",
"content": "echo 'This is the content. (new)';",
"type": "PHP"

@@ -212,3 +212,3 @@ },

"title": "JS Example",
"content": "console.log('This is the content.');\n",
"content": "console.log('This is the content.');",
"type": "JS"

@@ -221,3 +221,3 @@ }

"title": "PHP Success Example (new)",
"content": "echo 'This is the success content. (new)';\n",
"content": "echo 'This is the success content. (new)';",
"type": "PHP"

@@ -227,3 +227,3 @@ },

"title": "JS Success Example",
"content": "console.log('This is the success content.');\n",
"content": "console.log('This is the success content.');",
"type": "JS"

@@ -237,3 +237,3 @@ }

"title": "PHP Error Example",
"content": "echo 'This is the error content.';\n",
"content": "echo 'This is the error content.';",
"type": "PHP"

@@ -243,3 +243,3 @@ },

"title": "JS Error Example",
"content": "console.log('This is the error content.');\n",
"content": "console.log('This is the error content.');",
"type": "JS"

@@ -268,3 +268,3 @@ }

"title": "PHP Example",
"content": "echo 'This is the content.';\n",
"content": "echo 'This is the content.';",
"type": "PHP"

@@ -274,3 +274,3 @@ },

"title": "JS Example (removed)",
"content": "console.log('This is the content. (removed)');\n",
"content": "console.log('This is the content. (removed)');",
"type": "JS"

@@ -283,3 +283,3 @@ }

"title": "PHP Success Example",
"content": "echo 'This is the success content.';\n",
"content": "echo 'This is the success content.';",
"type": "PHP"

@@ -289,3 +289,3 @@ },

"title": "JS Success Example",
"content": "console.log('This is the success content.');\n",
"content": "console.log('This is the success content.');",
"type": "JS"

@@ -299,3 +299,3 @@ }

"title": "PHP Error Example (removed)",
"content": "echo 'This is the error content. (removed)';\n",
"content": "echo 'This is the error content. (removed)';",
"type": "PHP"

@@ -305,3 +305,3 @@ },

"title": "JS Error Example",
"content": "console.log('This is the error content.');\n",
"content": "console.log('This is the error content.');",
"type": "JS"

@@ -587,3 +587,3 @@ }

"title": "An example:",
"content": " curl -i http://localhost/header/example/\n",
"content": " curl -i http://localhost/header/example/",
"type": "json"

@@ -701,3 +701,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -724,3 +724,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -763,3 +763,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"content": "\tThis is example line 2.\n\tThis is example line 3.\n\t\t Line 4 indented (with tab at beginning).\n\t Line 5 indented.\n\tThis is example line 6.",
"type": "json"

@@ -786,3 +786,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -825,3 +825,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -848,3 +848,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -887,3 +887,3 @@ }

"title": "Test for indented comment.",
"content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n",
"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.",
"type": "json"

@@ -910,3 +910,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -933,3 +933,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -948,2 +948,62 @@ }

"type": "get",
"url": "/language/python",
"title": "Python",
"name": "GetLanguagePython",
"group": "Language",
"version": "0.4.0",
"description": "<p>Test for Python Comment-Syntax.</p> ",
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python"
}
]
},
{
"type": "get",
"url": "/language/python/indented1",
"title": "Python indented 1",
"name": "GetLanguagePythonIndented1",
"group": "Language",
"version": "0.4.0",
"examples": [
{
"title": "Test for indented comment.",
"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.",
"type": "json"
}
],
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python/indented1"
}
]
},
{
"type": "get",
"url": "/language/python/indented2",
"title": "Python indented 2",
"name": "GetLanguagePythonIndented2",
"group": "Language",
"version": "0.4.0",
"examples": [
{
"title": "Test for indented comment.",
"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.",
"type": "json"
}
],
"filename": "test/fixtures/example/language.py",
"groupTitle": "Language",
"sampleRequest": [
{
"url": "https://api.github.com/v1/language/python/indented2"
}
]
},
{
"type": "get",
"url": "/language/ruby",

@@ -973,3 +1033,3 @@ "title": "Ruby",

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -996,3 +1056,3 @@ }

"title": "Test for indented comment.",
"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.\n",
"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.",
"type": "json"

@@ -1434,3 +1494,3 @@ }

"title": "A common example:",
"content": " curl -i http://localhost/param/example/\n",
"content": " curl -i http://localhost/param/example/",
"type": "json"

@@ -1454,3 +1514,3 @@ }

"title": "A JSON example:",
"content": " {\n \"name\": \"John Doe\"\n }\n",
"content": " {\n \"name\": \"John Doe\"\n }",
"type": "json"

@@ -1457,0 +1517,0 @@ }

2

test/fixtures/api_project.js

@@ -17,5 +17,5 @@ define({

"version": "0.8.0",
"time": "2014-11-17T17:12:45.480Z"
"time": "2014-11-18T09:02:40.011Z"
},
"apidoc": "0.2.0"
});

2

test/fixtures/api_project.json

@@ -17,5 +17,5 @@ {

"version": "0.8.0",
"time": "2014-11-17T17:12:45.480Z"
"time": "2014-11-18T09:02:40.011Z"
},
"apidoc": "0.2.0"
}
EXAMPLES.MD
test/fixtures/example/language.pm

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc