v1.0.0

Scalar Galaxy

The Scalar Galaxy is an example OpenAPI specification to test OpenAPI tools and libraries. It’s a fictional universe with fictional planets and fictional data. Get all the data for all planets.

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, chances are we’re supporting it, too. You can even create internal links to reference endpoints.

Examples

Blockquotes

I love OpenAPI. <3

Tables

Feature	Availability
Markdown Support	✓

Accordion

<details>
  <summary>Using Details Tags</summary>
  <p>HTML Example</p>
</details>

Images

Yes, there’s support for images, too!

Alerts

[!tip]
You can now use markdown alerts in your descriptions.

Contact

Marc from Scalar/marc@scalar.com

License

MIT

External Documentation

Documentation

Servers

https://galaxy.scalar.com

{protocol}://void.scalar.com/{path}Responds with your request data

---

Planets

Everything about planets

Operations

GET/planetsPOST/planetsGET/planets/{planetId}PUT/planets/{planetId}DELETE/planets/{planetId}POST/planets/{planetId}/image

---

ID: getAllData

Get all planets

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.

Parameters

Responses

OK

Content-Type

{

"data": [

],

"meta": {

"limit": 10,

"offset": 0,

"total": 100,

"next": "/planets?limit=10&offset=10"

}

}

GET

/planets

Samples

cURL

curl https://galaxy.scalar.com/planets \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://galaxy.scalar.com/planets', {
  headers: {
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())

---

ID: createPlanet

Create a planet

Planets

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?

Authorizations

bearerAuth

JWT Bearer token authentication

TypeHTTP (bearer)

or

basicAuth

Basic HTTP authentication

TypeHTTP (basic)

or

apiKeyQuery

API key query parameter

TypeAPI Key (query: api_key)

or

apiKeyHeader

API key request header

TypeAPI Key (header: X-API-Key)

or

apiKeyCookie

API key browser cookie

TypeAPI Key (cookie: api_key)

or

oAuth2

OAuth 2.0 authentication

authorizationCode Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

clientCredentials Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

implicit Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

password Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

or

openIdConnect

OpenID Connect Authentication

TypeOpenID Connect (https://galaxy.scalar.com/.well-known/openid-configuration)

Request Body

"string"

Responses

Created

Content-Type

"string"

POST

/planets

Samples

cURL

JavaScript

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "string",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())

---

ID: getPlanet

Get a planet

Planets

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.

Parameters

Responses

Planet Found

Content-Type

"string"

GET

/planets/{planetId}

Samples

cURL

