swagger.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "Crunchyroll Notifier",
    "version": "1.0",
    "license": {
      "name": "MIT",
      "url": "https://raw.githubusercontent.com/DiegoVictor/crunchyroll-notifier/main/LICENSE"
    }
  },
  "servers": [
    {
      "url":"http://localhost:3000/stg"
    }
  ],
  "paths": {
    "/auth/#": {
      "post": {
        "tags": ["Authentication"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["email", "password"],
                "properties": {
                  "email": {
                    "type": "string"
                  },
                  "password": {
                    "type": "string"
                  }
                }
              },
              "example": {
                "email": "johndoe@gmail.com",
                "password": "89]Wni!rcK"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "AccessToken": {
                      "type": "string"
                    },
                    "ExpiresIn": {
                      "type": "string"
                    },
                    "IdToken": {
                      "type": "string"
                    },
                    "RefreshToken": {
                      "type": "string"
                    },
                    "TokenType": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "AccessToken": "eyJraWQiOiJyeW5XZUMzSEtCOWtRZUR2MXhabmtQd2pIY0pWUWh0RzVNWlNvb0ZyQ2NnPSIsImFsZyI6IlJTMjU2In0xvckWwoSvrsnvvEWM4rpFAbAv1RXHv18N198MOucPblUoySG42G3xVws4GgSd_YkupvpV-1RLbdqfwtHk3boUG0aFNBMu3DXb7DyQP_GdZWK-gLf3WKr82ZG9D7XhAtuKd2tAMbRxCuotFigdcxO97F0uwi__YwqpwMGfR7mg2mPgFzr84LoIUlNSzo6PBNLLhLLCkOy1uFV7mMU3-w0dkxbk_4njFrw_SpZvN9Mic0Ox9DfGe38KDhjASDe6Qr1255iRYTCc6WJUbSYRNmkewVx3MNWdCWBqrku7IAH5C-QrfQEkk58UJfKL04B2P2QvMNjCTdQC73XRd43ytFN4Q",
                  "ExpiresIn": 3600,
                  "IdToken": "eyJraWQiOiI0UkhqRm9DSTZ6NmVUa2pDNWtIZUc1Ym9QVnRqRjIzYjBmaVpGWlIwSTJzPSIsImFsZyI6IlJTMjU2In0DMtN2EwZDIyYWMwOTBkIiwidG9rZW5fdXNlIjoiaWQiLCJhdXRoX3RpbWUiOjE2MzY0MTE4NDMsImV4cCI6MTYzNjQxNTQ0MywiaWF0IjoxNjM2NDExODQzLCJqdGkiOiJjMmI3ZDRlMy0xZWY4LTQ4ZWItOTAwYy0yMmZjYzljYWEwMTAiLCJlbWFpbCI6ImpvaG5kb2VAZ21haWwuY29tIn0",
                  "RefreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.a1kWHHrnZI4eHCVbnZA5EFwZ4YTbDLZtDLlUEGoHiSfYK_PD7iVwW2yGCr_pjs5gEoYG9VuvYh72Lm7LxMrYN0sqzRAViRnfGZ81hzpeSZErljEGOzI05sYx3HT_7073Xn71EJjYe9pMUEQ5iYL27k54b9myKQkyi3AksHd7ez5cq9Gca8ahn6cplgkFdLjYWRRHA61T-Nq7IRKxbgkBTFDImmJ4M71AZ_LfGHtNm1TjRb44rwtmxRApk8ga84DB__4nZVSpo1Uzjnrxy5x6es5JA0nuBrgnNEnoJdtUteuouocfQBuJ6ewCT9MV1S1fKJHS1nutIfZa5zXKyQQXTg.YhO6NJK5we4ixX6H",
                  "TokenType": "Bearer"
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    },
    "/rss/process": {
      "head": {
        "tags": ["RSS"],
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "date",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "2021-11-03T00:00:01.000Z"
          }
        ],
        "responses": {
          "204": {
            "description": "Read episodes from RSS"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    },
    "/animes": {
      "get": {
        "tags": ["Animes"],
        "responses": {
          "200": {
            "description": "Return active animes",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Anime"
                  }
                },
                "example": [
                  {
                    "id": "eb6d70fb-a7d3-4bb7-a656-e6362587ee40",
                    "title": "The Fruit of Evolution: Before I Knew It, My Life Had It Made",
                    "active": true,
                    "topic": "TheFruitofEvolutionBeforeIKnewItMyLifeHadItMade"
                  },
                  {
                    "id": "53a9b86a-4bee-46f0-bb7d-70477210d032",
                    "title": "CARDFIGHT!! VANGUARD overDress",
                    "active": true,
                    "topic": "CARDFIGHTVANGUARDoverDress"
                  }
                ]
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      },
      "post": {
        "tags": ["Animes"],
        "security": [
          {
            "bearer": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "required": [
                  "title",
                  "active"
                ],
                "items": {
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "active": {
                      "type": "boolean"
                    }
                  }
                }
              },
              "example": [
                {
                  "title": "The Promised Neverland",
                  "active": true
                }
              ]
            }
          }
        },
        "responses": {
          "204": {
            "description": "Save or reactivate animes and create its topics"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    },
    },
  "components": {
    "schemas": {
      "Anime": {
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "topic": {
            "type": "string"
          }
        }
      },
      "Error": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "responses": {
      "InternalServerError": {
        "description": "When one non expected error occurs",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "code": 500,
              "message": "Ops! Something goes wrong, try again later"
            }
          }
        }
      }
    },
  }
}