Ryu Sato 6 лет назад
Родитель
Сommit
78d6a69a5e

+ 1 - 1
src/server/models/openapi/paginate-result.js

@@ -65,7 +65,7 @@
  *                example: 35
  *                example: 35
  *              limit:
  *              limit:
  *                type: integer
  *                type: integer
- *                description:
+ *                description: Limit that was used
  *                example: 10
  *                example: 10
  *              offset:
  *              offset:
  *                type: integer
  *                type: integer

+ 6 - 4
src/server/models/openapi/v1-response.js

@@ -4,10 +4,12 @@
  *  components:
  *  components:
  *    schemas:
  *    schemas:
  *      V1Response:
  *      V1Response:
- *        ok:
- *          type: boolean
- *          description: API is succeeded
- *          example: true
+ *        type: object
+ *        properties:
+ *          ok:
+ *            type: boolean
+ *            description: API is succeeded
+ *            example: true
  *    responses:
  *    responses:
  *      403:
  *      403:
  *        description: 'Forbidden'
  *        description: 'Forbidden'

+ 3 - 3
src/server/routes/attachment.js

@@ -265,7 +265,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    attachments:
    *                    attachments:
    *                      type: array
    *                      type: array
    *                      items:
    *                      items:
@@ -360,7 +360,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *                    attachment:
    *                    attachment:
@@ -501,7 +501,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *          403:
    *          403:
    *            $ref: '#/components/responses/403'
    *            $ref: '#/components/responses/403'
    *          500:
    *          500:

+ 4 - 4
src/server/routes/bookmark.js

@@ -61,7 +61,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    bookmark:
    *                    bookmark:
    *                      $ref: '#/components/schemas/Bookmark'
    *                      $ref: '#/components/schemas/Bookmark'
    *          403:
    *          403:
@@ -118,7 +118,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    meta:
    *                    meta:
    *                      $ref: '#/components/schemas/V1PaginateResult/properties/meta'
    *                      $ref: '#/components/schemas/V1PaginateResult/properties/meta'
    *                    data:
    *                    data:
@@ -165,7 +165,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    bookmark:
    *                    bookmark:
    *                      $ref: '#/components/schemas/Bookmark'
    *                      $ref: '#/components/schemas/Bookmark'
    *          403:
    *          403:
@@ -222,7 +222,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *          403:
    *          403:
    *            $ref: '#/components/responses/403'
    *            $ref: '#/components/responses/403'
    *          500:
    *          500:

+ 4 - 4
src/server/routes/comment.js

@@ -83,7 +83,7 @@
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    comments:
    *                    comments:
    *                      type: array
    *                      type: array
    *                      items:
    *                      items:
@@ -185,7 +185,7 @@
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    comment:
    *                    comment:
    *                      $ref: '#/components/schemas/Comment'
    *                      $ref: '#/components/schemas/Comment'
    *          403:
    *          403:
@@ -316,7 +316,7 @@
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    comment:
    *                    comment:
    *                      $ref: '#/components/schemas/Comment'
    *                      $ref: '#/components/schemas/Comment'
    *          403:
    *          403:
@@ -395,7 +395,7 @@
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    comment:
    *                    comment:
    *                      $ref: '#/components/schemas/Comment'
    *                      $ref: '#/components/schemas/Comment'
    *          403:
    *          403:

+ 12 - 12
src/server/routes/page.js

@@ -669,7 +669,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    pages:
    *                    pages:
    *                      type: array
    *                      type: array
    *                      items:
    *                      items:
@@ -759,7 +759,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -869,7 +869,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -993,7 +993,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1112,7 +1112,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    seenUser:
    *                    seenUser:
    *                      $ref: '#/components/schemas/Page/properties/seenUsers'
    *                      $ref: '#/components/schemas/Page/properties/seenUsers'
    *          403:
    *          403:
@@ -1180,7 +1180,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1255,7 +1255,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1318,7 +1318,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    updatePost:
    *                    updatePost:
    *                      $ref: '#/components/schemas/UpdatePost'
    *                      $ref: '#/components/schemas/UpdatePost'
    *          403:
    *          403:
@@ -1384,7 +1384,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1485,7 +1485,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1568,7 +1568,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:
@@ -1710,7 +1710,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    page:
    *                    page:
    *                      $ref: '#/components/schemas/Page'
    *                      $ref: '#/components/schemas/Page'
    *          403:
    *          403:

+ 3 - 3
src/server/routes/revision.js

@@ -81,7 +81,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    revision:
    *                    revision:
    *                      $ref: '#/components/schemas/Revision'
    *                      $ref: '#/components/schemas/Revision'
    *          403:
    *          403:
@@ -143,7 +143,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    revisions:
    *                    revisions:
    *                      type: array
    *                      type: array
    *                      items:
    *                      items:
@@ -208,7 +208,7 @@ module.exports = function(crowi, app) {
    *                schema:
    *                schema:
    *                  properties:
    *                  properties:
    *                    ok:
    *                    ok:
-   *                      $ref: '#/components/schemas/V1Response/ok'
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
    *                    revisions:
    *                    revisions:
    *                      type: array
    *                      type: array
    *                      items:
    *                      items: