Publish API documentation

Publishing API documentation helps consumers understand your API contract and usage. OpenAPI specification guidance follows Trimble API Standards.

You can publish documentation while creating an API version, or later by editing the API specification for an existing version.

To publish documentation:

1. From the Trimble Cloud Console left menu, select Apis.
2. On the APIs page, select the API Version to edit. The page displays API details.
3. Open the API Specification tab.
4. For first-time documentation setup, select Upload API Specification to start the upload flow.
5. In the upload dialog, choose the OpenAPI specification file and select upload.
6. In the uploader screen, complete the upload for the selected API specification.
7. After the upload is complete, the openapi spec will be rendered:
   • API Reference: Verify the rendered API reference content.
   • Linting Metrics: Review specification linting issues.
   • Qualitative Metrics: Review documentation quality insights.
8. The OpenApi specification file of the api will be shown as part of the product for the users.