api-document.yaml

openapi: 3.0.2
info:
  title: "Rebuilt API"
  description: |-
    <b>Rebuilt Apiに関する仕様</b><br>
    現在のAPIの仕様について書いています。
  version: "1.0.0"

servers:
  - url: http://localhost:8000/api/v1
  - url: http://example.com/api/v1

tags:
  - name: open
    description: 一般公開API
  - name: auth
    description: 認証関連API
  - name: user
    description: 会員用API

paths:
  /pages/{user}:
    get:
      tags:
        - open
      summary: "ポートフォリオ情報取得API"
      description: |-
        ポートフォリオ情報を取得します。
        urlの{user}はユーザー名を指定します。
      parameters:
        - in: "path"
          name: "user"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagesUserResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pages/{user}/storages:
    get:
      tags:
        - open
      summary: "作品一覧取得API"
      description: |-
        作品一覧を取得します
        一覧はページネーションで、updated_at(更新日時)でソートします。
        urlの{user}はユーザー名を指定します。
      parameters:
        - in: "path"
          name: "user"
          schema:
            type: string
          required: true
        - in: "query"
          name: "per_page"
          schema:
            type: integer
        - in: "query"
          name: "page"
          schema:
            type: integer
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagesUserStoragesResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pages/{user}/storages/{storageID}:
    get:
      tags:
        - open
      summary: "作品情報取得API"
      description: |-
        作品情報を取得します
      parameters:
        - in: "path"
          name: "user"
          schema:
            type: string
          required: true
        - in: "path"
          name: "storageID"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageUsersStorageIDResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /breadcrumbs:
    get:
      tags:
        - open
      summary: "パンくずリスト取得API"
      description: |-
        パンくずリストの情報を取得します。
        クエリパラメータでurlかpathを指定します。指定しない場合は、トップページのパンくずリストが帰ってきます。
      parameters:
        - in: "query"
          name: "url"
          schema:
            type: string
            format: uri
        - in: "query"
          name: "path"
          schema:
            type: string
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BreadcrumbsResponse'
  /sitemap:
    get:
      tags:
        - open
      summary: "サイトマップ取得API"
      description: |-
        サイトマップの情報を取得します。
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SitemapResponse'

  /login:
    post:
      tags:
        - auth
      summary: "ログイン用API"
      description: |-
        ログインします
      requestBody:
        description: "request body"
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /register:
    post:
      tags:
        - auth
      summary: "新規登録用API"
      description: |-
        新規登録します
      requestBody:
        description: "request body"
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterRequest'
        required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /logout:
    post:
      tags:
        - auth
      summary: "ログアウト用API"
      description: |-
        ログアウトします
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
  /password/email:
    post:
      tags:
        - auth
      summary: "パスワード変更フォームを受け取る"
      description: |-
        パスワード変更フォームを受け取る
      responses:
        200:
          description: "OK"
  /password/reset:
    post:
      tags:
        - auth
      summary: "パスワードの再発行"
      description: |-
        パスワードの再発行
      responses:
        200:
          description: "OK"
  /email/resend:
    post:
      tags:
        - auth
      summary: "メールアドレスに再送信"
      description: |-
        メールアドレスに再送信
      responses:
        200:
          description: "OK"
  /email/verify/{user}:
    post:
      tags:
        - auth
      summary: "メールアドレスを認証する"
      description: |-
        メールアドレスを認証する
      parameters:
        - in: "path"
          name: "user"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"

  /profiles:
    get:
      tags:
        - user
      summary: "全ユーザープロフィール取得API"
      description: |-
        戻り値はページネーションで帰ってくる
      security:
        - ApiToken: []
      parameters:
        - in: "query"
          name: "per_page"
          schema:
            type: integer
        - in: "query"
          name: "page"
          schema:
            type: integer
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilesResponse'
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /storages:
    get:
      tags:
        - user
      summary: "全ユーザー全作品取得API"
      security:
        - ApiToken: []
      parameters:
        - in: "query"
          name: "per_page"
          schema:
            type: integer
        - in: "query"
          name: "page"
          schema:
            type: integer
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragesResponse'
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /release:
    get:
      tags:
        - user
      summary: "公開設定の一覧API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoragesResponse'
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users:
    delete:
      tags:
        - user
      summary: "ユーザー(自分)削除API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users/profile:
    get:
      tags:
        - user
      summary: "自身のプロフィール取得API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - user
      summary: "自身のプロフィール更新API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users/page:
    get:
      tags:
        - user
      summary: "自身のポートフォリオ取得API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - user
      summary: "自身のポートフォリオ更新API"
      security:
        - ApiToken: []
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users/storage:
    get:
      tags:
        - user
      summary: "作品一覧取得API"
      description: |-
        作品一覧を取得します。ログイン済みユーザーのみ表示。
      security:
        - ApiToken: []
      parameters:
        - in: "query"
          name: "per_page"
          schema:
            type: integer
        - in: "query"
          name: "page"
          schema:
            type: integer
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersStorageResponse'
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - user
      summary: "新規作品追加API"
      security:
      - ApiToken: []
      requestBody:
        description: "request body"
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserStoragePostRequest'
        required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users/storage/{id}:
    get:
      tags:
        - user
      summary: "個別作品取得API"
      security:
      - ApiToken: []
      parameters:
        - in: "path"
          name: "id"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        404:
          description: "Not Found"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
        - user
      summary: "個別作品更新API"
      security:
      - ApiToken: []
      parameters:
        - in: "path"
          name: "id"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
        - user
      summary: "個別作品削除API"
      security:
      - ApiToken: []
      parameters:
        - in: "path"
          name: "id"
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: ''
        401:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: "Unauthenticated"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        422:
          description: "Validation Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: "Internal Server Error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: "エラーメッセージ"
        errors:
          type: object

    PagesUserResponse:
      type: object
      properties:
        data:
          type: object
          $ref: '#/components/schemas/UserByPage'
    PagesUserStoragesResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: ''
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/Storage'
        first_page_url:
          type: string
          description: '1ページ名のURL'
        from:
          type: integer
          description: ''
          example: 1
        last_page:
          type: integer
          description: ''
          example: 10
        last_page_url:
          type: string
          description: 'ページネーションの最後のページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=10"
        next_page_url:
          type: string
          description: 'ページネーションの次ページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=2"
        path:
          type: string
          description: 'ページネーションのURL'
          example: "http://localhost:8000/api/v1/profiles"
        per_page:
          type: integer
          description: ''
          example: 15
        prev_page_url:
          type: string
          description: 'ページネーションの前ページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=1"
        to:
          type: integer
          description: ''
          example: 3
        total:
          type: integer
          description: ''
          example: 3
    PageUsersStorageIDResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Storage'
    BreadcrumbsResponse:
      type: object
      properties:
        data:
          type: string
          description: ''
    SitemapResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: string
          example:
            - http://localhost:3000
            - http://localhost:3000/pages/admin
            - http://localhost:3000/pages/admin/storages/1581315433ra05d0

    LoginRequest:
      type: object
      properties:
        email:
          type: string
          format: email
          description: "メールアドレス"
          default: "admin@example.com"
        password:
          type: string
          format: password
          description: "パスワード"
          default: "password"
      required:
        - email
          password
    LoginResponse:
      type: object
      properties:
        token:
          type: string
          description: "Token"
        token_type:
          type: string
        expires_in:
          type: integer
    RegisterRequest:
      type: object
      properties:
        name:
          type: string
          description: "ユーザー名"
        email:
          type: string
          format: email
          description: "メールアドレス"
        password:
          type: string
          format: password
          description: "パスワード"
        password_confirmation:
          type: string
          format: password
          description: "パスワード確認用"

    ProfilesResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: ''
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserByPage'
        first_page_url":
          type: string
          description: '1ページ名のURL'
        from":
          type: integer
          description: ''
          example: 1
        last_page":
          type: integer
          description: ''
          example: 10
        last_page_url":
          type: string
          description: 'ページネーションの最後のページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=10"
        next_page_url":
          type: string
          description: 'ページネーションの次ページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=2"
        path":
          type: string
          description: 'ページネーションのURL'
          example: "http://localhost:8000/api/v1/profiles"
        per_page":
          type: integer
          description: ''
          example: 15
        prev_page_url":
          type: string
          description: 'ページネーションの前ページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=1"
        to":
          type: integer
          description: ''
          example: 3
        total":
          type: integer
          description: ''
          example: 3
    StoragesResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: ''
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/Storage'
        first_page_url":
          type: string
          description: '1ページ名のURL'
        from":
          type: integer
          description: ''
          example: 1
        last_page":
          type: integer
          description: ''
          example: 10
        last_page_url":
          type: string
          description: 'ページネーションの最後のページのURL'
          example: "http://localhost:8000/api/v1/storages?page=10"
        next_page_url":
          type: string
          description: 'ページネーションの次ページのURL'
          example: "http://localhost:8000/api/v1/storages?page=2"
        path":
          type: string
          description: 'ページネーションのURL'
          example: "http://localhost:8000/api/v1/storages"
        per_page":
          type: integer
          description: ''
          example: 15
        prev_page_url":
          type: string
          description: 'ページネーションの前ページのURL'
          example: "http://localhost:8000/api/v1/profiles?page=1"
        to":
          type: integer
          description: ''
          example: 3
        total":
          type: integer
          description: ''
          example: 3
    UsersStorageResponse:
      type: object
      properties:
        storage_id:
          type: string
          description: "ストレージID"
    UserStoragePostRequest:
      type: object
      properties:
        title:
          type: string
          description: "作品名"
        description:
          type: string
          description: '一言コメント'
        long_comment:
          type: string
          description: '長文コメント'
        storage:
          type: string
          format: binary
          description: '作品ファイル'
        eyecatch_image:
          type: string
          format: binary
          description: 'アイキャッチ画像'
        web_address:
          type: string
          description: "WEBアドレス"


    UserByPage:
      type: object
      properties:
        id:
          type: integer
          description: "ユーザーID"
        name:
          type: string
          description: "ユーザー名"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"
        user_info:
          $ref: '#/components/schemas/UserInfo'
        user_profile:
          $ref: '#/components/schemas/UserProfile'
        user_portfolio:
          $ref: '#/components/schemas/UserPortfolio'
    UserInfo:
      type: object
      properties:
        user_id:
          type: integer
          description: "ユーザーID"
        last_name:
          type: string
          description: "姓"
        first_name:
          type: string
          description: "名"
        school_name:
          type: string
          description: "学校名"
        birthday:
          type: string
          format: date
          description: "誕生日"
        prefecture:
          type: string
          description: "都道府県"
        city:
          type: string
          description: "市区町村"
        street:
          type: string
          description: "建物・マンション名"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"
    UserProfile:
      type: object
      properties:
        user_id:
          type: integer
          description: "ユーザーID"
        nick_name:
          type: string
          description: "ニックネーム"
        job_name:
          type: string
          description: "肩書き"
        hobby:
          type: string
          description: "趣味"
        description:
          type: string
          description: "一言コメント"
        icon_image_id:
          type: string
          format: uuid
          description: "アイコンイメージID"
        web_address:
          type: string
          format: uri
          description: "My Siteへのアドレス"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"
    UserPortfolio:
      type: object
      properties:
        user_id:
          type: integer
          description: "ユーザーID"
        masterpiece_storage_id:
          type: string
          description: "代表作品ID"
        long_comment:
          type: string
          description: "長文コメント"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"
    Storage:
      type: object
      properties:
        storage_id:
          type: string
          description: "ストレージID"
        user_id":
          type: string
          description: "ユーザーID"
        title":
          type: string
          description: "作品名"
        description":
          type: string
          description: "一言コメント"
        long_comment":
          type: string
          description: "長文コメント"
        storage_url":
          type: string
          format: url
          description: "作品のURL"
        eyecatch_image_id":
          type: string
          format: uuid
          description: "作品のアイキャッチ画像ID"
        web_address":
          type: string
          format: url
          description: "自分のWEBサイトのアドレス"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"
        eyecatch_image:
          $ref: '#/components/schemas/EyecatchImage'
    EyecatchImage:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: "作品のID"
        title:
          type: string
          description: "作品のタイトル(プログラムで任意に決定)"
        url:
          type: string
          format: url
          description: "画像のURL"
        url_160:
          type: string
          format: url
          description: "画像のURL(width = 160)"
        url_320:
          type: string
          format: url
          description: "画像のURL(width = 320)"
        url_640:
          type: string
          format: url
          description: "画像のURL(width = 640)"
        url_1024:
          type: string
          format: url
          description: "画像のURL(width = 1024)"
        url_1280:
          type: string
          format: url
          description: "画像のURL(width = 1280)"
        url_1920:
          type: string
          format: url
          description: "画像のURL(width = 1920)"
        url_2580:
          type: string
          format: url
          description: "画像のURL(width = 2580)"
        created_at:
          type: string
          format: date-time
          description: "作成日時"
        updated_at:
          type: string
          format: date-time
          description: "更新日時"

  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: |-
        この値は以下のものをしよう。認証APIを叩いて取得する<br>
        token_type token<br>
        ※ token_typeは大文字から始める(パスカルケース)