Skip to content

Commit 571848a

Browse files
committed
apidoc meta
1 parent 4224e31 commit 571848a

File tree

3 files changed

+30
-1
lines changed

3 files changed

+30
-1
lines changed

apidoc.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "countly-apidoc",
3+
"version": "20.11.2",
4+
"description": "Countly Api Docs",
5+
"title": "Countly Api Docs",
6+
"url": "https://api.count.ly/",
7+
"template": {
8+
"withCompare": true,
9+
"withGenerator": false
10+
}
11+
}

bin/commands/scripts/apidocs.sh

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/bin/bash
2+
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
3+
4+
usage (){
5+
echo "";
6+
echo "countly apidocs usage:";
7+
echo " countly apidocs generate # regenerate documentation";
8+
}
9+
if [ -z "$1" ]
10+
then
11+
usage ;
12+
elif [ "$1" = "generate" ]; then
13+
echo 'yes'
14+
echo "$DIR/../../../../plugins/"
15+
"$DIR/../../../node_modules/.bin/apidoc" -c "$DIR/../../../apidoc.json" -f "api/.*\\.js$" -i "$DIR/../../../plugins/" -o "$DIR/../../../frontend/express/public/apidoc/" -t "$DIR/../../../node_modules/apidoc-template/template/";
16+
fi

package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
"scripts": {
2626
"test": "grunt --verbose"
2727
},
28-
"dependencies": {
28+
"dependencies": {
29+
"apidoc": "^0.27.1",
30+
"apidoc-template": "github:kanwarujjaval/dash-apidoc-template",
2931
"argon2": "0.27.0",
3032
"async": "3.2.0",
3133
"basic-auth": "2.0.1",

0 commit comments

Comments
 (0)