Repository files navigation

Specification documents and API documentation for the polyproto federated messaging protocol.

Documentation built with mkdocs-material and python3.12

API documentation built withTypeSpec.

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

The/docs folder has the specification documents for the polyproto protocol.

The/snippets folder has snippets of text used in many places in the documentation. This is to ensure consistency across the documentation. Error messages appearing in many places are also stored in the/snippets/errors folder.

API documentation in form ofTypeSpec files can be found in the/api directory.TypeSpec can compile to OpenAPI3, JSON Schema and Protobuf. Our TypeSpec project is targeting OpenAPI3output. Read the TypeSpec documentation for information on how to compile TypeSpec or use a pre-compiledversion of the OpenAPI schema if you'd like.

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:

• python3.12
• pip
• Any sort of python virtual environment manager - usevenv if in doubt
• git

Optionally, you can installvale for spell-/grammar checking.

Usepip install -r requirements.txt to install the required dependencies, andmkdocs build ormkdocs serve to build the project or serve it on localhost.

You will need the following things installed on your computer:

• Node.js >= 20
• npm,pnpm oryarn
• git
• TypeSpec - install it globally withnpm install -g @typespec/compiler

1. Navigate to the/api/src 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.