db.yaml

fdmd: 1.0.0
info:
  title: Firestore Data Modeling
  description: Firestore設計 => コード自動生成のサンプルyaml
  version: '1.0.0'
  termsOfService: https://github.com/hukusuke1007
  contact:
    email: xxxx@xxx.com
  license:
    name: xxx
    url: https://github.com/hukusuke1007
domains:
  - name: Social
    description: ソーシャル機能を管理
    path: /social
  - name: Master
    description: マスター管理
    path: /master
  - name: AppService
    description: アプリシステムの状態
    path: /appService
docs:
  - name: Poster
    description: 投稿者の情報
    path: /social/${socialId}/posters/${posterId}
    codeGenerate: true
    data:
      - field: id
        type: string
        example: DocumentId
      - field: name
        type: string,nullable
        example: ケン
      - field: age
        type: int,nullable
        example: 10
      - field: image
        type: map,nullable
        map:
          reference: ThumbnailImage
      - field: createdAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
      - field: updatedAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
    collections:
      - field: posts
        type: Post
  - name: Post
    description: 投稿情報
    path: /social/${socialId}/posters/${posterId}/posts/${postId}
    codeGenerate: true
    data:
      - field: title
        type: string,nullable
        example: タイトル
      - field: text
        type: string,nullable
        example: テキスト内容
      - field: likeCount
        type: int,nullable
        example: 10
      - field: stars
        type: double,nullable
        example: 4.5
      - field: isBookmark
        type: bool,nullable
        example: true
      - field: createdAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
      - field: updatedAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
    collections:
      - field: likes
        type: Like
  - name: Like
    description: いいね
    path: /social/${socialId}/posters/${posterId}/posts/${postId}/likes/${likeId}
    codeGenerate: true
    dataReference: Poster
  - name: Color
    description: カラー情報
    path: /master/${masterId}/colors/${colorId}
    codeGenerate: true
    data:
      - field: codes
        type: string,array,nullable
        example: ['000000', 'FFFFFF']
  - name: Maintenance
    description: メンテナンス情報
    path: /appService/${appServiceId}/maintenance/${maintenanceId}
    codeGenerate: true
    data:
      - field: status
        type: string
        example: active
      - field: createdAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
      - field: updatedAt
        type: timestamp,nullable
        example: '2021-09-16T13:10:52+09:00'
maps:
  - name: ThumbnailImage
    description: 画像情報
    codeGenerate: true
    data:
      - field: url
        type: string
        example: https://sample/image.jpg
      - field: path
        type: string
        example: /social/${socialId}/users/${userId}/images/${imageId}