typespec-openapi

Specification documents and API documentation for polyproto.

API documentation built with TypeSpec.

Pre-compiled OpenAPI schema(s)

Find the pre-compiled OpenAPI v3.1 schema file(s) in the /build directory. The schema is automatically built and deployed to the main branch on every push to the main branch.

Contributing

The best way to contribute is to open an issue if you find any problems with the documentation. Creating an issue is generally the best way to contribute to any open source project. Issues allow for an exchange between contributors and maintainers to discuss the viability of implementing an issue, usually minimizing frustration.

You should also read our Code of Conduct and Contributing Guidelines before contributing.

Setting up a development environment

You will need the following things installed on your computer:

• Node.js >= 20
• npm. I personally prefer pnpm, but have found it to not work with TypeSpec. Maybe this is a me-issue, but I recommend npm for best compatibility nonetheless.
• git
• TypeSpec - install it globally with npm install -g @typespec/compiler

1. Navigate to the /polyproto directory.
2. Select the project you want to compile. In this example, we are compiling the core project. Navigate to that directory.
3. Run tsp install to install the dependencies.
4. Run tsp compile . to compile the project or tsp compile --watch . to automatically recompile the project when you save a file.
5. The compiled OpenAPI3 schema will be in the $PROJECT/tsp-output/@typespec/openapi3 directory.