day58_openapi.yaml

openapi: 3.0.3
info:
  title: Sonpo App API (Day58 Minimal)
  version: "0.1.0"
  description: >
    Day58で作成した「最小API案（Policy/Accident）」のOpenAPI仕様。
    失敗時レスポンスは共通で ApiError(code/message/traceId) を返す。
servers:
  - url: http://localhost:8080
    description: Local development server

tags:
  - name: Policy
    description: 契約（Policy）
  - name: Accident
    description: 事故（Accident）

paths:
  /api/policies:
    get:
      tags: [Policy]
      summary: Policy一覧取得
      description: 契約の一覧を取得する（任意でstatus/qで絞り込み）
      parameters:
        - in: query
          name: status
          schema:
            type: string
          description: 例) ACTIVE
        - in: query
          name: q
          schema:
            type: string
          description: 契約番号/契約者名の部分一致想定
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Policy"
              examples:
                sample:
                  value:
                    - id: 123
                      policyNumber: P-0001
                      customerName: 山田 太郎
                      startDate: "2026-01-01"
                      endDate: "2026-12-31"
                      status: ACTIVE
        "400":
          $ref: "#/components/responses/ValidationError"
        "500":
          $ref: "#/components/responses/SystemError"

    post:
      tags: [Policy]
      summary: Policy新規作成
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PolicyCreateRequest"
            examples:
              sample:
                value:
                  policyNumber: P-0002
                  customerName: 佐藤 花子
                  startDate: "2026-02-01"
                  endDate: "2027-01-31"
                  status: ACTIVE
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Policy"
              examples:
                sample:
                  value:
                    id: 124
                    policyNumber: P-0002
                    customerName: 佐藤 花子
                    startDate: "2026-02-01"
                    endDate: "2027-01-31"
                    status: ACTIVE
        "400":
          $ref: "#/components/responses/ValidationError"
        "409":
          $ref: "#/components/responses/ConflictError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/policies/{id}:
    get:
      tags: [Policy]
      summary: Policy詳細取得
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Policy"
              examples:
                sample:
                  value:
                    id: 123
                    policyNumber: P-0001
                    customerName: 山田 太郎
                    startDate: "2026-01-01"
                    endDate: "2026-12-31"
                    status: ACTIVE
        "404":
          $ref: "#/components/responses/NotFoundError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/policies/{id}/renew:
    post:
      tags: [Policy]
      summary: Policy更新操作（renew）
      description: 満期更新の例。newEndDateで満期日を更新する想定。
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PolicyRenewRequest"
            examples:
              sample:
                value:
                  newEndDate: "2027-12-31"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PolicyRenewResponse"
              examples:
                sample:
                  value:
                    id: 123
                    status: ACTIVE
                    endDate: "2027-12-31"
        "400":
          $ref: "#/components/responses/ValidationError"
        "404":
          $ref: "#/components/responses/NotFoundError"
        "409":
          $ref: "#/components/responses/ConflictError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/accidents:
    get:
      tags: [Accident]
      summary: Accident一覧取得
      parameters:
        - in: query
          name: policyId
          schema:
            type: integer
            format: int64
          description: 契約IDで絞り込み
        - in: query
          name: status
          schema:
            type: string
          description: 例) OPEN / IN_PROGRESS / RESOLVED
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Accident"
              examples:
                sample:
                  value:
                    - id: 501
                      policyId: 123
                      occurredAt: "2026-01-10T10:30:00"
                      status: OPEN
        "400":
          $ref: "#/components/responses/ValidationError"
        "500":
          $ref: "#/components/responses/SystemError"

    post:
      tags: [Accident]
      summary: Accident新規作成
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AccidentCreateRequest"
            examples:
              sample:
                value:
                  policyId: 123
                  occurredAt: "2026-01-10T10:30:00"
                  place: 熊本市
                  description: 追突事故
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Accident"
              examples:
                sample:
                  value:
                    id: 502
                    policyId: 123
                    occurredAt: "2026-01-10T10:30:00"
                    place: 熊本市
                    description: 追突事故
                    status: OPEN
        "400":
          $ref: "#/components/responses/ValidationError"
        "404":
          $ref: "#/components/responses/NotFoundError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/accidents/{id}:
    get:
      tags: [Accident]
      summary: Accident詳細取得
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Accident"
              examples:
                sample:
                  value:
                    id: 501
                    policyId: 123
                    occurredAt: "2026-01-10T10:30:00"
                    place: 熊本市
                    description: 追突事故
                    status: OPEN
        "404":
          $ref: "#/components/responses/NotFoundError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/accidents/{id}/start:
    post:
      tags: [Accident]
      summary: 状態遷移（OPEN→IN_PROGRESS）
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccidentStatusResponse"
              examples:
                sample:
                  value:
                    id: 501
                    status: IN_PROGRESS
        "404":
          $ref: "#/components/responses/NotFoundError"
        "409":
          $ref: "#/components/responses/ConflictError"
        "500":
          $ref: "#/components/responses/SystemError"

  /api/accidents/{id}/resolve:
    post:
      tags: [Accident]
      summary: 状態遷移（IN_PROGRESS→RESOLVED）
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccidentStatusResponse"
              examples:
                sample:
                  value:
                    id: 501
                    status: RESOLVED
        "404":
          $ref: "#/components/responses/NotFoundError"
        "409":
          $ref: "#/components/responses/ConflictError"
        "500":
          $ref: "#/components/responses/SystemError"

