animal-rescue.yaml

[
{
  "openapi": "3.0.1",
  "info": {
    "title": "Animal Rescue v4",
    "description": "Sample application for Spring Cloud Gateway commercial product demos.",
    "version": "1.0.0-K8s"
  },
  "servers": [
    {
      "url": "http://animal-rescue.my.domain.io:8081"
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/api/animals": {
      "summary": "Route ID: animal-rescue-animal-rescue-backend-routes-0",
      "get": {
        "tags": [
          "pet adoption"
        ],
        "summary": "Retrieve pets for adoption.",
        "description": "Retrieve all of the animals who are up for pet adoption.",
        "responses": {
          "200": {
            "description": "Ok",
            "headers": {
              "X-Remaining": {
                "description": "RateLimit: number of requests remaining",
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests. RateLimit=2,10s",
            "headers": {
              "X-Retry-In": {
                "description": "RateLimit: time in milliseconds until retry",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "/api/actuator/**": {
      "summary": "Route ID: animal-rescue-animal-rescue-backend-routes-1",
      "get": {
        "tags": [
          "actuator"
        ],
        "summary": "API Actuator endpoints",
        "description": "Access API actuator endpoints to provide current status of backend service.",
        "responses": {
          "200": {
            "description": "Ok"
          }
        }
      },
      "put": {
        "tags": [
          "actuator"
        ],
        "summary": "API Actuator endpoints",
        "description": "Access API actuator endpoints to provide current status of backend service.",
        "responses": {
          "200": {
            "description": "Ok"
          }
        }
      },
      "post": {
        "tags": [
          "actuator"
        ],
        "summary": "API Actuator endpoints",
        "description": "Access API actuator endpoints to provide current status of backend service.",
        "responses": {
          "200": {
            "description": "Ok"
          }
        }
      },
      "delete": {
        "tags": [
          "actuator"
        ],
        "summary": "API Actuator endpoints",
        "description": "Access API actuator endpoints to provide current status of backend service.",
        "responses": {
          "200": {
            "description": "Ok"
          }
        }
      }
    },
    "/api/whoami": {
      "summary": "Route ID: animal-rescue-animal-rescue-backend-routes-2",
      "get": {
        "tags": [
          "sso"
        ],
        "summary": "Retrieve user information",
        "description": "Retrieve the current authenticated user's information.",
        "responses": {
          "200": {
            "description": "Ok"
          },
          "302": {
            "description": "Redirect client to SSO login page to authenticate for authorizing access.",
            "headers": {
              "Location": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    },
    "/api/animals/{animalId}/adoption-requests": {
      "summary": "Route ID: animal-rescue-animal-rescue-backend-routes-3",
      "post": {
        "tags": [
          "pet adoption"
        ],
        "summary": "Pet adoption API",
        "description": "Manage pet adoptions.",
        "requestBody": {
          "description": "Manage adoption requests",
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "adopterName",
                  "email"
                ],
                "type": "object",
                "properties": {
                  "adopterName": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string",
                    "format": "email"
                  },
                  "notes": {
                    "type": "string"
                  }
                },
                "description": "Adoption request schema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "headers": {
              "X-Remaining": {
                "description": "RateLimit: number of requests remaining",
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "302": {
            "description": "Redirect client to SSO login page to authenticate for authorizing access.",
            "headers": {
              "Location": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests. RateLimit=1,60s",
            "headers": {
              "X-Retry-In": {
                "description": "RateLimit: time in milliseconds until retry",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "animalId",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    },
    "/api/animals/{animalId}/adoption-requests/{adoptionRequestId}": {
      "summary": "Route ID: animal-rescue-animal-rescue-backend-routes-5",
      "delete": {
        "tags": [
          "pet adoption"
        ],
        "summary": "Pet adoption API",
        "description": "Manage pet adoptions.",
        "responses": {
          "200": {
            "description": "Ok"
          },
          "302": {
            "description": "Redirect client to SSO login page to authenticate for authorizing access.",
            "headers": {
              "Location": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "animalId",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "adoptionRequestId",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    },
    "/rescue/login": {
      "summary": "Route ID: animal-rescue-animal-rescue-frontend-routes-0",
      "get": {
        "tags": [
          "sso"
        ],
        "summary": "Animal Rescue login link",
        "description": "SSO enabled path used by the login button",
        "responses": {
          "200": {
            "description": "Ok"
          },
          "302": {
            "description": "Redirect client to SSO login page to authenticate for authorizing access.",
            "headers": {
              "Location": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/rescue/**": {
      "summary": "Route ID: animal-rescue-animal-rescue-frontend-routes-1",
      "get": {
        "tags": [
          "ui"
        ],
        "summary": "Animal Rescue home page",
        "description": "Animal Rescue home page that doesn't require SSO login",
        "responses": {
          "200": {
            "description": "Ok"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "animal-rescue"
    }
  ]
}
]