Get the generated OpenAPI document for this app

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/openapi';
const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "openapi": "3.0.3",
  "info": {
    "title": "Cessy Runtime API Template",
    "version": "0.1.0",
    "description": "Generic template for the config-driven runtime API. Each published app also exposes a precise generated OpenAPI document at /api/rest/{tenantId}/{appId}/openapi with concrete command and projection schemas."
  },
  "paths": {
    "/openapi": {
      "get": {
        "tags": [
          "Metadata"
        ],
        "operationId": "getGeneratedOpenApi",
        "summary": "Get the generated OpenAPI document for this app",
        "description": "Returns the app-specific OpenAPI 3.0 document generated from the published DomainConfig. This endpoint is public metadata and does not require authentication.",
        "security": [],
        "responses": {
          "200": {
            "description": "Generated OpenAPI document",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "304": {
            "description": "Not modified"
          },
          "404": {
            "description": "App not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://cessy.ai/api/rest/acme-corp/inventory-app",
      "variables": {
        "tenantId": {
          "default": "acme-corp"
        },
        "appId": {
          "default": "inventory-app"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Metadata",
      "description": "Runtime metadata and generated contracts."
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": "ResourceNotFound",
          "details": {
            "message": "The requested app 'inventory-app' under tenant 'acme-corp' was not found."
          },
          "code": "404",
          "correlationId": "d4f7a9e2-3b1c-4f8a-9e2d-7a1b2c3d4e5f"
        },
        "required": [
          "error"
        ]
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Tenant/app API key or OAuth/JWT bearer token."
      }
    }
  }
}

Returns the app-specific OpenAPI 3.0 document generated from the published DomainConfig. This endpoint is public metadata and does not require authentication.

Response

Generated OpenAPI document

Errors

404

Not Found Error

1	{
2	"openapi": "3.0.3",
3	"info": {
4	"title": "Cessy Runtime API Template",
5	"version": "0.1.0",
6	"description": "Generic template for the config-driven runtime API. Each published app also exposes a precise generated OpenAPI document at /api/rest/{tenantId}/{appId}/openapi with concrete command and projection schemas."
7	},
8	"paths": {
9	"/openapi": {
10	"get": {
11	"tags": [
12	"Metadata"
13	],
14	"operationId": "getGeneratedOpenApi",
15	"summary": "Get the generated OpenAPI document for this app",
16	"description": "Returns the app-specific OpenAPI 3.0 document generated from the published DomainConfig. This endpoint is public metadata and does not require authentication.",
17	"security": [],
18	"responses": {
19	"200": {
20	"description": "Generated OpenAPI document",
21	"content": {
22	"application/json": {
23	"schema": {
24	"type": "object"
25	}
26	}
27	}
28	},
29	"304": {
30	"description": "Not modified"
31	},
32	"404": {
33	"description": "App not found",
34	"content": {
35	"application/json": {
36	"schema": {
37	"$ref": "#/components/schemas/ErrorResponse"
38	}
39	}
40	}
41	}
42	}
43	}
44	}
45	},
46	"servers": [
47	{
48	"url": "https://cessy.ai/api/rest/acme-corp/inventory-app",
49	"variables": {
50	"tenantId": {
51	"default": "acme-corp"
52	},
53	"appId": {
54	"default": "inventory-app"
55	}
56	}
57	}
58	],
59	"tags": [
60	{
61	"name": "Metadata",
62	"description": "Runtime metadata and generated contracts."
63	}
64	],
65	"security": [
66	{
67	"bearerAuth": []
68	}
69	],
70	"components": {
71	"schemas": {
72	"ErrorResponse": {
73	"type": "object",
74	"properties": {
75	"error": "ResourceNotFound",
76	"details": {
77	"message": "The requested app 'inventory-app' under tenant 'acme-corp' was not found."
78	},
79	"code": "404",
80	"correlationId": "d4f7a9e2-3b1c-4f8a-9e2d-7a1b2c3d4e5f"
81	},
82	"required": [
83	"error"
84	]
85	}
86	},
87	"securitySchemes": {
88	"bearerAuth": {
89	"type": "http",
90	"scheme": "bearer",
91	"description": "Tenant/app API key or OAuth/JWT bearer token."
92	}
93	}
94	}
95	}