summaryrefslogtreecommitdiff
path: root/src/web/docs/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-12-15 06:41:57 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-12-15 06:41:57 +0900
commit169b99a358f166185147970b916adf1a09d23de3 (patch)
tree0d776993023e81ca7665efa1d896655e2d7cf928 /src/web/docs/api
parent:v: (diff)
downloadsharkey-169b99a358f166185147970b916adf1a09d23de3.tar.gz
sharkey-169b99a358f166185147970b916adf1a09d23de3.tar.bz2
sharkey-169b99a358f166185147970b916adf1a09d23de3.zip
:v:
Diffstat (limited to 'src/web/docs/api')
-rw-r--r--src/web/docs/api/endpoints/view.pug3
-rw-r--r--src/web/docs/api/entities/view.pug2
-rw-r--r--src/web/docs/api/gulpfile.ts60
-rw-r--r--src/web/docs/api/mixins.pug6
4 files changed, 43 insertions, 28 deletions
diff --git a/src/web/docs/api/endpoints/view.pug b/src/web/docs/api/endpoints/view.pug
index cebef9fa5b..cab814cabc 100644
--- a/src/web/docs/api/endpoints/view.pug
+++ b/src/web/docs/api/endpoints/view.pug
@@ -12,7 +12,7 @@ block main
p#url= url
- p#desc: +i18n(desc)
+ p#desc= desc[lang] || desc['ja']
section
h2 Params
@@ -27,4 +27,3 @@ block main
section
h2 Response
+propTable(res)
-
diff --git a/src/web/docs/api/entities/view.pug b/src/web/docs/api/entities/view.pug
index f210582f1a..756e966b53 100644
--- a/src/web/docs/api/entities/view.pug
+++ b/src/web/docs/api/entities/view.pug
@@ -10,7 +10,7 @@ block meta
block main
h1= name
- p#desc: +i18n(desc)
+ p#desc= desc[lang] || desc['ja']
section
h2 Properties
diff --git a/src/web/docs/api/gulpfile.ts b/src/web/docs/api/gulpfile.ts
index 6453996d31..6cbae5ea2d 100644
--- a/src/web/docs/api/gulpfile.ts
+++ b/src/web/docs/api/gulpfile.ts
@@ -12,6 +12,12 @@ import * as mkdirp from 'mkdirp';
import config from './../../../conf';
+import generateVars from '../vars';
+
+const commonVars = generateVars();
+
+const langs = ['ja', 'en'];
+
const kebab = string => string.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/\s+/g, '-').toLowerCase();
const parseParam = param => {
@@ -102,20 +108,25 @@ gulp.task('doc:api:endpoints', () => {
paramDefs: extractDefs(ep.params),
res: sortParams(ep.res.map(p => parseParam(p))),
resDefs: extractDefs(ep.res),
- kebab
+ kebab,
+ common: commonVars
};
- pug.renderFile('./src/web/docs/api/endpoints/view.pug', vars, (renderErr, html) => {
- if (renderErr) {
- console.error(renderErr);
- return;
- }
- const htmlPath = `./built/web/docs/api/endpoints/${ep.endpoint}.html`;
- mkdirp(path.dirname(htmlPath), (mkdirErr) => {
- if (mkdirErr) {
- console.error(mkdirErr);
+ langs.forEach(lang => {
+ pug.renderFile('./src/web/docs/api/endpoints/view.pug', Object.assign({}, vars, {
+ lang
+ }), (renderErr, html) => {
+ if (renderErr) {
+ console.error(renderErr);
return;
}
- fs.writeFileSync(htmlPath, html, 'utf-8');
+ const htmlPath = `./built/web/docs/${lang}/api/endpoints/${ep.endpoint}.html`;
+ mkdirp(path.dirname(htmlPath), (mkdirErr) => {
+ if (mkdirErr) {
+ console.error(mkdirErr);
+ return;
+ }
+ fs.writeFileSync(htmlPath, html, 'utf-8');
+ });
});
});
});
@@ -135,20 +146,25 @@ gulp.task('doc:api:entities', () => {
desc: entity.desc,
props: sortParams(entity.props.map(p => parseParam(p))),
propDefs: extractDefs(entity.props),
- kebab
+ kebab,
+ common: commonVars
};
- pug.renderFile('./src/web/docs/api/entities/view.pug', vars, (renderErr, html) => {
- if (renderErr) {
- console.error(renderErr);
- return;
- }
- const htmlPath = `./built/web/docs/api/entities/${kebab(entity.name)}.html`;
- mkdirp(path.dirname(htmlPath), (mkdirErr) => {
- if (mkdirErr) {
- console.error(mkdirErr);
+ langs.forEach(lang => {
+ pug.renderFile('./src/web/docs/api/entities/view.pug', Object.assign({}, vars, {
+ lang
+ }), (renderErr, html) => {
+ if (renderErr) {
+ console.error(renderErr);
return;
}
- fs.writeFileSync(htmlPath, html, 'utf-8');
+ const htmlPath = `./built/web/docs/${lang}/api/entities/${kebab(entity.name)}.html`;
+ mkdirp(path.dirname(htmlPath), (mkdirErr) => {
+ if (mkdirErr) {
+ console.error(mkdirErr);
+ return;
+ }
+ fs.writeFileSync(htmlPath, html, 'utf-8');
+ });
});
});
});
diff --git a/src/web/docs/api/mixins.pug b/src/web/docs/api/mixins.pug
index b302c78263..3ddd7cb48a 100644
--- a/src/web/docs/api/mixins.pug
+++ b/src/web/docs/api/mixins.pug
@@ -14,13 +14,13 @@ mixin propTable(props)
if prop.kind == 'id'
if prop.entity
| (
- a(href=`/docs/api/entities/${kebab(prop.entity)}`)= prop.entity
+ a(href=`/docs/${lang}/api/entities/${kebab(prop.entity)}`)= prop.entity
| ID)
else
| (ID)
else if prop.kind == 'entity'
| (
- a(href=`/docs/api/entities/${kebab(prop.entity)}`)= prop.entity
+ a(href=`/docs/${lang}/api/entities/${kebab(prop.entity)}`)= prop.entity
| )
else if prop.kind == 'object'
if prop.def
@@ -30,4 +30,4 @@ mixin propTable(props)
else if prop.kind == 'date'
| (Date)
td.optional= prop.optional.toString()
- td.desc: +i18n(prop.desc)
+ td.desc!= prop.desc[lang] || prop.desc['ja']