Terminology Riverpod Providers - API Contract

GET /api/v1/terminology-providers/api/v1/terminology-providers

List all configured terminology provider descriptors and their current state

Auth Required org_adminglobal_admin

Response Example

{
  "data": [
    {
      "provider_id": "organizationLabelsNotifierProvider",
      "type": "notifier",
      "organization_id": "org_nhf_oslo",
      "state": "loaded",
      "last_refreshed_at": "2026-03-26T06:00:00.000Z"
    },
    {
      "provider_id": "terminologySyncServiceProvider",
      "type": "service",
      "organization_id": "org_nhf_oslo",
      "state": "idle",
      "last_refreshed_at": "2026-03-26T06:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 4
  }
}

GET /api/v1/terminology-providers/api/v1/terminology-providers/:provider_id

Get the current state and configuration for a specific provider

Auth Required coordinatororg_adminglobal_admin

Response Example

{
  "provider_id": "fullTerminologyMapProvider",
  "type": "computed",
  "organization_id": "org_nhf_oslo",
  "state": "loaded",
  "label_count": 18,
  "last_refreshed_at": "2026-03-26T06:00:00.000Z"
}

POST /api/v1/terminology-providers/api/v1/terminology-providers

Register a new provider configuration for an organization

Auth Required org_adminglobal_admin

Request Example

{
  "provider_id": "organizationLabelsNotifierProvider",
  "organization_id": "org_nfb_bergen",
  "auto_refresh_enabled": true,
  "refresh_interval_seconds": 43200
}

Response Example

{
  "provider_id": "organizationLabelsNotifierProvider",
  "organization_id": "org_nfb_bergen",
  "state": "pending",
  "created_at": "2026-03-26T09:55:00.000Z"
}

PUT /api/v1/terminology-providers/api/v1/terminology-providers/:provider_id

Update refresh interval or settings for a provider configuration

Auth Required org_adminglobal_admin

Request Example

{
  "auto_refresh_enabled": true,
  "refresh_interval_seconds": 86400
}

Response Example

{
  "provider_id": "organizationLabelsNotifierProvider",
  "organization_id": "org_nhf_oslo",
  "refresh_interval_seconds": 86400,
  "updated_at": "2026-03-26T10:00:00.000Z"
}

DELETE /api/v1/terminology-providers/api/v1/terminology-providers/:provider_id

Remove a provider configuration record for an organization

Auth Required global_admin

Response Example

{
  "provider_id": "organizationLabelsNotifierProvider",
  "organization_id": "org_nfb_bergen",
  "deleted": true
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}