components:
  schemas:
    Policy:
      type: object
      required: [id, policyNumber, customerName, startDate, endDate, status]
      properties:
        id:
          type: integer
          format: int64
        policyNumber:
          type: string
        customerName:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        status:
          type: string

    PolicyCreateRequest:
      type: object
      required: [policyNumber, customerName, startDate, endDate, status]
      properties:
        policyNumber:
          type: string
        customerName:
          type: string
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        status:
          type: string

    PolicyRenewRequest:
      type: object
      required: [newEndDate]
      properties:
        newEndDate:
          type: string
          format: date

    PolicyRenewResponse:
      type: object
      required: [id, status, endDate]
      properties:
        id:
          type: integer
          format: int64
        status:
          type: string
        endDate:
          type: string
          format: date

    Accident:
      type: object
      required: [id, policyId, occurredAt, status]
      properties:
        id:
          type: integer
          format: int64
        policyId:
          type: integer
          format: int64
        occurredAt:
          type: string
          format: date-time
        place:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        status:
          type: string

    AccidentCreateRequest:
      type: object
      required: [policyId, occurredAt]
      properties:
        policyId:
          type: integer
          format: int64
        occurredAt:
          type: string
          format: date-time
        place:
          type: string
        description:
          type: string

    AccidentStatusResponse:
      type: object
      required: [id, status]
      properties:
        id:
          type: integer
          format: int64
        status:
          type: string

    ApiError:
      type: object
      required: [code, message, traceId]
      properties:
        code:
          type: string
        message:
          type: string
        traceId:
          type: string

  responses:
    ValidationError:
      description: Bad Request（入力不正）
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiError"
          examples:
            sample:
              value:
                code: VALIDATION_ERROR
                message: 入力値が不正です
                traceId: a1b2c3d4

    NotFoundError:
      description: Not Found（対象なし）
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiError"
          examples:
            sample:
              value:
                code: NOT_FOUND
                message: 対象が見つかりません
                traceId: a1b2c3d4

    ConflictError:
      description: Conflict（状態不整合/競合）
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiError"
          examples:
            sample:
              value:
                code: CONFLICT
                message: 状態が不正のため処理できません
                traceId: a1b2c3d4

    SystemError:
      description: Internal Server Error（想定外）
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiError"
          examples:
            sample:
              value:
                code: SYSTEM_ERROR
                message: 予期しないエラーが発生しました
                traceId: a1b2c3d4