curl 'https://galaxy.scalar.com/planets/%7BplanetId%7D' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://galaxy.scalar.com/planets/%7BplanetId%7D', {
  headers: {
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets/%7BplanetId%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets/%7BplanetId%7D"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())

---

ID: updatePlanet

Update a planet

Planets

PUT

/planets/{planetId}

Sometimes you make mistakes, that's fine. No worries, you can update all planets.

Authorizations

bearerAuth

JWT Bearer token authentication

TypeHTTP (bearer)

or

basicAuth

Basic HTTP authentication

TypeHTTP (basic)

or

apiKeyQuery

API key query parameter

TypeAPI Key (query: api_key)

or

apiKeyHeader

API key request header

TypeAPI Key (header: X-API-Key)

or

apiKeyCookie

API key browser cookie

TypeAPI Key (cookie: api_key)

or

oAuth2

OAuth 2.0 authentication

authorizationCode Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

clientCredentials Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

implicit Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

password Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

or

openIdConnect

OpenID Connect Authentication

TypeOpenID Connect (https://galaxy.scalar.com/.well-known/openid-configuration)

Parameters

Request Body

"string"

Responses

OK

Content-Type

"string"

PUT

/planets/{planetId}

Samples

cURL

JavaScript

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets/%7BplanetId%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "string",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets/%7BplanetId%7D"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.put(url, headers=headers)

print(response.json())

---

ID: deletePlanet

Delete a planet

Planets

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.

Authorizations

bearerAuth

JWT Bearer token authentication

TypeHTTP (bearer)

or

basicAuth

Basic HTTP authentication

TypeHTTP (basic)

or

apiKeyQuery

API key query parameter

TypeAPI Key (query: api_key)

or

apiKeyHeader

API key request header

TypeAPI Key (header: X-API-Key)

or

apiKeyCookie

API key browser cookie

TypeAPI Key (cookie: api_key)

or

oAuth2

OAuth 2.0 authentication

authorizationCode Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

clientCredentials Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

implicit Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

password Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

or

openIdConnect

OpenID Connect Authentication

TypeOpenID Connect (https://galaxy.scalar.com/.well-known/openid-configuration)

Parameters

Responses

No Content

DELETE

/planets/{planetId}

Samples

cURL

curl 'https://galaxy.scalar.com/planets/%7BplanetId%7D' \
  --request DELETE \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://galaxy.scalar.com/planets/%7BplanetId%7D', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets/%7BplanetId%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets/%7BplanetId%7D"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)

print(response.json())

---

ID: uploadImage

Upload an image to a planet

Planets

POST

/planets/{planetId}/image

Got a crazy good photo of a planet? Share it with the world!

Authorizations

bearerAuth

JWT Bearer token authentication

TypeHTTP (bearer)

or

basicAuth

Basic HTTP authentication

TypeHTTP (basic)

or

apiKeyQuery

API key query parameter

TypeAPI Key (query: api_key)

or

apiKeyHeader

API key request header

TypeAPI Key (header: X-API-Key)

or

apiKeyCookie

API key browser cookie

TypeAPI Key (cookie: api_key)

or

oAuth2

OAuth 2.0 authentication

authorizationCode Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

clientCredentials Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

implicit Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

password Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

or

openIdConnect

OpenID Connect Authentication

TypeOpenID Connect (https://galaxy.scalar.com/.well-known/openid-configuration)

Parameters

Request Body

{

"image": "@mars.jpg"

}

Responses

POST

/planets/{planetId}/image

Samples

cURL

curl 'https://galaxy.scalar.com/planets/%7BplanetId%7D/image' \
  --request POST \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://galaxy.scalar.com/planets/%7BplanetId%7D/image', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/planets/%7BplanetId%7D/image",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/planets/%7BplanetId%7D/image"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())

---

Authentication

Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself.

Operations

POST/user/signupPOST/auth/tokenGET/me

---

ID: createUser

Create a user

Authentication

POST

/user/signup

Time to create a user account, eh?

Request Body

{

"name": "Marc",

"email": "marc@scalar.com",

"password": "i-love-scalar"

}

Responses

Created

Content-Type

"string"

POST

/user/signup

Samples

cURL

curl https://galaxy.scalar.com/user/signup \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "Marc",
  "email": "marc@scalar.com",
  "password": "i-love-scalar"
}'

JavaScript

fetch('https://galaxy.scalar.com/user/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    id: 1,
    name: 'Marc',
    email: 'marc@scalar.com',
    password: 'i-love-scalar'
  })
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/user/signup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 1,
    'name' => 'Marc',
    'email' => 'marc@scalar.com',
    'password' => 'i-love-scalar'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/user/signup"

payload = {
    "id": 1,
    "name": "Marc",
    "email": "marc@scalar.com",
    "password": "i-love-scalar"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

---

ID: getToken

Get a token

Authentication

POST

/auth/token

Yeah, this is the boring security stuff. Just get your super secret token and move on.

Request Body

"string"

Responses

Token Created

Content-Type

"string"

POST

/auth/token

Samples

cURL

JavaScript

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/auth/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "string",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/auth/token"

headers = {"Content-Type": "application/json"}

response = requests.post(url, headers=headers)

print(response.json())

---

ID: getMe

Get authenticated user

Authentication

GET

/me

Find yourself they say. That’s what you can do here.

Authorizations

basicAuth

Basic HTTP authentication

TypeHTTP (basic)

or

oAuth2

OAuth 2.0 authentication

authorizationCode Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

clientCredentials Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

implicit Flow

Authorization URLhttps://galaxy.scalar.com/oauth/authorize

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

password Flow

Token URLhttps://galaxy.scalar.com/oauth/token

Scopes:

• read:accountread your account information
• write:planetsmodify planets in your account
• read:planetsread your planets

or

bearerAuth

JWT Bearer token authentication

TypeHTTP (bearer)

or

apiKeyHeader

API key request header

TypeAPI Key (header: X-API-Key)

or

apiKeyQuery

API key query parameter

TypeAPI Key (query: api_key)

Responses

OK

Content-Type

"string"

GET

/me

Samples

cURL

curl https://galaxy.scalar.com/me \
  --header 'Authorization: Basic basicAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://galaxy.scalar.com/me', {
  headers: {
    Authorization: 'Basic basicAuth',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://galaxy.scalar.com/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic basicAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://galaxy.scalar.com/me"

headers = {
    "Authorization": "Basic basicAuth",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())

---

Powered by VitePress OpenAPI