-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
234 additions
and
361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| const pkg = require('../../package.json'); | ||
|
|
||
| module.exports = { | ||
| openapi: '3.0.1', | ||
| info: { | ||
| title: 'GROWI REST API v1', | ||
| version: pkg.version, | ||
| }, | ||
| servers: [ | ||
| { | ||
| url: 'https://demo.growi.org/_api', | ||
| }, | ||
| ], | ||
| security: [ | ||
| { | ||
| api_key: [], | ||
| }, | ||
| ], | ||
| components: { | ||
| securitySchemes: { | ||
| api_key: { | ||
| type: 'apiKey', | ||
| name: 'access_token', | ||
| in: 'query', | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| const pkg = require('../../package.json'); | ||
|
|
||
| module.exports = { | ||
| openapi: '3.0.1', | ||
| info: { | ||
| title: 'GROWI REST API v3', | ||
| version: pkg.version, | ||
| }, | ||
| servers: [ | ||
| { | ||
| url: 'https://demo.growi.org/_api/v3', | ||
| }, | ||
| ], | ||
| security: [ | ||
| { | ||
| api_key: [], | ||
| }, | ||
| ], | ||
| components: { | ||
| securitySchemes: { | ||
| api_key: { | ||
| type: 'apiKey', | ||
| name: 'access_token', | ||
| in: 'query', | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # USAGE: | ||
| # cd apps/app && sh bin/swagger-jsdoc/generate-spec-apiv1.sh | ||
| # APP_PATH=/path/to/apps/app sh bin/swagger-jsdoc/generate-spec-apiv1.sh | ||
| # APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/swagger-jsdoc/generate-spec-apiv1.sh | ||
|
|
||
| APP_PATH=${APP_PATH:-"."} | ||
|
|
||
| OUT=${OUT:-"${APP_PATH}/tmp/openapi-spec-apiv1.json"} | ||
|
|
||
| swagger-jsdoc \ | ||
| -o "${OUT}" \ | ||
| -d "${APP_PATH}/bin/swagger-jsdoc/definition-apiv1.js" \ | ||
| "${APP_PATH}/src/server/routes/*/*.{js,ts}" \ | ||
| "${APP_PATH}/src/server/routes/attachment/**/*.{js,ts}" \ | ||
| "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # USAGE: | ||
| # cd apps/app && sh bin/swagger-jsdoc/generate-spec-apiv3.sh | ||
| # APP_PATH=/path/to/apps/app sh bin/swagger-jsdoc/generate-spec-apiv3.sh | ||
| # APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/swagger-jsdoc/generate-spec-apiv3.sh | ||
|
|
||
| APP_PATH=${APP_PATH:-"."} | ||
|
|
||
| OUT=${OUT:-"${APP_PATH}/tmp/openapi-spec-apiv3.json"} | ||
|
|
||
| swagger-jsdoc \ | ||
| -o "${OUT}" \ | ||
| -d "${APP_PATH}/bin/swagger-jsdoc/definition-apiv3.js" \ | ||
| "${APP_PATH}/src/server/routes/apiv3/**/*.{js,ts}" \ | ||
| "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /** | ||
| * @swagger | ||
| * | ||
| * components: | ||
| * schemas: | ||
| * Page: | ||
| * description: Page | ||
| * type: object | ||
| * properties: | ||
| * _id: | ||
| * type: string | ||
| * description: page ID | ||
| * example: 5e07345972560e001761fa63 | ||
| * __v: | ||
| * type: number | ||
| * description: DB record version | ||
| * example: 0 | ||
| * commentCount: | ||
| * type: number | ||
| * description: count of comments | ||
| * example: 3 | ||
| * createdAt: | ||
| * type: string | ||
| * description: date created at | ||
| * example: 2010-01-01T00:00:00.000Z | ||
| * creator: | ||
| * $ref: '#/components/schemas/User' | ||
| * extended: | ||
| * type: object | ||
| * description: extend data | ||
| * example: {} | ||
| * grant: | ||
| * type: number | ||
| * description: grant | ||
| * example: 1 | ||
| * grantedUsers: | ||
| * type: array | ||
| * description: granted users | ||
| * items: | ||
| * type: string | ||
| * description: user ID | ||
| * example: ["5ae5fccfc5577b0004dbd8ab"] | ||
| * lastUpdateUser: | ||
| * $ref: '#/components/schemas/User' | ||
| * liker: | ||
| * type: array | ||
| * description: granted users | ||
| * items: | ||
| * type: string | ||
| * description: user ID | ||
| * example: [] | ||
| * path: | ||
| * type: string | ||
| * description: page path | ||
| * example: / | ||
| * revision: | ||
| * type: string | ||
| * description: page revision | ||
| * seenUsers: | ||
| * type: array | ||
| * description: granted users | ||
| * items: | ||
| * type: string | ||
| * description: user ID | ||
| * example: ["5ae5fccfc5577b0004dbd8ab"] | ||
| * status: | ||
| * type: string | ||
| * description: status | ||
| * enum: | ||
| * - 'wip' | ||
| * - 'published' | ||
| * - 'deleted' | ||
| * - 'deprecated' | ||
| * example: published | ||
| * updatedAt: | ||
| * type: string | ||
| * description: date updated at | ||
| * example: 2010-01-01T00:00:00.000Z | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /** | ||
| * @swagger | ||
| * | ||
| * components: | ||
| * schemas: | ||
| * Revision: | ||
| * description: Revision | ||
| * type: object | ||
| * properties: | ||
| * _id: | ||
| * type: string | ||
| * description: revision ID | ||
| * example: 5e0734e472560e001761fa68 | ||
| * __v: | ||
| * type: number | ||
| * description: DB record version | ||
| * example: 0 | ||
| * author: | ||
| * $ref: '#/components/schemas/User/properties/_id' | ||
| * body: | ||
| * type: string | ||
| * description: content body | ||
| * example: | | ||
| * # test | ||
| * | ||
| * test | ||
| * format: | ||
| * type: string | ||
| * description: format | ||
| * example: markdown | ||
| * path: | ||
| * type: string | ||
| * description: path | ||
| * example: /user/alice/test | ||
| * createdAt: | ||
| * type: string | ||
| * description: date created at | ||
| * example: 2010-01-01T00:00:00.000Z | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.