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

Trying to fix swagger comments

arvid-e 9 месяцев назад
Родитель
Сommit
22a5a5e19a
1 измененных файлов с 32 добавлено и 31 удалено
  1. 32 31
      apps/app/src/server/routes/apiv3/content-disposition-settings.js

+ 32 - 31
apps/app/src/server/routes/apiv3/content-disposition-settings.js

@@ -29,6 +29,7 @@ const validator = {
   ],
 };
 
+
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);
@@ -39,37 +40,37 @@ module.exports = (crowi) => {
   /**
  * @swagger
  * /markdown-setting:
- * get:
- *  tags: [Markdown Settings]
- *  summary: Get content disposition settings for configurable MIME types
- *  description: Retrieve the current `inline` or `attachment` disposition setting for each configurable MIME type.
- *  security:
- *    - cookieAuth: []
- *    - adminRequired: []
- *  responses:
- *    200:
- *      description: Successfully retrieved content disposition settings.
- *      content:
- *        application/json:
- *          schema:
- *            type: object
- *            properties:
- *              contentDispositionSettings:
- *                type: object
- *                description: An object mapping configurable MIME types to their current inline disposition status.
- *                additionalProperties:
- *                  type: boolean
- *                  description: true if inline, false if attachment.
- *                example:
- *                  image/png: true
- *                  application/pdf: false
- *                  text/plain: true
- *    401:
- *      $ref: '#/components/responses/401'
- *    403:
- *    $ref: '#/components/responses/403'
- *  500:
- *     $ref: '#/components/responses/500'
+ *   get:
+ *     tags: [Markdown Settings]
+ *     summary: Get content disposition settings for configurable MIME types
+ *     description: Retrieve the current `inline` or `attachment` disposition setting for each configurable MIME type.
+ *     security:
+ *       - cookieAuth: []
+ *       - adminRequired: []
+ *     responses:
+ *       200:
+ *         description: Successfully retrieved content disposition settings.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 contentDispositionSettings:
+ *                   type: object
+ *                   description: An object mapping configurable MIME types to their current inline disposition status.
+ *                   additionalProperties:
+ *                     type: boolean
+ *                     description: true if inline, false if attachment.
+ *                   example:
+ *                     image/png: true
+ *                     application/pdf: false
+ *                     text/plain: true
+ *       401:
+ *         $ref: '#/components/responses/401'
+ *       403:
+ *         $ref: '#/components/responses/403'
+ *       500:
+ *         $ref: '#/components/responses/500'
  *
   */
   router.get('/', loginRequiredStrictly, adminRequired, async(req, res) => {