docs: Fix DTO in API documentation (#86)

* fix: dto names

* docs: add descriptions

* docs: add required properties

* docs: add uuid format in user model

* refactor:

* refactor: doc

* fix:  doc

* fix: typo

Author: vbetsch

src/app/api/vaults/route.ts

@@ -23,7 +23,7 @@ import type { CreateVaultPayloadDto } from '@shared/dto/input/payloads/create-va
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/GetMyVaultsBodyDto'
+ *               $ref: '#/components/schemas/GetMyVaultsDataDto'
  *       401:
  *         description: Unauthorized
  *         content:
@@ -71,7 +71,7 @@ export async function GET(
  *         content:
  *           application/json:
  *             schema:
- *               $ref: '#/components/schemas/CreateVaultBodyDto'
+ *               $ref: '#/components/schemas/CreateVaultDataDto'
  *       409:
  *         description: Vault already exists
  *         content:

src/modules/shared/dto/input/payloads/create-vault.payload.dto.ts

@@ -10,10 +10,11 @@
  *       properties:
  *         label:
  *           type: string
- *           description: Name of the vault
+ *           description: name of the vault
+ *           example: Google, Amazon, Netflix, Disney+ or the other
  *         secret:
  *           type: string
- *           description: Password, token, or other sensitive string to store
+ *           description: password, token, code or other sensitive string to store
  *           format: password
  */
 export type CreateVaultPayloadDto = {

src/modules/shared/dto/input/payloads/register.payload.dto.ts

@@ -10,12 +10,15 @@
  *       properties:
  *         email:
  *           type: string
+ *           description: email of new user
  *           format: email
  *         password:
  *           type: string
+ *           description: plain password of new user
  *           format: password
  *         name:
  *           type: string
+ *           description: first name and last name of the new user
  */
 export type RegisterPayloadDto = {
   email: string;

src/modules/shared/dto/input/payloads/sign-in.payload.dto.ts

@@ -10,9 +10,11 @@
  *       properties:
  *         email:
  *           type: string
+ *           description: email of user to sign
  *           format: email
  *         password:
  *           type: string
+ *           description: plain password of user to sign
  *           format: password
  */
 export type SignInPayloadDto = {

src/modules/shared/dto/models/provider.model.dto.ts

@@ -4,6 +4,12 @@
  *   schemas:
  *     ProviderModelDto:
  *       type: object
+ *       required:
+ *        - id
+ *        - name
+ *        - type
+ *        - signinUrl
+ *        - callbackUrl
  *       properties:
  *         id:
  *           type: string

src/modules/shared/dto/models/user.model.dto.ts

@@ -10,11 +10,15 @@
  *       properties:
  *         id:
  *           type: string
+ *           description: UUID
+ *           format: uuid
  *         email:
  *           type: string
+ *           description: user's email
  *           format: email
  *         name:
  *           type: string
+ *           description: first name and last name
  */
 export type UserModelDto = {
   id: string;

src/modules/shared/dto/models/vault.model.dto.ts

@@ -4,14 +4,22 @@
  *   schemas:
  *     VaultModelDto:
  *       type: object
+ *       required:
+ *        - id
+ *        - label
+ *        - secret
  *       properties:
  *         id:
  *           type: string
+ *           description: UUID
  *           format: uuid
  *         label:
  *           type: string
+ *           description: name of the vault
+ *           example: Google, Amazon, Netflix, Disney+ or the other
  *         secret:
  *           type: string
+ *           description: password, token, code or other sensitive string to store
  *           format: password
  */
 export type VaultModelDto = {

src/modules/shared/dto/output/body/session.body.dto.ts

@@ -15,9 +15,11 @@
  *           properties:
  *             email:
  *               type: string
+ *               description: current user's email
  *               format: email
  *             name:
  *               type: string
+ *               description: current user's name
  *               nullable: true
  *         expires:
  *           type: string

src/modules/shared/dto/output/data/create-vault.data.dto.ts

@@ -4,11 +4,15 @@ import type { VaultModelDto } from '@shared/dto/models/vault.model.dto';
  * @swagger
  * components:
  *   schemas:
- *     CreateVaultBodyDto:
+ *     CreateVaultDataDto:
  *       type: object
+ *       required:
+ *        - data
  *       properties:
  *         data:
  *           type: object
+ *           required:
+ *            - vaultCreated
  *           properties:
  *             vaultCreated:
  *               $ref: '#/components/schemas/VaultModelDto'

src/modules/shared/dto/output/data/get-my-vaults.data.dto.ts

@@ -4,11 +4,15 @@ import type { VaultModelDto } from '@shared/dto/models/vault.model.dto';
  * @swagger
  * components:
  *   schemas:
- *     GetMyVaultsBodyDto:
+ *     GetMyVaultsDataDto:
  *       type: object
+ *       required:
+ *        - data
  *       properties:
  *         data:
  *           type: object
+ *           required:
+ *            - myVaults
  *           properties:
  *             myVaults:
  *               type: array