Skip to content

Commit

Permalink
feat: swagger doc
Browse files Browse the repository at this point in the history
  • Loading branch information
de-novo committed May 10, 2024
1 parent df30746 commit 1ea8d1e
Show file tree
Hide file tree
Showing 4 changed files with 198 additions and 155 deletions.
287 changes: 133 additions & 154 deletions docs/ERD.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# uncar

> Generated by [`prisma-markdown`](https://github.com/samchon/prisma-markdown)
- [default](#default)

## default

```mermaid
erDiagram
"user" {
Expand Down Expand Up @@ -209,227 +207,208 @@ erDiagram
### `user`

**Properties**

- `id`:
- `account`:
- `password`:
- `nickname`:
- `phone`:
- `country_code`:
- `created_at`:
- `updated_at`:
- `deleted_at`:
- `id`:
- `account`:
- `password`:
- `nickname`:
- `phone`:
- `country_code`:
- `created_at`:
- `updated_at`:
- `deleted_at`:

### `user_snapshot`

**Properties**

- `id`:
- `userId`:
- `account`:
- `password`:
- `nickname`:
- `phone`:
- `contry_code`:
- `created_at`:
- `id`:
- `userId`:
- `account`:
- `password`:
- `nickname`:
- `phone`:
- `contry_code`:
- `created_at`:

### `user_last_snapshot`

**Properties**

- `user_id`: 사용자 ID
- `snapshot_id`: 스냅샷 ID
- `created_at`:
- `updated_at`:
- `user_id`: 사용자 ID
- `snapshot_id`: 스냅샷 ID
- `created_at`:
- `updated_at`:

### `user_profile_image`

**Properties**

- `user_id`: 사용자 ID
- `image_id`: 이미지 ID
- `created_at`:
- `updated_at`:
- `user_id`: 사용자 ID
- `image_id`: 이미지 ID
- `created_at`:
- `updated_at`:

### `terms_agreements`

**Properties**

- `id`: 약관동의 ID
- `user_id`: 사용자 ID
- `type`:
- `agree`:
- `created_at`:
- `updated_at`:
- `id`: 약관동의 ID
- `user_id`: 사용자 ID
- `type`:
- `agree`:
- `created_at`:
- `updated_at`:

### `oauth`

**Properties**

- `id`:
- `user_id`:
- `provider`:
- `provider_id`:
- `created_at`:
- `updated_at`:
- `id`:
- `user_id`:
- `provider`:
- `provider_id`:
- `created_at`:
- `updated_at`:

### `certification`

**Properties**

- `id`:
- `certification_code_id`:
- `user_id`:
- `targetType`:
- `type`:
- `created_at`:
- `updated_at`:
- `id`:
- `certification_code_id`:
- `user_id`:
- `targetType`:
- `type`:
- `created_at`:
- `updated_at`:

### `certification_code`

**Properties**

- `id`:
- `targetType`:
- `type`:
- `status`:
- `code`:
- `target`:
- `created_at`:
- `updated_at`:
- `expired_at`:
- `id`:
- `targetType`:
- `type`:
- `status`:
- `code`:
- `target`:
- `created_at`:
- `updated_at`:
- `expired_at`:

### `car`

**Properties**

- `id`:
- `owner_id`:
- `type`:
- `number`:
- `status`:
- `created_at`:
- `updated_at`:
- `id`:
- `owner_id`:
- `type`:
- `number`:
- `status`:
- `created_at`:
- `updated_at`:

### `car_image`

**Properties**

- `id`:
- `car_id`:
- `image_id`:
- `created_at`:
- `updated_at`:
- `id`:
- `car_id`:
- `image_id`:
- `created_at`:
- `updated_at`:

### `car_snapshot`

**Properties**

- `id`:
- `car_id`:
- `owner_id`:
- `type`:
- `number`:
- `created_at`:
- `updated_at`:
- `status`:
- `id`:
- `car_id`:
- `owner_id`:
- `type`:
- `number`:
- `created_at`:
- `updated_at`:
- `status`:

### `Rental`

**Properties**

- `id`:
- `car_id`:
- `user_id`:
- `start_date`:
- `end_date`:
- `status`:
- `created_at`:
- `updated_at`:
- `id`:
- `car_id`:
- `user_id`:
- `start_date`:
- `end_date`:
- `status`:
- `created_at`:
- `updated_at`:

### `driving`

**Properties**

- `id`:
- `user_id`:
- `car_id`:
- `created_at`:
- `updated_at`:
- `rental_id`:
- `id`:
- `user_id`:
- `car_id`:
- `created_at`:
- `updated_at`:
- `rental_id`:

### `parking`

**Properties**

- `id`:
- `car_id`:
- `drivingId`:
- `location`: 주차 위치 (주소)
- `latitude`:
- `longitude`:
- `status`:
- `start_date`:
- `end_date`:
- `created_at`:
- `updated_at`:
- `id`:
- `car_id`:
- `drivingId`:
- `location`: 주차 위치 (주소)
- `latitude`:
- `longitude`:
- `status`:
- `start_date`:
- `end_date`:
- `created_at`:
- `updated_at`:

### `parking_snapshot`

**Properties**

- `id`:
- `car_id`:
- `drivingId`:
- `location`:
- `latitude`:
- `longitude`:
- `status`:
- `start_date`:
- `end_date`:
- `created_at`:
- `id`:
- `car_id`:
- `drivingId`:
- `location`:
- `latitude`:
- `longitude`:
- `status`:
- `start_date`:
- `end_date`:
- `created_at`:

### `notification`

**Properties**

- `id`:
- `user_id`:
- `type`:
- `title`:
- `content`:
- `read_at`:
- `created_at`:
- `updated_at`:
- `id`:
- `user_id`:
- `type`:
- `title`:
- `content`:
- `read_at`:
- `created_at`:
- `updated_at`:

### `user_reputation`

**Properties**

- `id`:
- `user_id`:
- `writer_id`:
- `score`:
- `created_at`:
- `updated_at`:
- `id`:
- `user_id`:
- `writer_id`:
- `score`:
- `created_at`:
- `updated_at`:

### `user_reputation_reason`

**Properties**

- `id`:
- `user_reputation_id`:
- `type`:
- `score`:
- `created_at`:
- `id`:
- `user_reputation_id`:
- `type`:
- `score`:
- `created_at`:

### `image`

**Properties**

- `id`:
- `user_id`:
- `type`:
- `url`:
- `created_at`:
- `deleted_at`:
- `id`:
- `user_id`:
- `type`:
- `url`:
- `created_at`:
- `deleted_at`:
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,15 @@
"@nestjs/core": "^10.0.0",
"@nestjs/jwt": "^10.2.0",
"@nestjs/platform-express": "^10.0.0",
"@nestjs/swagger": "^7.3.1",
"@prisma/client": "5.13.0",
"prisma": "^5.13.0",
"bcrypt": "^5.1.1",
"cache-manager": "^5.5.1",
"cache-manager-redis-store": "^3.0.1",
"cookie-parser": "^1.4.6",
"joi": "^17.12.3",
"nestjs-twilio": "^4.4.0",
"prisma": "^5.13.0",
"reflect-metadata": "^0.2.0",
"rxjs": "^7.8.1",
"typia": "^5.5.7",
Expand Down
Loading

0 comments on commit 1ea8d1e

Please sign in to comment.