Repository files navigation

Specification documents and API documentation forpolyproto,polyproto-chat andpolyproto-mls.

API documentation built withTypeSpec.

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

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 ourCode of Conduct andContributing Guidelines before contributing.

You will need the following things installed on your computer:

• Node.js >= 20
• npm. I personally preferpnpm, but have found it tonot work with TypeSpec. Maybe this isa me-issue, but I recommendnpm for best compatibility nonetheless.
• git
• TypeSpec - install it globally withnpm install -g @typespec/compiler

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