Linting Metrics for API Specification

The Linting Metrics tab helps publishers validate OpenAPI specification quality before sharing APIs with consumers. It highlights specification issues that can impact rendering, consistency, and API usability.

To review linting metrics:

1. From the Trimble Cloud Console left menu, select APIs.
2. Select the API version to edit and open the API Specification tab.
3. Upload or update the OpenAPI specification.
4. Select the Linting Metrics tab.
5. Review the listed linting results and prioritize items marked as errors first, then warnings.
6. Update your API specification file to resolve the issues.
7. Re-upload the specification and verify that linting results improve.

Use linting results as a quality gate before publishing changes to production-facing documentation.

To understand and resolve linting findings in detail, use the OpenAPI Spectral Rules documentation. It explains each rule, what it validates, and how to interpret failures against Trimble API standards.

For teams that want earlier feedback, the openapi-spectral-rules repository can be used outside the UI:

• Run checks locally while authoring or updating API specifications.
• Add the same rule set to CI pipelines to catch issues before publishing.
• Keep review criteria consistent between local validation, CI, and API Cloud linting metrics.

You can also bring linting into the earliest stages of development using AI-assisted workflows in Cursor or GitHub Copilot:

• API standards linting skill: Validate OpenAPI against Trimble standards using Cursor or GitHub Copilot.