Explorar el Código

modify v3 reference

Ryu Sato hace 6 años
padre
commit
c9f689b13e
Se han modificado 2 ficheros con 7 adiciones y 5 borrados
  1. 3 3
      package.json
  2. 4 2
      src/server/routes/apiv3/admin-home.js

+ 3 - 3
package.json

@@ -20,9 +20,9 @@
     "url": "https://github.com/weseek/growi/issues"
   },
   "scripts": {
-    "build:api:jsdoc": "swagger-jsdoc -o tmp/swagger.json -d config/swagger-definition.js \"src/server/**/*.js\"",
-    "build:apiv3:jsdoc": "cross-env API_VERSION=3 npm run build:api:jsdoc",
-    "build:apiv1:jsdoc": "cross-env API_VERSION=1 npm run build:api:jsdoc",
+    "build:api:jsdoc": "swagger-jsdoc -o tmp/swagger.json",
+    "build:apiv3:jsdoc": "npm run build:api:jsdoc -- -d config/swagger-definition.js \"src/server/routes/apiv3/**/*.js\" \"src/server/models/**/*.js\"",
+    "build:apiv1:jsdoc": "npm run build:api:jsdoc -- -d config/swagger-definition-v1.js \"src/server/*/*.js\" \"src/server/models/**/*.js\"",
     "build:dev:app:watch": "npm run build:dev:app -- --watch",
     "build:dev:app": "env-cmd -f config/env.dev.js webpack --config config/webpack.dev.js --progress",
     "build:dev:watch": "npm run build:dev:app:watch",

+ 4 - 2
src/server/routes/apiv3/admin-home.js

@@ -46,9 +46,11 @@ module.exports = (crowi) => {
   /**
    * @swagger
    *
-   *    /admin-home/:
+   *    /_api/v3//admin-home/:
    *      get:
-   *        tags: [adminHome]
+   *        tags: [adminHome, apiv3]
+   *        operationId: getAdminHome
+   *        summary: /_api/v3//admin-home/
    *        description: Get adminHome parameters
    *        responses:
    *          200: