https://github.com/tilt-dev/api.tilt.dev
Reference docs for the Tilt API
https://github.com/tilt-dev/api.tilt.dev
Last synced: 3 months ago
JSON representation
Reference docs for the Tilt API
- Host: GitHub
- URL: https://github.com/tilt-dev/api.tilt.dev
- Owner: tilt-dev
- License: apache-2.0
- Created: 2021-04-08T16:42:38.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T06:05:16.000Z (about 3 years ago)
- Last Synced: 2025-01-02T08:15:08.296Z (over 1 year ago)
- Language: Starlark
- Size: 411 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# api.tilt.dev
Reference docs for the Tilt API
https://api.tilt.dev/
## What
The future of Tilt is a simple model consisting of very few types of building
blocks, and a mix of uniformity and versatility whereby using the same simple
elements one can build complex systems and different types of functionality.
The [Tilt apiserver](https://github.com/tilt-dev/tilt-apiserver) is the base
layer of that model.
This repository generates the API that the current Tilt server supports.
## How
To run api.tilt.dev locally, run:
```
tilt up
```
Tilt will bring up the API in a container.
Commits to the main branch will automatically deploy to api.tilt.dev on Netlify.
## Generating the API
The Tilt API server generates openapi-spec/swagger.json, a complete specification
of Tilt's API objects.
The Kubernetes project automates this generation with this Bash script:
https://github.com/kubernetes/kubernetes/blob/master/hack/update-openapi-spec.sh
Currently we generate this by running:
```
tilt dump openapi > openapi-spec/swagger.json
```
Then we generate markdown for the api docs with:
```
make gendocs
```
This uses Kubernetes' doc generation code to generate pages for each API type.
## Credits
Heavily inspired by https://github.com/kubernetes-sigs/reference-docs
Copyright 2016 The Kubernetes Authors.
Modifications Copyright 2021 Windmill Engineering
Licensed under [the Apache License, Version 2.0](LICENSE)