Orbital

Your workspace

Pulling API specs from Disk

Orbital can read schema and taxonomy definitions direct from local disk

When you’re getting started, it’s useful to store your core taxonomy, existing API specs (such as OpenApi or Protobuf), or database definitions in a local disk repo, making it quick and easy to get going.

Adding a file repository using the UI

Open Projects in the sidebar and click Add project (or go straight to /projects/project-import). Choose Add projects from disk, then Add from disk.

Add project - pick how to add a project

Add project - pick how to add a project

Add project - pick how to add a project

If you don’t have a project yet, choose Start with an empty project instead: Orbital creates a blank Taxi project for you on the server, which you can edit from the Code editor.

Completing the read-from-disk form

Say where your files are:

  • Upload files to the server - upload a zip of your Taxi project (including its taxi.conf). Orbital unpacks it into the workspace on the server.
  • My files are already on the server - provide the path on the server to the taxi.conf file. If Orbital is running in Docker, this is a path inside the container, so enter it relative to your mounted volume (eg., /opt/service/workspace).
Uploading a zipped Taxi project

Uploading a zipped Taxi project

Uploading a zipped Taxi project
Reading a project that's already on the server

Reading a project that's already on the server

Reading a project that's already on the server

Project type is either a full Taxi project, or an individual API spec. Leave Enable edits ticked if you want to edit the project through the Orbital UI.

Adding a file repository through config

The schema repositories that Orbital is connected to can be configured through a HOCON file, which by default is called workspace.conf

file {    projects=[        {            // Optional (defaults to false). Indicates if the project can receive edits through the UI            isEditable=true            // Path to the folder containing a taxi.conf file.            path="/opt/var/orbital/schemas/taxi"        }    ]
    // Optional - WATCH or POLL    changeDetectionMethod=WATCH
    // Optional - Should the version of the project be incremented when the local disk changes?    // False is a safe setting here    incrementVersionOnChange=false
    // Optional.  If polling, define the frequency.    pollFrequency=PT5S
     // Optional.  Defines the frequency that updates trigger recompilation.     // Useful if you're locally editing a schema, and don't want to trigger     // lots of recompilation    recompilationFrequencyMillis=PT3S}