openapi: 3.0.3 info: title: PetStore API version: "0.1.1" description: |- ## PetStore OpenAPI 設計 - バックエンド: Laravel - フロントエンド: Vue license: name: MIT servers: - url: "http://localhost/api/" description: 開発サーバーURL - url: "https://product/api/" description: 本番サーバーURL paths: /user: post: operationId: registerNewUser tags: - User summary: 新規ユーザー登録 description: |- 新規ユーザー登録 ## Permission - None ## Validations - email: メールアドレスチェック、Usersテーブル重複チェック - name: 最大40文字 ## Logic - 登録成功するとメール通知 - 通知メールのURLに email_verity.verity_string - メールアドレスチェック後email_verified_at更新 - email_verified_atがnullではない場合、認証済みユーザーと認識する。 responses: default: description: その他エラー content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 登録成功 content: applicaiton/json: schema: properties: id: description: 新規登録ユーザーID type: integer additionalProperties: false "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_auth_register" example: name: "test" email: "test@test.com" password: "password" security: - apiKey: [] get: operationId: getUser tags: - User summary: ユーザー情報取得 description: |- ユーザー情報 responses: default: description: unexpected error content: application/json: schema: type: object $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/user" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] put: operationId: updateUser tags: - User summary: ユーザー情報更新 description: |- ユーザー情報更新項目 - ユーザー名更新 - ステータス更新 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/user" security: - apiKey: [] - bearer: [] delete: operationId: deleteUser tags: - User summary: ユーザー削除 description: |- ユーザー削除 - softdelete responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] /user/avatar: post: tags: - User operationId: uploadAvatarImage summary: アップロードユーザーイメージ description: |- イメージファイルアップロード - tmpフォルダへ保存 - pet 新規登録、修正する成功時、 usersフォルダへ移動 - user avatar 情報更新 responses: "200": description: OK content: applicaiton/json: schema: type: object properties: file_name: type: string requestBody: content: multipart/form-data: schema: type: object properties: image: type: string format: binary security: - apiKey: [] - bearer: [] /user/{orderId}/evalution: post: tags: - User operationId: addNewEvalution summary: 評価 description: |- responses: "200": description: 登録成功 content: applicaiton/json: schema: properties: id: description: ID type: integer additionalProperties: false "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: User Not found content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: orderId schema: type: integer in: path required: true requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_user_evalution" security: - apiKey: [] - bearer: [] /login: post: operationId: login tags: - User summary: ログイン description: |- ログイン ## Validations - email: メールアドレスチェック - password max 20 ## ロジック - ユーザーToken削除 - 新しいToken成功生成 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: properties: token: type: string user: $ref: "#/components/schemas/user" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: User Not found content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_auth_login" example: email: "test@test.com" password: "password" security: - apiKey: [] /logout: get: operationId: logout tags: - User summary: ログアウト description: |- ログアウト処理 - client: Token 削除 - server: ユーザーToken削除 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: type: object default: {} "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] /user/favorites: get: operationId: getUserFavorites tags: - User summary: お気に入り一覧取得 description: |- ユーザーお気に入り一覧取得 responses: default: description: その他エラー content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 登録成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] /user/{petId}/favorite/: put: operationId: updateUserFavorite tags: - User summary: お気に入り登録削除 description: |- ユーザーお気に入り登録削除 responses: default: description: その他エラー content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 登録成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - schema: type: integer name: petId in: path required: true security: - apiKey: [] - bearer: [] /user/findUserByName: get: operationId: findUserByName tags: - User summary: ユーザー検索 description: |- ユーザー名で検索 - ユーザー名前後一致検索 - 結果がない場合、[]を返す。 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: application/json: schema: type: array items: $ref: "#/components/schemas/user" maxItems: 10 minItems: 0 "400": description: パラメーターエラー content: application/json: schema: $ref: "#/components/schemas/error400" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - schema: type: string name: username in: query required: true security: - apiKey: [] /user/{userId}: put: operationId: updateUserById tags: - User summary: ユーザー情報更新 description: |- ユーザー情報更新項目 - ユーザー名更新 - ステータス更新 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - schema: type: integer name: userId in: path required: true requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/user" security: - apiKey: [] - bearer: [] delete: operationId: deleteUserById tags: - User summary: ユーザー削除 description: |- ユーザー削除 - softdelete responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - schema: type: integer name: userId in: path required: true security: - apiKey: [] - bearer: [] /user/pets: get: tags: - User operationId: getUserPets description: |- User pets. responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] /user/orders: get: tags: - User operationId: getUserOrders description: |- User Orders responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] /pet: post: operationId: addNewPet tags: - Pet summary: ペット新規登録 description: | ペット新規登録 - category は categoriesから選択したID - tags : tagsテーブルにある場合、ID登録、ない場合 tagsテーブルに新規登録 - イメージアップロードは api/pet/uploadImage responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/pet" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_pet_store" security: - apiKey: [] - bearer: [] /pets: get: operationId: getAllPets summary: ペット一覧取得 tags: - Pet description: |- stagusがavailableはorder可能 responses: default: description: unexpected error content: application/json: schema: $ref: "#/components/schemas/unexpected" "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: sort schema: type: string in: query - name: page schema: type: integer in: query security: - apiKey: [] /pet/{petId}: get: operationId: getPetById tags: - Pet summary: ペット情報取得 responses: "200": description: 成功 content: applicaiton/json: schema: type: object $ref: "#/components/schemas/pet" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true security: - apiKey: [] put: operationId: updatePetById tags: - Pet summary: ペット情報更新 description: |- 更新処理 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_pet_update" security: - apiKey: [] - bearer: [] delete: operationId: deletePetById tags: - Pet summary: ペット情報削除 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /pet/{petId}/order: delete: operationId: deleteOrderByPetId tags: - Pet summary: ペットオーダー情報削除 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /pet/comment: post: tags: - Pet operationId: addNewPetComment summary: post new comment description: |- comment post responses: "200": description: 成功 content: applicaiton/json: schema: type: object default: {} "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/pet_comment" security: - apiKey: [] - bearer: [] /pet/like: put: tags: - Pet operationId: updatePetLike summary: update pet like description: |- update like responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/pet" security: - apiKey: [] - bearer: [] /pet/{petId}/comments: get: tags: - Pet operationId: getPetComments summary: ペットコメント description: |- Pet comments. responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /pet/{petCommentId}/comment: delete: operationId: deletePetCommentById tags: - Pet summary: ペット情報削除 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petCommentId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /pet/findByCategory: get: operationId: findPetByCategory tags: - Pet summary: カテゴリで検索 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: sort schema: type: string in: query - name: category schema: type: string in: query security: - apiKey: [] /pet/uploadImage: post: tags: - Pet operationId: uploadImage summary: アップロードペットイメージ description: |- イメージファイルアップロード - tmpフォルダへ保存 - pet 新規登録、修正する成功時、 petsフォルダへ移動 responses: "200": description: OK content: applicaiton/json: schema: type: object properties: file_name: type: string requestBody: content: multipart/form-data: schema: type: object properties: image: type: string format: binary security: - apiKey: [] - bearer: [] /pet/findByTags: get: operationId: findPetByTag tags: - Pet summary: タグで検索 description: |- タグで検索 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: sort schema: type: string in: query - name: tag in: query schema: type: string - name: page schema: type: integer in: query security: - apiKey: [] /pet/findByStatus: get: operationId: findPetByStatus tags: - Pet summary: ステータスで検索 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: sort schema: type: string in: query - name: status in: query schema: type: string - name: page schema: type: integer in: query security: - apiKey: [] /category: post: operationId: addNewCategory tags: - Category summary: カテゴリ新規登録 description: | カテゴリ登録 responses: "200": description: 成功 content: applicaiton/json: schema: properties: id: type: integer "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/category" security: - apiKey: [] - bearer: [] /categories: get: operationId: getAllCategorys tags: - Category summary: カテゴリ一覧 responses: "200": description: 成功 content: applicaiton/json: schema: type: array items: $ref: "#/components/schemas/category" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] /category/{categoryId}: put: operationId: updateCategoryById tags: - Category summary: カテゴリ更新 description: | カテゴリ更新 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/category" parameters: - name: categoryId schema: type: string in: path required: true security: - apiKey: [] get: operationId: getCategoryById tags: - Category summary: カテゴリ取得 description: | カテゴリ取得 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/category" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: categoryId schema: type: integer in: path required: true security: - apiKey: [] delete: operationId: deleteCategoryById tags: - Category summary: カテゴリ削除 description: | カテゴリ削除 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: categoryId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /order: post: operationId: addNewOrder summary: オーダー登録 tags: - Order description: |- オーダー登録 responses: "200": description: 成功 "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_order_store" security: - apiKey: [] - bearer: [] /orders: get: operationId: getAllOrder tags: - Order summary: オーダー一覧取得 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] /order/{orderId}: get: operationId: getOrderById summary: オーダー取得 tags: - Order parameters: - name: orderId schema: type: integer in: path required: true responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/order" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] put: operationId: updateOrderById summary: オーダー更新 tags: - Order parameters: - name: orderId schema: type: integer in: path required: true requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/request_order_update" responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] - bearer: [] delete: operationId: deleteOrderById summary: オーダー削除 tags: - Order responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: orderId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /order/inventory: get: operationId: getOrderInventory summary: オーダーinventory tags: - Order responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/order_inventory" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" security: - apiKey: [] /order/comment: post: tags: - Order operationId: addNewOrderComment summary: post new order comment description: |- comment post responses: "200": description: 成功 content: applicaiton/json: schema: type: object default: {} "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" requestBody: content: applicaiton/json: schema: $ref: "#/components/schemas/order_comment" security: - apiKey: [] - bearer: [] /order/{petId}/comments: get: tags: - Order operationId: getOrderComments summary: Orderコメント description: |- Order comments. responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_pegination" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: petId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] /order/{orderCommentId}/comment: delete: operationId: deleteOrderCommentById tags: - Order summary: Order comment 情報削除 responses: "200": description: 成功 content: applicaiton/json: schema: $ref: "#/components/schemas/response_ok" "401": description: 認証エラー content: application/json: schema: $ref: "#/components/schemas/error400" "403": description: セキュリティエラー content: application/json: schema: $ref: "#/components/schemas/error400" "404": description: Model not found. content: application/json: schema: $ref: "#/components/schemas/error400" "405": description: Method Not Allowed content: application/json: schema: $ref: "#/components/schemas/error400" "429": description: Too Many Requests content: application/json: schema: $ref: "#/components/schemas/error400" "500": description: サーバーエラー. content: application/json: schema: $ref: "#/components/schemas/error500" parameters: - name: orderCommentId schema: type: integer in: path required: true security: - apiKey: [] - bearer: [] components: schemas: order_comment: type: object properties: id: type: integer pet_id: type: integer user_id: type: integer name: type: string avatar: type: string comment: type: string created_at: type: string updated_at: type: string pet_comment: type: object properties: id: type: integer pet_id: type: integer user_id: type: integer name: type: string avatar: type: string comment: type: string created_at: type: string updated_at: type: string category: type: object properties: id: type: integer parent_id: type: integer name: type: string order: type: object properties: id: type: integer pet: type: object $ref: "#/components/schemas/pet" orderUser: type: object $ref: "#/components/schemas/user" quantity: type: integer default: 1 status: type: string ship_date: type: string complete: type: boolean default: false created_at: type: string updated_at: type: string order_inventory: type: object properties: available: type: integer pending: type: integer sold: type: integer pet: type: object properties: id: type: integer name: type: string status: type: string description: type: string tags: type: array items: type: string photo_urls: type: array items: type: string category: type: object $ref: "#/components/schemas/category" owner: type: object $ref: "#/components/schemas/user" comments_count: type: integer created_at: type: string user: type: object required: - id properties: id: type: integer name: type: string email: type: string password: type: string avatar: type: string address: type: string phone: type: string birthday: type: string gender: type: string description: type: string created_at: type: string request_auth_register: type: object required: - name - email - password properties: name: type: string email: type: string password: type: string request_auth_login: type: object required: - email - password properties: email: type: string password: type: string request_pet_store: type: object required: - name - category - phpto_urls properties: name: type: string category_id: type: integer photo_urls: type: array maxItems: 20 items: type: string tags: type: array items: type: string description: type: string request_user_evalution: type: object required: - order_id - evalution properties: user_id: type: integer order_id: type: integer evalution: type: string comment: type: string request_pet_update: type: object required: - id - name - category properties: id: type: integer name: type: string category_id: type: integer photo_urls: type: array maxItems: 20 items: type: string tags: type: array maxItems: 20 items: type: string request_order_store: type: object required: - pet_id properties: pet_id: type: integer request_order_update: type: object required: - id - pet_id - status properties: pet_id: type: integer quantity: type: integer default: 1 status: type: integer ship_date: type: string complete: type: boolean default: false response_ok: required: - ok type: object properties: ok: type: boolean response_pegination: type: object properties: current_page: type: integer first_page_url: type: string from: type: integer last_page: type: integer last_page_url: type: integer next_page_url: type: string path: type: string per_page: type: integer prev_page_url: type: string to: type: integer total: type: integer links: type: array maxItems: 10 items: type: object properties: url: type: string label: type: string active: type: boolean data: type: array maxItems: 15 items: {} error400: type: object properties: status: type: string default: error message: type: string code: type: integer error500: type: object properties: status: type: string default: error message: type: string code: type: integer unexpected: type: object properties: status: type: string default: error message: type: string code: type: integer securitySchemes: apiKey: type: apiKey name: API-KEY in: header bearer: type: http scheme: bearer bearerFormat: bearer security: - apiKey: [] - bearer: []