openapi.augmented.json

{
  "openapi": "3.1.1",
  "info": {
    "title": "Demo API (Scalar Galaxy)",
    "description": "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. Get all the data for [all planets](#tag/planets/get/planets).\n\n## Resources\n\n* https://github.com/scalar/scalar\n* https://github.com/OAI/OpenAPI-Specification\n* https://scalar.com\n\n## Markdown Support\n\nAll 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. You can even create [internal links to reference endpoints](#tag/authentication/post/user/signup).\n\n<details>\n  <summary>Examples</summary>\n\n  **Blockquotes**\n\n  > I love OpenAPI. <3\n\n  **Tables**\n\n  | Feature          | Availability |\n  | ---------------- | ------------ |\n  | Markdown Support | ✓            |\n\n  **Accordion**\n\n  ```html\n  <details>\n    <summary>Using Details Tags</summary>\n    <p>HTML Example</p>\n  </details>\n  ```\n\n  **Images**\n\n  Yes, there's support for images, too!\n\n  ![Empty placeholder image showing the width/height](https://images.placeholders.dev/?width=1280&height=720)\n\n  **Alerts**\n\n  > [!tip]\n  > You can now use markdown alerts in your descriptions.\n\n</details>\n",
    "version": "1.0.0",
    "contact": {
      "name": "Scalar Support",
      "url": "https://scalar.com",
      "email": "marc@scalar.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/license/MIT"
    },
    "x-scalar-sdk-installation": [
      {
        "lang": "TypeScript",
        "description": "```sh\nnpm install @scalar/galaxy-sdk\n```"
      }
    ]
  },
  "externalDocs": {
    "description": "Documentation",
    "url": "https://github.com/scalar/scalar"
  },
  "servers": [
    {
      "url": "https://galaxy.scalar.com"
    },
    {
      "url": "{protocol}://void.scalar.com/{path}",
      "description": "Responds with your request data",
      "variables": {
        "protocol": {
          "enum": [
            "https"
          ],
          "default": "https"
        },
        "path": {
          "default": ""
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    },
    {
      "basicAuth": []
    },
    {
      "apiKeyQuery": []
    },
    {
      "apiKeyHeader": []
    },
    {
      "apiKeyCookie": []
    },
    {
      "oAuth2": []
    },
    {
      "openIdConnect": []
    }
  ],
  "tags": [
    {
      "name": "Authentication",
      "description": "Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself."
    },
    {
      "name": "Planets",
      "description": "Everything about planets"
    },
    {
      "name": "Celestial Bodies",
      "description": "Celestial bodies are the planets and satellites in the Scalar Galaxy."
    }
  ],
  "paths": {
    "/planets": {
      "get": {
        "tags": [
          "Planets"
        ],
        "summary": "Get all planets",
        "description": "It's easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one.",
        "operationId": "getAllData",
        "security": [
          {}
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/limit"
          },
          {
            "$ref": "#/components/parameters/offset"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Planet"
                          }
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PaginatedResource"
                    }
                  ]
                }
              },
              "application/xml": {
                "schema": {
                  "allOf": [
                    {
                      "type": "object",
                      "xml": {
                        "name": "planets"
                      },
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Planet"
                          }
                        }
                      }
                    },
                    {
                      "$ref": "#/components/schemas/PaginatedResource"
                    }
                  ]
                }
              }
            }
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst listAllData = await client.planets.listAllData({\n  limit: 10,\n  offset: 0,\n});\nconsole.log(listAllData);"
          }
        ]
      },
      "post": {
        "tags": [
          "Planets"
        ],
        "summary": "Create a planet",
        "description": "Time to play god and create a new planet. What do you think? Ah, don't think too much. What could go wrong anyway?",
        "operationId": "createPlanet",
        "callbacks": {
          "planetCreated": {
            "{$request.body#/successCallbackUrl}": {
              "post": {
                "requestBody": {
                  "description": "Information about the newly created planet",
                  "content": {
                    "application/json": {
                      "schema": {
                        "$ref": "#/components/schemas/Planet"
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  },
                  "204": {
                    "description": "Your server should return this HTTP status code if no longer interested in further updates"
                  }
                }
              }
            }
          },
          "planetExploded": {
            "{$request.body#/successCallbackUrl}": {
              "post": {
                "requestBody": {
                  "description": "Information about the newly exploded planet",
                  "content": {
                    "application/json": {
                      "schema": {
                        "$ref": "#/components/schemas/Planet"
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  }
                }
              }
            }
          }
        },
        "requestBody": {
          "description": "Planet",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst planet = await client.planets.create();\nconsole.log(planet);"
          }
        ]
      }
    },
    "/planets/{planetId}": {
      "get": {
        "tags": [
          "Planets"
        ],
        "summary": "Get a planet",
        "description": "You'll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone.",
        "operationId": "getPlanet",
        "security": [
          {}
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/planetId"
          }
        ],
        "responses": {
          "200": {
            "description": "Planet Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst planet = await client.planets.retrieve(1);\nconsole.log(planet);"
          }
        ]
      },
      "put": {
        "tags": [
          "Planets"
        ],
        "summary": "Update a planet",
        "description": "Sometimes you make mistakes, that's fine. No worries, you can update all planets.",
        "operationId": "updatePlanet",
        "requestBody": {
          "description": "New information about the planet",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/planetId"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Planet"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst planet = await client.planets.update(1);\nconsole.log(planet);"
          }
        ]
      },
      "delete": {
        "tags": [
          "Planets"
        ],
        "summary": "Delete a planet",
        "operationId": "deletePlanet",
        "description": "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.",
        "x-scalar-stability": "experimental",
        "parameters": [
          {
            "$ref": "#/components/parameters/planetId"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.planets.delete(1);"
          }
        ]
      }
    },
    "/planets/{planetId}/image": {
      "post": {
        "tags": [
          "Planets"
        ],
        "summary": "Upload an image to a planet",
        "description": "Got a crazy good photo of a planet? Share it with the world!",
        "operationId": "uploadImage",
        "parameters": [
          {
            "$ref": "#/components/parameters/planetId"
          }
        ],
        "requestBody": {
          "description": "Image to upload",
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "image": {
                    "type": "string",
                    "format": "binary",
                    "description": "The image file to upload",
                    "examples": [
                      "@mars.jpg",
                      "@jupiter.png"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/ImageUploaded"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst uploadImage = await client.planets.uploadImage(1);\nconsole.log(uploadImage);"
          }
        ]
      }
    },
    "/celestial-bodies": {
      "post": {
        "tags": [
          "Celestial Bodies"
        ],
        "summary": "Create a celestial body",
        "operationId": "createCelestialBody",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CelestialBody"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Celestial body created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CelestialBody"
                }
              }
            }
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst celestialBody = await client.celestialBodies.create({\n  name: \"\",\n  type: \"planet\",\n});\nconsole.log(celestialBody);"
          }
        ]
      }
    },
    "/user/signup": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "summary": "Create a user",
        "description": "Time to create a user account, eh?",
        "operationId": "createUser",
        "security": [
          {}
        ],
        "requestBody": {
          "description": "User to create",
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/User"
                  },
                  {
                    "$ref": "#/components/schemas/Credentials"
                  }
                ]
              },
              "examples": {
                "Marc": {
                  "value": {
                    "name": "Marc",
                    "email": "marc@scalar.com",
                    "password": "i-love-scalar"
                  }
                },
                "Cam": {
                  "value": {
                    "name": "Cam",
                    "email": "cam@scalar.com",
                    "password": "scalar-is-cool"
                  }
                }
              }
            },
            "application/xml": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/User"
                  },
                  {
                    "$ref": "#/components/schemas/Credentials"
                  }
                ]
              },
              "examples": {
                "Marc": {
                  "value": {
                    "name": "Marc",
                    "email": "marc@scalar.com",
                    "password": "i-love-scalar"
                  }
                },
                "Cam": {
                  "value": {
                    "name": "Cam",
                    "email": "cam@scalar.com",
                    "password": "scalar-is-cool"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst user = await client.authentication.createUser();\nconsole.log(user);"
          }
        ]
      }
    },
    "/auth/token": {
      "post": {
        "tags": [
          "Authentication"
        ],
        "summary": "Get a token",
        "description": "Yeah, this is the boring security stuff. Just get your super secret token and move on.",
        "operationId": "getToken",
        "security": [
          {}
        ],
        "requestBody": {
          "description": "Credentials to authenticate a user",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Credentials"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Credentials"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Token Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Token"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Token"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createToken = await client.authentication.createToken();\nconsole.log(createToken);"
          }
        ]
      }
    },
    "/me": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "summary": "Get authenticated user",
        "description": "Find yourself they say. That's what you can do here.",
        "operationId": "getMe",
        "security": [
          {
            "basicAuth": []
          },
          {
            "oAuth2": [
              "read:account"
            ]
          },
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          },
          {
            "apiKeyQuery": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          }
        },
        "x-scalar-examples": [
          {
            "lang": "TypeScript",
            "label": "TypeScript",
            "source": "import ScalarGalaxy from \"@scalar/galaxy-sdk\";\n\nconst client = new ScalarGalaxy({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst user = await client.authentication.listMe();\nconsole.log(user);"
          }
        ]
      }
    }
  },
  "webhooks": {
    "newPlanet": {
      "post": {
        "tags": [
          "Planets"
        ],
        "requestBody": {
          "description": "Information about a new planet",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/Planet"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "JWT Bearer token authentication"
      },
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic HTTP authentication"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "API key request header"
      },
      "apiKeyQuery": {
        "type": "apiKey",
        "in": "query",
        "name": "api_key",
        "description": "API key query parameter"
      },
      "apiKeyCookie": {
        "type": "apiKey",
        "in": "cookie",
        "name": "api_key",
        "description": "API key browser cookie"
      },
      "oAuth2": {
        "type": "oauth2",
        "description": "OAuth 2.0 authentication",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://galaxy.scalar.com/oauth/authorize",
            "tokenUrl": "https://galaxy.scalar.com/oauth/token",
            "scopes": {
              "read:account": "read your account information",
              "write:planets": "modify planets in your account",
              "read:planets": "read your planets"
            },
            "refreshUrl": "",
            "x-usePkce": "SHA-256"
          },
          "clientCredentials": {
            "tokenUrl": "https://galaxy.scalar.com/oauth/token",
            "scopes": {
              "read:account": "read your account information",
              "write:planets": "modify planets in your account",
              "read:planets": "read your planets"
            },
            "refreshUrl": ""
          },
          "implicit": {
            "authorizationUrl": "https://galaxy.scalar.com/oauth/authorize",
            "scopes": {
              "read:account": "read your account information",
              "write:planets": "modify planets in your account",
              "read:planets": "read your planets"
            },
            "refreshUrl": ""
          },
          "password": {
            "tokenUrl": "https://galaxy.scalar.com/oauth/token",
            "scopes": {
              "read:account": "read your account information",
              "write:planets": "modify planets in your account",
              "read:planets": "read your planets"
            },
            "refreshUrl": ""
          }
        }
      },
      "openIdConnect": {
        "type": "openIdConnect",
        "openIdConnectUrl": "https://galaxy.scalar.com/.well-known/openid-configuration",
        "description": "OpenID Connect Authentication"
      }
    },
    "parameters": {
      "planetId": {
        "name": "planetId",
        "description": "The ID of the planet to get",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "examples": [
            1
          ]
        }
      },
      "satelliteId": {
        "name": "satelliteId",
        "description": "The ID of the satellite to get",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "examples": [
            1
          ]
        }
      },
      "limit": {
        "name": "limit",
        "description": "The number of items to return",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64",
          "default": 10
        }
      },
      "offset": {
        "name": "offset",
        "description": "The number of items to skip before starting to collect the result set",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64",
          "default": 0
        }
      }
    },
    "responses": {
      "ImageUploaded": {
        "description": "Image uploaded",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ImageUploadedMessage"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ImageUploadedMessage"
            }
          }
        }
      },
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/BadRequestError"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/BadRequestError"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ForbiddenError"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ForbiddenError"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NotFoundError"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/NotFoundError"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          }
        }
      },
      "Conflict": {
        "description": "Conflict",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Conflict"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/Conflict"
            }
          }
        }
      },
      "UnprocessableEntity": {
        "description": "Unprocessable Entity",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnprocessableEntity"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/UnprocessableEntity"
            }
          }
        }
      }
    },
    "schemas": {
      "User": {
        "description": "A user",
        "type": "object",
        "xml": {
          "name": "user"
        },
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "readOnly": true,
            "examples": [
              1
            ]
          },
          "name": {
            "type": "string",
            "examples": [
              "Marc"
            ]
          }
        }
      },
      "Credentials": {
        "description": "Credentials to authenticate a user",
        "type": "object",
        "required": [
          "email",
          "password"
        ],
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "examples": [
              "marc@scalar.com"
            ]
          },
          "password": {
            "type": "string",
            "writeOnly": true,
            "examples": [
              "i-love-scalar",
              "i-love-OSS",
              "i-love-code"
            ]
          }
        }
      },
      "Token": {
        "description": "A token to authenticate a user",
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "examples": [
              "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
            ]
          }
        }
      },
      "CelestialBody": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/Planet"
          },
          {
            "$ref": "#/components/schemas/Satellite"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "planet": "#/components/schemas/Planet",
            "satellite": "#/components/schemas/Satellite"
          }
        },
        "description": "A celestial body which can be either a planet or a satellite"
      },
      "Planet": {
        "description": "A planet in the Scalar Galaxy",
        "type": "object",
        "required": [
          "id",
          "name",
          "type"
        ],
        "additionalProperties": false,
        "xml": {
          "name": "planet"
        },
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "readOnly": true,
            "examples": [
              1
            ],
            "x-variable": "planetId"
          },
          "name": {
            "type": "string",
            "examples": [
              "Mars",
              "Jupiter",
              "HD 40307g"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "The red planet",
              "A gas giant with a great red spot"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "planet",
              "terrestrial",
              "gas_giant",
              "ice_giant",
              "dwarf",
              "super_earth"
            ],
            "x-enum-varnames": [
              "Planet",
              "Terrestrial",
              "GasGiant",
              "IceGiant",
              "Dwarf",
              "SuperEarth"
            ],
            "x-enum-descriptions": {
              "planet": "Discriminator value for Planet schema",
              "terrestrial": "Rocky planets with solid surfaces, like Earth and Mars",
              "gas_giant": "Large planets composed mainly of hydrogen and helium, like Jupiter and Saturn",
              "ice_giant": "Planets composed of water, ammonia, and methane ices, like Uranus and Neptune",
              "dwarf": "Small planetary bodies that don't meet full planet criteria, like Pluto",
              "super_earth": "Rocky planets larger than Earth but smaller than gas giants"
            },
            "examples": [
              "terrestrial"
            ]
          },
          "habitabilityIndex": {
            "type": "number",
            "format": "float",
            "minimum": 0,
            "maximum": 1,
            "description": "A score from 0 to 1 indicating potential habitability",
            "examples": [
              0.68
            ]
          },
          "physicalProperties": {
            "type": "object",
            "additionalProperties": {
              "x-additionalPropertiesName": "measurement",
              "type": "number",
              "format": "float",
              "description": "Additional physical measurements for the planet"
            },
            "properties": {
              "mass": {
                "type": "number",
                "format": "float",
                "exclusiveMinimum": 0,
                "description": "Mass in Earth masses (must be greater than 0)",
                "examples": [
                  0.107
                ]
              },
              "radius": {
                "type": "number",
                "format": "float",
                "exclusiveMinimum": 0,
                "description": "Radius in Earth radii (must be greater than 0)",
                "examples": [
                  0.532
                ]
              },
              "gravity": {
                "type": "number",
                "format": "float",
                "description": "Surface gravity in Earth g",
                "examples": [
                  0.378
                ]
              },
              "temperature": {
                "type": "object",
                "additionalProperties": {
                  "x-additionalPropertiesName": "temperatureMetric",
                  "type": "number",
                  "format": "float",
                  "description": "Additional temperature-related measurements in Kelvin"
                },
                "properties": {
                  "min": {
                    "type": "number",
                    "format": "float",
                    "description": "Minimum temperature in Kelvin",
                    "examples": [
                      130
                    ]
                  },
                  "max": {
                    "type": "number",
                    "format": "float",
                    "description": "Maximum temperature in Kelvin",
                    "examples": [
                      308
                    ]
                  },
                  "average": {
                    "type": "number",
                    "format": "float",
                    "description": "Average temperature in Kelvin",
                    "examples": [
                      210
                    ]
                  }
                }
              }
            }
          },
          "atmosphere": {
            "type": "array",
            "description": "Atmospheric composition",
            "items": {
              "type": "object",
              "additionalProperties": {
                "x-additionalPropertiesName": "atmosphericData",
                "type": "string",
                "description": "Additional atmospheric composition data"
              },
              "properties": {
                "compound": {
                  "type": "string",
                  "examples": [
                    "CO2",
                    "N2"
                  ]
                },
                "percentage": {
                  "type": "number",
                  "format": "float",
                  "exclusiveMaximum": 100,
                  "examples": [
                    95.3
                  ]
                }
              }
            }
          },
          "discoveredAt": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "1610-01-07T00:00:00Z"
            ]
          },
          "image": {
            "type": "string",
            "nullable": true,
            "examples": [
              "https://cdn.scalar.com/photos/mars.jpg"
            ]
          },
          "satellites": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Satellite"
            }
          },
          "creator": {
            "$ref": "#/components/schemas/User"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "solar-system",
                "rocky",
                "explored"
              ]
            ]
          },
          "lastUpdated": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "examples": [
              "2024-01-15T14:30:00Z"
            ]
          },
          "successCallbackUrl": {
            "type": "string",
            "format": "uri",
            "description": "URL which gets invoked upon a successful operation",
            "examples": [
              "https://example.com/webhook"
            ]
          },
          "failureCallbackUrl": {
            "type": "string",
            "format": "uri",
            "description": "URL which gets invoked upon a failed operation",
            "examples": [
              "https://example.com/webhook"
            ]
          }
        }
      },
      "Satellite": {
        "description": "Every satellite in the Scalar Galaxy",
        "type": "object",
        "required": [
          "name",
          "type"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "readOnly": true,
            "examples": [
              1
            ]
          },
          "name": {
            "type": "string",
            "examples": [
              "Phobos"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "examples": [
              "Phobos is the larger and innermost of the two moons of Mars."
            ]
          },
          "diameter": {
            "type": "number",
            "format": "float",
            "description": "Diameter in kilometers",
            "examples": [
              22.2
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "satellite",
              "moon",
              "asteroid",
              "comet"
            ],
            "x-enum-varnames": [
              "Satellite",
              "Moon",
              "Asteroid",
              "Comet"
            ],
            "x-enum-descriptions": {
              "satellite": "Discriminator value for Satellite schema",
              "moon": "Natural satellites that orbit planets",
              "asteroid": "Rocky objects that orbit the sun, typically found in the asteroid belt",
              "comet": "Icy bodies that release gas when approaching the sun, creating visible tails"
            },
            "examples": [
              "moon"
            ]
          },
          "orbit": {
            "type": "object",
            "properties": {
              "planetId": {
                "type": "integer",
                "format": "int64",
                "description": "The ID of the planet this satellite orbits",
                "examples": [
                  1
                ]
              },
              "orbitalPeriod": {
                "type": "number",
                "format": "float",
                "description": "Orbital period in Earth days",
                "examples": [
                  0.319
                ]
              },
              "distance": {
                "type": "number",
                "format": "float",
                "description": "Average distance from the planet in kilometers",
                "examples": [
                  9376
                ]
              }
            }
          }
        }
      },
      "PaginatedResource": {
        "description": "A paginated resource",
        "type": "object",
        "properties": {
          "meta": {
            "type": "object",
            "properties": {
              "limit": {
                "type": "integer",
                "format": "int64",
                "examples": [
                  10
                ]
              },
              "offset": {
                "type": "integer",
                "format": "int64",
                "examples": [
                  0
                ]
              },
              "total": {
                "type": "integer",
                "format": "int64",
                "examples": [
                  100
                ]
              },
              "next": {
                "type": [
                  "string",
                  "null"
                ],
                "examples": [
                  "/planets?limit=10&offset=10"
                ]
              }
            }
          }
        }
      },
      "ImageUploadedMessage": {
        "x-scalar-ignore": true,
        "description": "Message about an image upload",
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "examples": [
              "Image uploaded successfully"
            ]
          },
          "imageUrl": {
            "type": "string",
            "description": "The URL where the uploaded image can be accessed",
            "examples": [
              "https://cdn.scalar.com/images/8f47c132-9d1f-4f83-b5a4-91db5ee757ab.jpg"
            ]
          },
          "uploadedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the image was uploaded",
            "examples": [
              "2024-01-15T14:30:00Z"
            ]
          },
          "fileSize": {
            "type": "integer",
            "description": "Size of the uploaded image in bytes",
            "examples": [
              1048576
            ]
          },
          "mimeType": {
            "type": "string",
            "description": "The content type of the uploaded image",
            "examples": [
              "image/jpeg",
              "image/png"
            ]
          }
        }
      },
      "BadRequestError": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/bad-request"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Bad Request"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              400
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "The request was invalid."
            ]
          }
        }
      },
      "ForbiddenError": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/forbidden"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Forbidden"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              403
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "You are not authorized to access this resource."
            ]
          }
        }
      },
      "NotFoundError": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/not-found"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Not Found"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              404
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "The resource you are trying to access does not exist."
            ]
          }
        }
      },
      "UnauthorizedError": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/not-found"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Unauthorized"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              401
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "You are not authorized to access this resource."
            ]
          }
        }
      },
      "Conflict": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/conflict"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Conflict"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              409
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "The resource you are trying to access is in conflict."
            ]
          }
        }
      },
      "UnprocessableEntity": {
        "x-scalar-ignore": true,
        "description": "RFC 7807 (https://datatracker.ietf.org/doc/html/rfc7807)",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "examples": [
              "https://example.com/errors/unprocessable-entity"
            ]
          },
          "title": {
            "type": "string",
            "examples": [
              "Unprocessable Entity"
            ]
          },
          "status": {
            "type": "integer",
            "format": "int64",
            "examples": [
              422
            ]
          },
          "detail": {
            "type": "string",
            "examples": [
              "The request was invalid."
            ]
          }
        }
      }
    }
  }
}