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!

Contact

Marc from Scalar/marc@scalar.com

License

MIT

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

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

It’s easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one.

Parameters

Query Parameters

limit

The number of items to return

Typeinteger

formatint64

default10

offset

The number of items to skip before starting to collect the result set

Typeinteger

formatint64

default0

Responses

OK

Content-Type

{

"data": [

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

],

"meta": {

"limit": 10,

"offset": 0,

"total": 100,

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

}

}

GET

/planets

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: createPlanet

Create a planet

Planets

POST

/planets

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

Responses

Created

Content-Type

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

POST

/planets

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: getPlanet

Get a planet

Planets

GET

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

You’ll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone.

Parameters

Path Parameters

planetId*

The ID of the planet to get

Typeinteger

Required

Example1

formatint64

Responses

Planet Found

Content-Type

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

GET

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: updatePlanet

Update a planet

Planets

PUT

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

Path Parameters

planetId*

The ID of the planet to get

Typeinteger

Required

Example1

formatint64

Request Body

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

Responses

OK

Content-Type

{

"id": 1,

"name": "Mars",

"description": "The red planet",

"image": "https://cdn.scalar.com/photos/mars.jpg",

"creator": {

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

}

PUT

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: deletePlanet

Delete a planet

Planets

DELETE

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

Path Parameters

planetId*

The ID of the planet to get

Typeinteger

Required

Example1

formatint64

Responses

No Content

DELETE

/planets/{planetId}

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: uploadImage

Upload an image to a planet

Planets

POST

/planets/{planetId}/image

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

Path Parameters

planetId*

The ID of the planet to get

Typeinteger

Required

Example1

formatint64

Request Body

{

"image": "string"

}

Responses

Image uploaded

Content-Type

{

"message": "Image uploaded successfully",

"imageUrl": "https://cdn.scalar.com/images/8f47c132-9d1f-4f83-b5a4-91db5ee757ab.jpg",

"uploadedAt": {

},

"fileSize": 1048576,

"mimeType": "image/jpeg"

}

POST

/planets/{planetId}/image

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

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

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Time to create a user account, eh?

Request Body

{

"name": "Marc",

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

"password": "i-love-scalar"

}

Responses

Created

Content-Type

{

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

POST

/user/signup

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: getToken

Get a token

Authentication

POST

/auth/token

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

Request Body

{

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

"password": "i-love-scalar"

}

Responses

Token Created

Content-Type

{

"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

}

POST

/auth/token

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

ID: getMe

Get authenticated user

Authentication

GET

/me

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

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

{

"id": 1,

"name": "Marc",

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

"password": "i-love-scalar"

}

GET

/me

Serverhttps://galaxy.scalar.com{protocol}://void.scalar.com/{path}

Samples

---

Powered by VitePress OpenAPI