# Scalar Galaxy > The Scalar Galaxy is an example OpenAPI document to test OpenAPI tools and libraries. It's a fictional universe with fictional planets and fictional data. --- Source: https://lyvo.mizuchi.dev/api/ # Scalar Galaxy Version: 1.0.0 Full reference in one file: https://lyvo.mizuchi.dev/api/llms-full.txt The Scalar Galaxy is an example OpenAPI document to test OpenAPI tools and libraries. It's a fictional universe with fictional planets and fictional data. ## Resources * https://github.com/scalar/scalar * https://github.com/OAI/OpenAPI-Specification * https://scalar.com ## Markdown Support All descriptions *can* contain ~~tons of text~~ **Markdown**. [If GitHub supports the syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), chances are we're supporting it, too.
Examples **Blockquotes** > I love OpenAPI. <3 **Tables** | Feature | Availability | | ---------------- | ------------ | | Markdown Support | ✓ | **Accordion** ```html
Using Details Tags

HTML Example

``` **Images** Yes, there's support for images, too! ![Empty placeholder image showing the width/height](https://images.placeholders.dev/?width=1280&height=720) **Alerts** > [!tip] > You can use Markdown alerts in your descriptions.
## Servers - https://galaxy.scalar.com - https://void.scalar.com/: Responds with your request data ## Endpoints - [GET /me](https://lyvo.mizuchi.dev/api/getme.md): Get authenticated user - [GET /planets](https://lyvo.mizuchi.dev/api/getalldata.md): Get all planets - [GET /planets/{planetId}](https://lyvo.mizuchi.dev/api/getplanet.md): Get a planet - [POST /auth/token](https://lyvo.mizuchi.dev/api/gettoken.md): Get a token - [POST /celestial-bodies](https://lyvo.mizuchi.dev/api/createcelestialbody.md): Create a celestial body - [POST /planets](https://lyvo.mizuchi.dev/api/createplanet.md): Create a planet - [POST /planets/{planetId}/image](https://lyvo.mizuchi.dev/api/uploadimage.md): Upload an image to a planet - [POST /user/signup](https://lyvo.mizuchi.dev/api/createuser.md): Create a user - [PUT /planets/{planetId}](https://lyvo.mizuchi.dev/api/updateplanet.md): Update a planet - [DELETE /planets/{planetId}](https://lyvo.mizuchi.dev/api/deleteplanet.md): Delete a planet ## Webhooks - [POST /newPlanet](https://lyvo.mizuchi.dev/api/post-newPlanet.md) ## Models - [BadRequestError](https://lyvo.mizuchi.dev/api/schemas/badrequesterror.md): RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807) - [CelestialBody](https://lyvo.mizuchi.dev/api/schemas/celestialbody.md): A celestial body which can be either a planet or a satellite - [Conflict](https://lyvo.mizuchi.dev/api/schemas/conflict.md): Error response for resource conflicts (RFC 7807). Returned when the request conflicts with the current state of the resource. - [Credentials](https://lyvo.mizuchi.dev/api/schemas/credentials.md): Credentials to authenticate a user - [ForbiddenError](https://lyvo.mizuchi.dev/api/schemas/forbiddenerror.md): Error response for forbidden access (RFC 7807). Returned when the user does not have permission to access the requested resource. - [ImageUploadedMessage](https://lyvo.mizuchi.dev/api/schemas/imageuploadedmessage.md): Message about an image upload - [NotFoundError](https://lyvo.mizuchi.dev/api/schemas/notfounderror.md): Error response for resource not found (RFC 7807). Returned when the requested resource does not exist. - [PaginatedResource](https://lyvo.mizuchi.dev/api/schemas/paginatedresource.md): A paginated resource - [Planet](https://lyvo.mizuchi.dev/api/schemas/planet.md): A planet in the Scalar Galaxy - [Satellite](https://lyvo.mizuchi.dev/api/schemas/satellite.md): Every satellite in the Scalar Galaxy - [Token](https://lyvo.mizuchi.dev/api/schemas/token.md): A token to authenticate a user - [TooManyRequestsError](https://lyvo.mizuchi.dev/api/schemas/toomanyrequestserror.md): Error response for rate limiting (RFC 7807). Returned when the client has exceeded the rate limit for requests. - [UnauthorizedError](https://lyvo.mizuchi.dev/api/schemas/unauthorizederror.md): Error response for unauthorized access (RFC 7807). Returned when authentication is required or has failed. - [UnprocessableEntity](https://lyvo.mizuchi.dev/api/schemas/unprocessableentity.md): Error response for unprocessable entity (RFC 7807). Returned when the request is well-formed but contains semantic errors. - [User](https://lyvo.mizuchi.dev/api/schemas/user.md): A user --- Source: https://lyvo.mizuchi.dev/api/getme/ # Get authenticated user `GET /me` Find yourself they say. That's what you can do here. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - basicAuth: HTTP basic - oAuth2: oauth2 (scopes: read:account) - bearerAuth: HTTP bearer - apiKeyHeader: API key in header `X-API-Key` - apiKeyQuery: API key in query `api_key` ## Responses ### 200: Authenticated user information retrieved successfully Returns `User`. - `id` (integer) - `name` (string) ```json { "id": 1, "name": "Marc" } ``` ### 401: Unauthorized Returns `UnauthorizedError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Unauthorized", "status": 401, "detail": "You are not authorized to access this resource." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ## Example request ```bash curl -X GET 'https://galaxy.scalar.com/me' \ -H 'Authorization: Bearer ' \ -H 'X-API-Key: ' ``` --- Source: https://lyvo.mizuchi.dev/api/getalldata/ # Get all planets `GET /planets` It's easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `limit` | query | integer | no | The number of items to return | | `offset` | query | integer | no | The number of items to skip before starting to collect the result set | ## Responses ### 200: OK - `data` (array) - `meta` (object) - `limit` (integer) - `offset` (integer) - `total` (integer) - `next` (string | null) ```json { "data": [ { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "id": 1, "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ], "meta": { "limit": 10, "offset": 0, "total": 100, "next": "/planets?limit=10&offset=10" } } ``` ## Example request ```bash curl -X GET 'https://galaxy.scalar.com/planets' ``` --- Source: https://lyvo.mizuchi.dev/api/getplanet/ # Get a planet `GET /planets/{planetId}` You'll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `planetId` | path | integer | yes | The ID of the planet to get | ## Responses ### 200: Planet Found Returns `Planet`. - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation ```json { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "id": 1, "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ### 404: Not Found Returns `NotFoundError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Not Found", "status": 404, "detail": "The resource you are trying to access does not exist." } ``` ## Example request ```bash curl -X GET 'https://galaxy.scalar.com/planets/{planetId}' ``` --- Source: https://lyvo.mizuchi.dev/api/gettoken/ # Get a token `POST /auth/token` Yeah, this is the boring security stuff. Just get your super secret token and move on. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Request body (application/json) Also accepts: application/xml. Body for credentials to authenticate a user - `email` (string, required) - `password` (string, required) Example: ```json { "email": "marc@scalar.com", "password": "i-love-scalar" } ``` ## Responses ### 201: Token Created Returns `Token`. - `token` (string) ```json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } ``` ### 400: Bad Request Returns `BadRequestError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/bad-request", "title": "Bad Request", "status": 400, "detail": "The request was invalid." } ``` ### 401: Unauthorized Returns `UnauthorizedError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Unauthorized", "status": 401, "detail": "You are not authorized to access this resource." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ### 429: Too Many Requests Returns `TooManyRequestsError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/too-many-requests", "title": "Too Many Requests", "status": 429, "detail": "Rate limit exceeded. Please try again later." } ``` ## Example request ```bash curl -X POST 'https://galaxy.scalar.com/auth/token' \ -H 'Content-Type: application/json' \ -d '{ "email": "marc@scalar.com", "password": "i-love-scalar" }' ``` --- Source: https://lyvo.mizuchi.dev/api/createcelestialbody/ # Create a celestial body `POST /celestial-bodies` Create a celestial body Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Request body (application/json, required) Celestial body to create - One of: - Planet - Satellite Example: ```json { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": {}, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ## Responses ### 201: Celestial body created Returns `CelestialBody`. - One of: - Planet - Satellite ```json { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "id": 1, "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": {}, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ## Example request ```bash curl -X POST 'https://galaxy.scalar.com/celestial-bodies' \ -H 'Authorization: Basic ' \ -H 'X-API-Key: ' \ -H 'Content-Type: application/json' \ -d '{ "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": {}, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }' ``` --- Source: https://lyvo.mizuchi.dev/api/createplanet/ # Create a planet `POST /planets` Time to play god and create a new planet. What do you think? Ah, don't think too much. What could go wrong anyway? Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Request body (application/json) Also accepts: application/xml. Planet - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation Example: ```json { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ## Responses ### 201: Created Returns `Planet`. - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation ```json { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "id": 1, "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ### 400: Bad Request Returns `BadRequestError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/bad-request", "title": "Bad Request", "status": 400, "detail": "The request was invalid." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ## Example request ```bash curl -X POST 'https://galaxy.scalar.com/planets' \ -H 'Authorization: Basic ' \ -H 'X-API-Key: ' \ -H 'Content-Type: application/json' \ -d '{ "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }' ``` --- Source: https://lyvo.mizuchi.dev/api/uploadimage/ # Upload an image to a planet `POST /planets/{planetId}/image` Got a crazy good photo of a planet? Share it with the world! Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `planetId` | path | integer | yes | The ID of the planet to get | ## Request body (multipart/form-data) Image to upload - `image` (string): The image file to upload Example: ```json { "image": "@mars.jpg" } ``` ## Responses ### 200: Image uploaded Returns `ImageUploadedMessage`. - `message` (string) - `imageUrl` (string): The URL where the uploaded image can be accessed - `uploadedAt` (string): Timestamp when the image was uploaded - `fileSize` (integer): Size of the uploaded image in bytes - `mimeType` (string): The content type of the uploaded image ```json { "message": "Image uploaded successfully", "imageUrl": "https://cdn.scalar.com/images/8f47c132-9d1f-4f83-b5a4-91db5ee757ab.jpg", "uploadedAt": "2024-01-15T14:30:00.000Z", "fileSize": 1048576, "mimeType": "image/jpeg" } ``` ### 400: Bad Request Returns `BadRequestError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/bad-request", "title": "Bad Request", "status": 400, "detail": "The request was invalid." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ### 404: Not Found Returns `NotFoundError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Not Found", "status": 404, "detail": "The resource you are trying to access does not exist." } ``` ## Example request ```bash curl -X POST 'https://galaxy.scalar.com/planets/{planetId}/image' \ -H 'Authorization: Basic ' \ -H 'X-API-Key: ' \ -F 'image=@mars.jpg' ``` --- Source: https://lyvo.mizuchi.dev/api/createuser/ # Create a user `POST /user/signup` Time to create a user account, eh? Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Request body (application/json) Also accepts: application/xml. User to create - `id` (integer) - `name` (string) - `email` (string, required) - `password` (string, required) Example: ```json { "name": "Marc", "email": "marc@scalar.com", "password": "i-love-scalar" } ``` ## Responses ### 201: User account created successfully Returns `User`. - `id` (integer) - `name` (string) ```json { "id": 1, "name": "Marc" } ``` ### 400: Bad Request Returns `BadRequestError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/bad-request", "title": "Bad Request", "status": 400, "detail": "The request was invalid." } ``` ### 401: Unauthorized Returns `UnauthorizedError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Unauthorized", "status": 401, "detail": "You are not authorized to access this resource." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ### 409: Conflict Returns `Conflict`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/conflict", "title": "Conflict", "status": 409, "detail": "The resource you are trying to access is in conflict." } ``` ### 422: Unprocessable Entity Returns `UnprocessableEntity`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/unprocessable-entity", "title": "Unprocessable Entity", "status": 422, "detail": "The request was invalid." } ``` ## Example request ```bash curl -X POST 'https://galaxy.scalar.com/user/signup' \ -H 'Content-Type: application/json' \ -d '{ "name": "Marc", "email": "marc@scalar.com", "password": "i-love-scalar" }' ``` --- Source: https://lyvo.mizuchi.dev/api/updateplanet/ # Update a planet `PUT /planets/{planetId}` Sometimes you make mistakes, that's fine. No worries, you can update all planets. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `planetId` | path | integer | yes | The ID of the planet to get | ## Request body (application/json) Also accepts: application/xml. New information about the planet - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation Example: ```json { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ## Responses ### 200: Planet updated successfully Returns `Planet`. - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation ```json { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "id": 1, "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "id": 1, "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "id": 1, "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "lastUpdated": "2024-01-15T14:30:00.000Z", "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ### 400: Bad Request Returns `BadRequestError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/bad-request", "title": "Bad Request", "status": 400, "detail": "The request was invalid." } ``` ### 403: Forbidden Returns `ForbiddenError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/forbidden", "title": "Forbidden", "status": 403, "detail": "You are not authorized to access this resource." } ``` ### 404: Not Found Returns `NotFoundError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Not Found", "status": 404, "detail": "The resource you are trying to access does not exist." } ``` ## Example request ```bash curl -X PUT 'https://galaxy.scalar.com/planets/{planetId}' \ -H 'Authorization: Basic ' \ -H 'X-API-Key: ' \ -H 'Content-Type: application/json' \ -d '{ "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }' ``` --- Source: https://lyvo.mizuchi.dev/api/deleteplanet/ # Delete a planet `DELETE /planets/{planetId}` This endpoint was used to delete planets. Unfortunately, that caused a lot of trouble for planets with life. So, this endpoint is now deprecated and should not be used anymore. Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `planetId` | path | integer | yes | The ID of the planet to get | ## Responses ### 204: No Content ### 404: Not Found Returns `NotFoundError`. - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) ```json { "type": "https://example.com/errors/not-found", "title": "Not Found", "status": 404, "detail": "The resource you are trying to access does not exist." } ``` ## Example request ```bash curl -X DELETE 'https://galaxy.scalar.com/planets/{planetId}' \ -H 'Authorization: Basic ' \ -H 'X-API-Key: ' ``` --- Source: https://lyvo.mizuchi.dev/api/post-newPlanet/ # New Planet `POST /newPlanet` Base URL: https://galaxy.scalar.com, https://void.scalar.com/ ## Authorization - bearerAuth: HTTP bearer - basicAuth: HTTP basic - apiKeyQuery: API key in query `api_key` - apiKeyHeader: API key in header `X-API-Key` - apiKeyCookie: API key in cookie `api_key` - oAuth2: oauth2 - openIdConnect: openIdConnect ## Request body (application/json) Information about a new planet - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation Example: ```json { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [ { "name": "Phobos", "description": "Phobos is the larger and innermost of the two moons of Mars.", "diameter": 22.2, "type": "moon", "orbit": { "planet": { "name": "Mars", "description": "The red planet", "type": "terrestrial", "habitabilityIndex": 0.68, "physicalProperties": { "mass": 0.107, "radius": 0.532, "gravity": 0.378, "temperature": { "min": 130, "max": 308, "average": 210, "temperatureMetric1": 0.1, "temperatureMetric2": 0.1 }, "measurement1": 0.1, "measurement2": 0.1 }, "atmosphere": [ { "compound": "CO2", "percentage": 95.3, "atmosphericData1": "string", "atmosphericData2": "string" } ], "discoveredAt": "1610-01-07T00:00:00.000Z", "image": "https://cdn.scalar.com/photos/mars.jpg", "satellites": [], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" }, "orbitalPeriod": 0.319, "distance": 9376 } } ], "creator": { "name": "Marc" }, "tags": [ "solar-system", "rocky", "explored" ], "successCallbackUrl": "https://example.com/webhook", "failureCallbackUrl": "https://example.com/webhook" } ``` ## Responses ### 200: Return a 200 status to indicate that the data was received successfully --- Source: https://lyvo.mizuchi.dev/api/schemas/badrequesterror/ # BadRequestError RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807) Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/celestialbody/ # CelestialBody A celestial body which can be either a planet or a satellite Type: `union` - One of: - Planet - Satellite --- Source: https://lyvo.mizuchi.dev/api/schemas/conflict/ # Conflict Error response for resource conflicts (RFC 7807). Returned when the request conflicts with the current state of the resource. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/credentials/ # Credentials Credentials to authenticate a user Type: `object` - `email` (string, required) - `password` (string, required) --- Source: https://lyvo.mizuchi.dev/api/schemas/forbiddenerror/ # ForbiddenError Error response for forbidden access (RFC 7807). Returned when the user does not have permission to access the requested resource. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/imageuploadedmessage/ # ImageUploadedMessage Message about an image upload Type: `object` - `message` (string) - `imageUrl` (string): The URL where the uploaded image can be accessed - `uploadedAt` (string): Timestamp when the image was uploaded - `fileSize` (integer): Size of the uploaded image in bytes - `mimeType` (string): The content type of the uploaded image --- Source: https://lyvo.mizuchi.dev/api/schemas/notfounderror/ # NotFoundError Error response for resource not found (RFC 7807). Returned when the requested resource does not exist. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/paginatedresource/ # PaginatedResource A paginated resource Type: `object` - `meta` (object) - `limit` (integer) - `offset` (integer) - `total` (integer) - `next` (string | null) --- Source: https://lyvo.mizuchi.dev/api/schemas/planet/ # Planet A planet in the Scalar Galaxy Type: `object` - `id` (integer, required) - `name` (string, required) - `description` (string | null) - `type` (string): One of: `terrestrial`, `gas_giant`, `ice_giant`, `dwarf`, `super_earth`. - `habitabilityIndex` (number): A score from 0 to 1 indicating potential habitability - `physicalProperties` (object) - `mass` (number): Mass in Earth masses (must be greater than 0) - `radius` (number): Radius in Earth radii (must be greater than 0) - `gravity` (number): Surface gravity in Earth g - `temperature` (object) - `min` (number): Minimum temperature in Kelvin - `max` (number): Maximum temperature in Kelvin - `average` (number): Average temperature in Kelvin - `atmosphere` (array): Atmospheric composition - `compound` (string) - `percentage` (number) - `discoveredAt` (string) - `image` (string | null) - `satellites` (array) - `creator` (User): A user - `tags` (array) - `lastUpdated` (string) - `successCallbackUrl` (string): URL which gets invoked upon a successful operation - `failureCallbackUrl` (string): URL which gets invoked upon a failed operation --- Source: https://lyvo.mizuchi.dev/api/schemas/satellite/ # Satellite Every satellite in the Scalar Galaxy Type: `object` - `id` (integer) - `name` (string, required) - `description` (string | null) - `diameter` (number): Diameter in kilometers - `type` (string): One of: `moon`, `asteroid`, `comet`. - `orbit` (object) - `planet` (Planet) - `orbitalPeriod` (number): Orbital period in Earth days - `distance` (number): Average distance from the planet in kilometers --- Source: https://lyvo.mizuchi.dev/api/schemas/token/ # Token A token to authenticate a user Type: `object` - `token` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/toomanyrequestserror/ # TooManyRequestsError Error response for rate limiting (RFC 7807). Returned when the client has exceeded the rate limit for requests. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/unauthorizederror/ # UnauthorizedError Error response for unauthorized access (RFC 7807). Returned when authentication is required or has failed. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/unprocessableentity/ # UnprocessableEntity Error response for unprocessable entity (RFC 7807). Returned when the request is well-formed but contains semantic errors. Type: `object` - `type` (string) - `title` (string) - `status` (integer) - `detail` (string) --- Source: https://lyvo.mizuchi.dev/api/schemas/user/ # User A user Type: `object` - `id` (integer) - `name` (string)