Developer portal and living documentation

Version française : ../../fr/guides/developer-portal.md

The Developer portal section of the portal gives a developer what the platform provides to an application or an agent, the contracts and their live validation, the API reference, SDK snippets and the brick catalog. Every page reads the Control Plane: nothing is copied by hand. Who: developers. Screen code: portal/src/screens/developer.tsx.

Sources

The portal reads the contracts (GET /v1/contracts) and validates them live (POST /v1/contracts/{name}/validate) in portal/src/screens/developer.tsx, and links to the published OpenAPI schema. Nothing is copied by hand: docs/api/openapi-v1.json and docs/sdks/cli-reference.md are generated and checked in CI.

enterprise-ai docs --write cli-reference.md

Page	What it shows	Source
Developer portal > Developer kit	the resources the platform gives an application, an agent or a project, their state, the environment file and SDK snippets	GET /v1/developer/kit
Developer portal > Contracts	the JSON Schemas of the v1 contracts and a validation tool	GET /v1/contracts, POST /v1/contracts/{name}/validate
Developer portal > API reference	links to /docs, /redoc and /openapi.json of the Control Plane and its version	GET /v1/meta
Developer portal > SDK quickstarts	install line and quickstart of each SDK	snippets of the portal
Developer portal > Brick catalog	the building blocks of the platform	GET /v1/catalog/bricks
Developer portal > Roadmap	the delivery phases of the platform	the portal

Procedures

1. Get the kit of your application or agent. The kit lists each resource the platform gives you (LLM gateway, identity, permissions and policies, data protection, AI traceability, business tools, document access, SDK, quality and security tests) with its value, its state and the action that fixes it.

   Screen: Developer portal > Developer kit, choose an application, an agent or a project.

   Expected result: each row is Ready; the summary shows how many resources are ready.

   If it fails: a row Not configured or Service not installed gives the page that fixes it; an empty list means no application or agent is registered yet (register one in Agents > Applications or Agents > Registry).

2. Download the environment file. It holds the variables of your application for the gateway, OIDC, DLP, MCP gateway, OTLP and Opik; it never holds a secret.

   Screen: Developer kit, environment file tab, Download .env.

   Expected result: a .env file; paste the project key in it yourself.

   If it fails: create a project key first (the key is shown once at creation).

3. Validate a document against a contract. You check a manifest or a context before sending it, with the same schema the Control Plane applies.

   Screen: Developer portal > Contracts, choose the contract, paste the JSON document and validate it.

   Expected result: the document is valid, or each error is listed with its path.

   If it fails: an invalid JSON text is reported before any call; fix the syntax.

4. Open the API reference. Screen: Developer portal > API reference. See the API Reference for the two APIs of the platform.

   Expected result: the interactive console and the reference of your Control Plane open in a new tab.

   If it fails: the documentation is disabled on that server; read docs/api/control-plane-v1.md instead.

5. Regenerate the CLI reference (contributors). It keeps docs/sdks/cli-reference.md equal to the real CLI.

   Expected result: enterprise-ai docs --write cli-reference.md writes the file; the CI check passes.

   If it fails: the check of tools/cli/gen_reference.py reports a stale page; regenerate and commit it.

Marketplace

A pack page (GET /v1/marketplace/packages/{name}) and its version (GET /v1/marketplace/packages/{name}/versions/{version}) carry the manifest; POST /v1/marketplace/preflight returns requested capabilities and required configuration before installation. See the Marketplace guide.

Executable examples

Python and CLI snippets are executed by sdks/python/tests/test_governance_clients.py; the TypeScript, Go and Java snippets of the SDK guides are compiled by services/control-plane/tests/test_developer_guides.py.

Troubleshooting

Symptom	Cause	Fix
A page shows 403 forbidden	your role cannot open it	ask for the role in details.required_roles
Contracts is empty	no contract published by the server	check GET /v1/contracts with your key
A kit row is Service not installed	the service is not installed by the Navin Manager	install it from the Navin Manager, then refresh
the answer holds "valid": false	the document breaks the contract	fix each entry of errors (path, message)
CI fails on docs/sdks/cli-reference.md	reference older than the CLI	run enterprise-ai docs --write cli-reference.md in docs/sdks

Next steps

• API Reference
• Getting Started
• Marketplace guide