Fumadocs

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?

Authorization

headerAuthorizationBearer <token>

JWT Bearer token authentication

Request Body

Planet

  1. body

A planet in the Scalar Galaxy

id*integer
Formatint64
name*string
description?string|null
type?string
Value in"terrestrial""gas_giant""ice_giant""dwarf""super_earth"
habitabilityIndex?number

A score from 0 to 1 indicating potential habitability

Formatfloat
Range0 <= value <= 1
physicalProperties?
atmosphere?array<>

Atmospheric composition

discoveredAt?string
Formatdate-time
image?string|null
satellites?array<>
creator?

A user

tags?array<string>
successCallbackUrl?string

URL which gets invoked upon a successful operation

Formaturi
failureCallbackUrl?string

URL which gets invoked upon a failed operation

Formaturi

Response Body

Created

  1. response

A planet in the Scalar Galaxy

id*integer
Formatint64
name*string
description?string|null
type?string
Value in"terrestrial""gas_giant""ice_giant""dwarf""super_earth"
habitabilityIndex?number

A score from 0 to 1 indicating potential habitability

Formatfloat
Range0 <= value <= 1
physicalProperties?
atmosphere?array<>

Atmospheric composition

discoveredAt?string
Formatdate-time
image?string|null
satellites?array<>
creator?

A user

tags?array<string>
lastUpdated?string
Formatdate-time
successCallbackUrl?string

URL which gets invoked upon a successful operation

Formaturi
failureCallbackUrl?string

URL which gets invoked upon a failed operation

Formaturi

Callbacks

Example Request
curl -X POST 'https://galaxy.scalar.com/planets' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 1,
  "name": "Mars"
}'
Example Response
{
  "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:00Z",
  "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:00Z",
  "successCallbackUrl": "https://example.com/webhook",
  "failureCallbackUrl": "https://example.com/webhook"
}