Api referenceRoutesClients

Fetch client OpenAPI

Returns the generated live API for one client. This per-client OpenAPI document is the authority for that client's discovered actions, resources, routes, schemas, handles, availability, and runtime fingerprints.

GET
/clients/{id}/openapi.json

Returns the generated live API for one client. This per-client OpenAPI document is the authority for that client's discovered actions, resources, routes, schemas, handles, availability, and runtime fingerprints.

Response Body

application/json

application/json

curl -X GET "https://example.com/clients/{id}/openapi.json"
{  "openapi": "string",  "info": {    "title": "string",    "version": "string"  },  "paths": {},  "x-craftless": {},  "x-craftless-actions": [    {      "id": "string",      "schemaVersion": "string",      "source": "string",      "availability": "string",      "availabilityReason": "string",      "args": {},      "result": {}    }  ],  "x-craftless-resources": [    {      "id": "string",      "actions": [        "string"      ],      "availability": "string",      "availabilityReasons": [        "string"      ],      "actionDescriptors": [        {          "id": "string",          "schemaVersion": "string",          "source": "string",          "availability": "string",          "availabilityReason": "string",          "args": {},          "result": {}        }      ]    }  ]}
{  "code": "string",  "message": "string"}