Server API and OpenAPI

Customer Portal uses Nitro file-based handlers. The assembled application generates its API reference from the handlers present in portal core and every enabled feature layer.

Discover a deployed API

Each running portal exposes:

Use the ordered /api-docs/openapi.json document for clients and reviews. It reflects the layers installed in that deployment, so it is more authoritative than a copied endpoint list.

Current product surface

At the documented master revision, the assembled repository contains 238 Nitro API handler files. The count is a review signal rather than an API version: a catch-all handler can contribute multiple OpenAPI operations, and a handler can respond to one method only.

CI compares these layer and handler counts with the pinned public repository tree. When the product source pin changes, a mismatch requires the inventory and relevant narrative documentation to be reviewed together. For the exact operations, parameters, and response schemas in a deployment, use its generated OpenAPI document.

Authentication and tenancy

Most product handlers are session APIs rather than token-based public APIs. A protected feature operation should:

1. require an authenticated session;
2. derive the active organization from that session;
3. evaluate a typed feature action against the user's organization role;
4. scope every tenant-owned query by the returned organization ID;
5. validate path, query, and body input before repository access.

import { definePortalRouteMeta, requireFeatureAccess } from '@nuxt-customer-portal/core/server'
import { exampleFeature } from '../../../shared/feature'
import { createExampleSchema } from '../../utils/example-validation'

definePortalRouteMeta({
  openAPI: {
    tags: ['Example'],
    operationId: 'exampleCreate',
    summary: 'Create an example record',
    description: 'Creates a record in the active organization.'
  },
  body: createExampleSchema
})

export default defineEventHandler(async (event) => {
  const { session, organizationId } = await requireFeatureAccess(event, exampleFeature.policy, 'create')
  const input = createExampleSchema.parse(await readBody(event))

  return createExample({
    ...input,
    organizationId,
    createdById: session.user.id
  })
})

Do not accept organizationId from a normal browser request when the active session already determines the organization. PROVIDER-side client operations require an active PROVIDER membership and never use a global administrator bypass.

OpenAPI metadata

Every contributor-owned handler should call definePortalRouteMeta() beside the route with:

• one stable, unique operationId;
• a domain tag such as Timesheets or Service requests;
• an imperative summary;
• a description that states authentication, tenant scope, and the relevant permission;
• request and response schemas when Nitro cannot infer enough detail.

Keep the metadata beside the handler so moving or removing a layer also moves or removes its API description.

Error semantics

Core adapters establish these baseline responses:

Feature repositories should avoid revealing whether a record exists in another organization. Validation failures should be useful to the caller without exposing secrets, SQL, or credentials.

Stability

The generated OpenAPI document describes the current deployment; it is not yet a versioned public API guarantee. Pin the Customer Portal commit used by an integration and review the document when upgrading. See Compatibility and releases.