Procházet zdrojové kódy

add swagger to error-apiv3

Yohei-Shiina před 3 roky
rodič
revize
9da0f78850
1 změnil soubory, kde provedl 21 přidání a 0 odebrání
  1. 21 0
      packages/core/src/models/vo/error-apiv3.ts

+ 21 - 0
packages/core/src/models/vo/error-apiv3.ts

@@ -1,3 +1,24 @@
+/**
+ * @swagger
+ *
+ *  components:
+ *    schemas:
+ *      ErrorV3:
+ *        description: Error for APIv3
+ *        type: object
+ *        properties:
+ *          message:
+ *            type: string
+ *            example: 'error message'
+ *          code:
+ *            type: string
+ *            example: 'someapi-error-with-something'
+ *          stack:
+ *            type: object
+ *          args:
+ *            type: object
+ *            example: { name: 'Josh', age: 20 }
+ */
 
 export class ErrorV3 extends Error {