Просмотр исходного кода

Merge pull request #9587 from goofmint/fix/doc-v3-update-page

support(jsdoc): add swagger document to page/index.ts for update page
Yuki Takei 1 год назад
Родитель
Сommit
cf62b388b1
1 измененных файлов с 22 добавлено и 2 удалено
  1. 22 2
      apps/app/src/server/routes/apiv3/page/index.ts

+ 22 - 2
apps/app/src/server/routes/apiv3/page/index.ts

@@ -339,15 +339,35 @@ module.exports = (crowi) => {
    *                properties:
    *                  body:
    *                    $ref: '#/components/schemas/Revision/properties/body'
-   *                  page_id:
+   *                  pageId:
    *                    $ref: '#/components/schemas/Page/properties/_id'
    *                  revisionId:
    *                    $ref: '#/components/schemas/Revision/properties/_id'
    *                  grant:
    *                    $ref: '#/components/schemas/Page/properties/grant'
+   *                  userRelatedGrantUserGroupIds:
+   *                    type: array
+   *                    items:
+   *                      type: string
+   *                      description: UserGroup ID
+   *                  overwriteScopesOfDescendants:
+   *                    type: boolean
+   *                    description: Determine whether the scopes of descendants should be overwritten
+   *                  isSlackEnabled:
+   *                    type: boolean
+   *                    description: Determine whether the page is enabled to be posted to Slack
+   *                  slackChannels:
+   *                    type: string
+   *                    description: Slack channel IDs
+   *                  origin:
+   *                    type: string
+   *                    description: Origin is "view" or "editor"
+   *                  wip:
+   *                    type: boolean
+   *                    description: Determine whether the page is WIP
    *                required:
    *                  - body
-   *                  - page_id
+   *                  - pageId
    *                  - revisionId
    *        responses:
    *          200: