Skip to main content

OpenAPI And Tooling

OpenAPI Availability​

Fieldkit exposes OpenAPI specs for both customer-facing and first-party automation APIs.

  • Public API OpenAPI JSON: https://api.fieldkit.cc/v3/api-docs/public-v1
  • Agent Actions OpenAPI JSON: https://api.fieldkit.cc/v3/api-docs/agent-actions
  • Swagger UI: https://api.fieldkit.cc/swagger-ui.html

Generated snapshots in this repo:

  • apps/developer-docs/static/openapi/public-v1.json
  • apps/developer-docs/static/openapi/agent-actions.json

Keeping Docs In Sync​

OpenAPI snapshots are generated by backend tests so docs drift is caught early.

Run:

npm run sync:openapi-docs

Prerequisite: use the backend-supported Java runtime (Java 17+).

This runs ./gradlew syncOpenApiDocs in apps/backend, which:

  1. validates the OpenAPI groups and required paths in tests
  2. rewrites the JSON snapshots under apps/developer-docs/static/openapi/