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
External Documentation
DocumentationServers
Create a planet
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
JWT Bearer token authentication
Basic HTTP authentication
API key query parameter
API key request header
API key browser cookie
OAuth 2.0 authentication
authorizationCode Flow
https://galaxy.scalar.com/oauth/authorize
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
clientCredentials Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
implicit Flow
https://galaxy.scalar.com/oauth/authorize
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
password Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
OpenID Connect Authentication
Request Body
Responses
Update a planet
Sometimes you make mistakes, that's fine. No worries, you can update all planets.
Authorizations
JWT Bearer token authentication
Basic HTTP authentication
API key query parameter
API key request header
API key browser cookie
OAuth 2.0 authentication
authorizationCode Flow
https://galaxy.scalar.com/oauth/authorize
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
clientCredentials Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
implicit Flow
https://galaxy.scalar.com/oauth/authorize
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
password Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
OpenID Connect Authentication
Parameters
Request Body
Responses
Delete a planet
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
JWT Bearer token authentication
Basic HTTP authentication
API key query parameter
API key request header
API key browser cookie
OAuth 2.0 authentication
authorizationCode Flow
https://galaxy.scalar.com/oauth/authorize
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
clientCredentials Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
implicit Flow
https://galaxy.scalar.com/oauth/authorize
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
password Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
OpenID Connect Authentication
Parameters
Responses
Upload an image to a planet
Got a crazy good photo of a planet? Share it with the world!
Authorizations
JWT Bearer token authentication
Basic HTTP authentication
API key query parameter
API key request header
API key browser cookie
OAuth 2.0 authentication
authorizationCode Flow
https://galaxy.scalar.com/oauth/authorize
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
clientCredentials Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
implicit Flow
https://galaxy.scalar.com/oauth/authorize
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
password Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
OpenID Connect Authentication
Parameters
Request Body
Responses
Authentication
Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself.
Operations
Get authenticated user
Find yourself they say. That’s what you can do here.
Authorizations
Basic HTTP authentication
OAuth 2.0 authentication
authorizationCode Flow
https://galaxy.scalar.com/oauth/authorize
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
clientCredentials Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
implicit Flow
https://galaxy.scalar.com/oauth/authorize
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
password Flow
https://galaxy.scalar.com/oauth/token
read:account
read your account informationwrite:planets
modify planets in your accountread:planets
read your planets
JWT Bearer token authentication
API key request header
API key query parameter