Add files via upload

Author: takecchi

docs/cuculus-openapi.yaml

@@ -1,5 +1,17 @@
 openapi: 3.0.0
 paths:
+  /v0/system/settings:
+    get:
+      operationId: getSystemSettings
+      summary: システムの設定を返却する
+      parameters: []
+      responses:
+        '200':
+          description: システム設定情報
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SystemSettings'
   /v0/users/me:
     get:
       operationId: getMe
@@ -195,9 +207,9 @@ paths:
           description: 既に登録済みのユーザー
       tags:
         - auth
-  /v0/auth/verify-code:
+  /v0/auth/pre-sign-up/verify-code:
     post:
-      operationId: postVerifyCode
+      operationId: postPreSignUpVerifyCode
       summary: 認証コードの確認
       parameters: []
       requestBody:
@@ -301,6 +313,109 @@ paths:
         - auth
       security:
         - cookie: []
+  /health:
+    get:
+      operationId: HealthController_check
+      parameters: []
+      responses:
+        '200':
+          description: The Health Check is successful
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    example: ok
+                  info:
+                    type: object
+                    example:
+                      database:
+                        status: up
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
+                    nullable: true
+                  error:
+                    type: object
+                    example: {}
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
+                    nullable: true
+                  details:
+                    type: object
+                    example:
+                      database:
+                        status: up
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
+        '503':
+          description: The Health Check is not successful
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    example: error
+                  info:
+                    type: object
+                    example:
+                      database:
+                        status: up
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
+                    nullable: true
+                  error:
+                    type: object
+                    example:
+                      redis:
+                        status: down
+                        message: Could not connect
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
+                    nullable: true
+                  details:
+                    type: object
+                    example:
+                      database:
+                        status: up
+                      redis:
+                        status: down
+                        message: Could not connect
+                    additionalProperties:
+                      type: object
+                      properties:
+                        status:
+                          type: string
+                      additionalProperties:
+                        type: string
   /v0/posts:
     post:
       operationId: createPost
@@ -551,10 +666,66 @@ paths:
         - timelines
       security:
         - bearer: []
+  /v0/invitations/verify-code:
+    post:
+      operationId: postInvitationVerifyCode
+      summary: 招待コードの確認
+      parameters: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/InvitationCodeRequest'
+      responses:
+        '200':
+          description: 招待コードOK
+        '400':
+          description: 招待コードが無効です。
+      tags:
+        - invitations
+  /v0/invitations/me:
+    get:
+      operationId: getInvitationsMe
+      summary: 自分が発行した招待コード一覧
+      parameters: []
+      responses:
+        '200':
+          description: 招待コード一覧
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/InvitationsInfo'
+        '401':
+          description: 認証エラー
+      tags:
+        - invitations
+      security:
+        - bearer: []
+  /v0/invitations/create:
+    post:
+      operationId: postInvitationsCreate
+      summary: 招待コードの発行
+      parameters: []
+      responses:
+        '200':
+          description: 招待コード発行
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Invitation'
+        '400':
+          description: 招待コードの発行に失敗しました。
+        '401':
+          description: 認証エラー
+      tags:
+        - invitations
+      security:
+        - bearer: []
 info:
   title: Cuculus API
   description: The Cuculus API description
-  version: '1.0'
+  version: 0.0.1
   contact: {}
 tags: []
 servers: []
@@ -569,6 +740,18 @@ components:
       in: cookie
       name: auth_token
   schemas:
+    SystemSettings:
+      type: object
+      properties:
+        invitation_only:
+          type: boolean
+          description: 招待制ON/OFF
+        maintenance:
+          type: boolean
+          description: メンテナンス中
+      required:
+        - invitation_only
+        - maintenance
     UserResponse:
       type: object
       properties:
@@ -753,11 +936,16 @@ components:
           type: string
           description: パスワード
           example: password
+        invitation_code:
+          type: string
+          description: 招待コード
+          example: ABCDE12345
       required:
         - email
         - code
         - username
         - password
+        - invitation_code
     AuthResponse:
       type: object
       properties:
@@ -800,3 +988,42 @@ components:
       required:
         - original_post_id
         - text
+    InvitationCodeRequest:
+      type: object
+      properties:
+        invitation_code:
+          type: string
+          description: 招待コード
+          example: ABCDE12345
+      required:
+        - invitation_code
+    Invitation:
+      type: object
+      properties:
+        code:
+          type: string
+          description: 招待コード
+          example: ABCDE12345
+        issued_at:
+          format: date-time
+          type: string
+          description: 招待コードの発行日時
+          example: '2021-01-01T00:00:00.000Z'
+      required:
+        - code
+        - issued_at
+    InvitationsInfo:
+      type: object
+      properties:
+        remaining_invitations:
+          type: number
+          description: 発行できる招待コードの残数
+          example: 10
+        invitations:
+          description: 自分が発行した招待コード一覧
+          type: array
+          items:
+            $ref: '#/components/schemas/Invitation'
+      required:
+        - remaining_invitations
+        - invitations