From ea623936bf09480325b908e289409cc9ecdc039b Mon Sep 17 00:00:00 2001 From: Matteo Pagliazzi Date: Thu, 2 Jul 2020 18:19:15 +0200 Subject: [PATCH] apidoc: upgrade and add links to wiki --- apidoc.json | 4 ++ apidoc/header.md | 5 +++ package-lock.json | 105 +++++++++++++++++++++++++--------------------- package.json | 2 +- 4 files changed, 67 insertions(+), 49 deletions(-) create mode 100644 apidoc/header.md diff --git a/apidoc.json b/apidoc.json index 91b4830440..0833e9b4db 100644 --- a/apidoc.json +++ b/apidoc.json @@ -2,6 +2,10 @@ "name": "Habitica V3 API Documentation", "title": "Habitica", "url": "https://habitica.com", + "header": { + "title": "Introduction", + "filename": "apidoc/header.md" + }, "template": { "withCompare": false } diff --git a/apidoc/header.md b/apidoc/header.md new file mode 100644 index 0000000000..5c194617c6 --- /dev/null +++ b/apidoc/header.md @@ -0,0 +1,5 @@ +# Introduction + +This webpage includes the documentation for version 3 of the [Habitica](https://habitica.com) API. + +If you're developing a 3rd party tool that uses the Habitica API you should read the [Guidance for Comrades](https://habitica.fandom.com/wiki/Guidance_for_Comrades) and in particular the section called [Rules for Third-Party Tools](https://habitica.fandom.com/wiki/Guidance_for_Comrades#Rules_for_Third-Party_Tools) which includes suggestions on how to best use the API and the rules to follow when interacting with it. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 335548ce28..01ac3414ee 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1567,45 +1567,64 @@ } }, "apidoc": { - "version": "0.17.7", - "resolved": "https://registry.npmjs.org/apidoc/-/apidoc-0.17.7.tgz", - "integrity": "sha512-9Wf4bRPwCuWOIOxR42dDnsXnFw+rhJg5VrMQK+KmNxJwyIh30UqX6gvjjXSG6YO74MqE87F18bbQXUENK9dPGg==", + "version": "0.23.0", + "resolved": "https://registry.npmjs.org/apidoc/-/apidoc-0.23.0.tgz", + "integrity": "sha512-bn2QNaqyyL5ihRUlBBqwffElJg+hAgxAWPDdjJiLxDJ66Jiw+jf8uucFLYC9XHFqjdM7YTqLluM2PPshrqzObg==", "requires": { - "apidoc-core": "~0.8.2", - "commander": "^2.19.0", - "fs-extra": "^7.0.0", - "lodash": "^4.17.10", - "markdown-it": "^8.3.1", - "winston": "^3.0.0" + "apidoc-core": "^0.11.1", + "commander": "^2.20.0", + "fs-extra": "^8.1.0", + "handlebars": "^4.7.6", + "lodash": "^4.17.15", + "markdown-it": "^10.0.0", + "nodemon": "^2.0.3", + "winston": "^3.2.1" + }, + "dependencies": { + "entities": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", + "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==" + }, + "markdown-it": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz", + "integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==", + "requires": { + "argparse": "^1.0.7", + "entities": "~2.0.0", + "linkify-it": "^2.0.0", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + } + } } }, "apidoc-core": { - "version": "0.8.3", - "resolved": "https://registry.npmjs.org/apidoc-core/-/apidoc-core-0.8.3.tgz", - "integrity": "sha1-2dY1RYKd8lDSzKBJaDqH53U2S5Y=", + "version": "0.11.1", + "resolved": "https://registry.npmjs.org/apidoc-core/-/apidoc-core-0.11.1.tgz", + "integrity": "sha512-pt/ICBdFQCZTgL38Aw1XB3G9AajDU1JA5E3yoDEgg0mqbPTCkOL8AyWdysjvNtQS/kkXgSPazCZaZzZYqrPHog==", "requires": { - "fs-extra": "^3.0.1", - "glob": "^7.1.1", - "iconv-lite": "^0.4.17", - "klaw-sync": "^2.1.0", - "lodash": "~4.17.4", - "semver": "~5.3.0" + "fs-extra": "^8.1.0", + "glob": "^7.1.4", + "iconv-lite": "^0.5.0", + "klaw-sync": "^6.0.0", + "lodash": "~4.17.15", + "semver": "~6.3.0" }, "dependencies": { - "fs-extra": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-3.0.1.tgz", - "integrity": "sha1-N5TzeMWLNC6n27sjCVEJxLO2IpE=", + "iconv-lite": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.5.2.tgz", + "integrity": "sha512-kERHXvpSaB4aU3eANwidg79K8FlrN77m8G9V+0vOR3HYaRifrlwMEpT7ZBJqLSEIHnEgJTHcWK82wwLwwKwtag==", "requires": { - "graceful-fs": "^4.1.2", - "jsonfile": "^3.0.0", - "universalify": "^0.1.0" + "safer-buffer": ">= 2.1.2 < 3" } }, "semver": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.3.0.tgz", - "integrity": "sha1-myzl094C0XxgEq0yaqa00M9U+U8=" + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==" } } }, @@ -5900,23 +5919,13 @@ "optional": true }, "fs-extra": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", - "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", "requires": { - "graceful-fs": "^4.1.2", + "graceful-fs": "^4.2.0", "jsonfile": "^4.0.0", "universalify": "^0.1.0" - }, - "dependencies": { - "jsonfile": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", - "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", - "requires": { - "graceful-fs": "^4.1.6" - } - } } }, "fs-minipass": { @@ -7992,9 +8001,9 @@ } }, "jsonfile": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-3.0.1.tgz", - "integrity": "sha1-pezG9l9T9mLEQVx2daAzHQmS7GY=", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", "requires": { "graceful-fs": "^4.1.6" } @@ -8129,9 +8138,9 @@ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==" }, "klaw-sync": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-2.1.0.tgz", - "integrity": "sha1-PTvNhgDnv971MjHHOf8FOu1WDkQ=", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/klaw-sync/-/klaw-sync-6.0.0.tgz", + "integrity": "sha512-nIeuVSzdCCs6TDPTqI8w1Yre34sSq7AkZ4B3sfOBbI2CgVSB4Du4aLQijFU2+lhAFCwt9+42Hel6lQNIv6AntQ==", "requires": { "graceful-fs": "^4.1.11" } diff --git a/package.json b/package.json index e2f16d7fbf..4a77a5827e 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "accepts": "^1.3.5", "amazon-payments": "^0.2.8", "amplitude": "^3.5.0", - "apidoc": "^0.17.5", + "apidoc": "^0.23.0", "apn": "^2.2.0", "apple-auth": "^1.0.6", "bcrypt": "^5.0.0",