Skip to content

docs(tenancy): mark the jwt resolver as reserved (not yet shipped) #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlc488 merged 1 commit into from
Jun 3, 2026
Merged

docs(tenancy): mark the jwt resolver as reserved (not yet shipped) #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/guides/tenancy.ko.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ devslab:
kit:
tenant:
mode: single # single | multi
resolver: fixed # fixed | header | jwt | subdomain
resolver: fixed # fixed | header | subdomain (jwt: 예약 — 아래 참고)
default-tenant-id: default
```

Expand All @@ -36,8 +36,14 @@ devslab:
| --- | --- | --- |
| `fixed` | 항상 `default-tenant-id` | (싱글 테넌트 기본) |
| `header` | 요청 헤더(기본 `X-Tenant-Id`) | `X-Tenant-Id: acme` |
| `jwt` | 인증된 JWT의 클레임 | 로그인 사용자의 테넌트 |
| `subdomain` | 요청 호스트의 서브도메인 | `acme.app.com` → `acme` |
| `jwt` | _예약 — 아직 미출시_ | (노트 참고) |

!!! warning "`jwt`는 예약됨 (아직 미출시)"
`resolver: jwt`를 선택하면 부팅 시 즉시 실패합니다 — 예정된
`devslab-kit-oauth2-resource-server-starter`를 기다리는 중입니다. 로그인 JWT는 이미 `tenant`
클레임을 싣고 있으니, 그때까지는 **커스텀 `TenantResolver` 빈**으로 읽으세요
(아래 [커스텀 리졸버](#custom-resolver)).

```yaml
devslab:
Expand Down Expand Up @@ -118,7 +124,7 @@ interface InvoiceRepository extends JpaRepository<Invoice, UUID> {

이게 패턴의 전부 — `single`/`multi` 동일합니다.

## 커스텀 리졸버
## 커스텀 리졸버 { #custom-resolver }

내장으로 안 되는 전략(DB 조회, header-or-path, API 키 → 테넌트 매핑)이 필요하면, 자신의
`TenantResolver` 빈을 선언하면 kit 기본이 물러납니다(모든 kit 빈이 `@ConditionalOnMissingBean`):
Expand Down
10 changes: 8 additions & 2 deletions docs/guides/tenancy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ devslab:
kit:
tenant:
mode: single # single | multi
resolver: fixed # fixed | header | jwt | subdomain
resolver: fixed # fixed | header | subdomain (jwt: reserved — see below)
default-tenant-id: default
```

Expand All @@ -37,8 +37,14 @@ In `multi` mode the **resolver** decides whose request this is:
| --- | --- | --- |
| `fixed` | always `default-tenant-id` | (the single-tenant default) |
| `header` | a request header (default `X-Tenant-Id`) | `X-Tenant-Id: acme` |
| `jwt` | a claim on the authenticated JWT | the signed-in user's tenant |
| `subdomain` | the request host's subdomain | `acme.app.com` → `acme` |
| `jwt` | _reserved — not yet shipped_ | (see note) |

!!! warning "`jwt` is reserved (not yet shipped)"
Selecting `resolver: jwt` fails fast at startup — it awaits the planned
`devslab-kit-oauth2-resource-server-starter`. The login JWT already carries a
`tenant` claim, so until then resolve it from a **custom `TenantResolver` bean**
([Custom resolver](#custom-resolver) below).

```yaml
devslab:
Expand Down
Loading