Your workspace
Projects
An overview of projects in Orbital
A Taxi project contains a taxi.conf file, and a collection of files saved with a .taxi extension
We document projects in depth over on the Taxi site.
Adding a project
There are various ways to add projects into an Orbital workspace.
In the UI, open Projects in the sidebar and click Add project. You can start from a ready-made demo project, connect a Git repository, create an empty project, or add a project that’s on disk:
Each of these is covered in its own guide, along with the equivalent configuration:
README.md file
If a README.md file is supplied at the root of the project, it will be read by Orbital and displayed on the project’s Readme tab (select the project on the Projects page).
Github flavored markdown is supported, along with some special code snippets.
Taxi snippets
Standard Taxi can be included by using the following syntax:
```taxi@DatabaseService(connection = "my-postgres-db")service MyPostgresService {
// table declares read operations, such as querying table ticketSales : VenueTicketSalesRecord[] // An upsert operation, for performing upsert queries @UpsertOperation write operation saveTicketSalesRecord(VenueTicketSalesRecord):VenueTicketSalesRecord}```TaxiQL snippets
TaxiQL queries can be included like this. They’re rendered with a Run query button, so readers can run them straight from the README:
```taxiqlfind { VenueTicketSales[] }call MyPostgresService::saveTicketSalesRecord```Schema diagram snippets
Schema diagrams can be included with the following syntax:
```schemaDiagram{ "members" : { "TicketsS3Bucket" : {}, "VenueTicketSales" : {}, "TicketPricesApi" : {} }}```This will produce the following interactive component within the README in Orbital:
Combining Taxi and other API specs in a single project
Orbital supports extensions to Taxi project files which allow reading other API specs (OpenAPI, Avro) directly from within your Taxi project.
This works well for teams that prefer to keep their API specs and Taxi together.
See the detailed configuration guides: