Files
cfw-autumn/packages/openapi/v2.0/entitiesOpenApi.ts
John Yeo 90287e6308 latest
2026-02-19 13:24:33 +00:00

79 lines
1.8 KiB
TypeScript

import { SuccessResponseSchema } from "@api/common";
import { CreateEntityParamsV0Schema } from "@api/entities/crud/createEntityParams";
import { ApiEntitySchema, queryStringArray } from "@autumn/shared";
import { EntityExpand } from "@models/cusModels/entityModels/entityExpand.js";
import { z } from "zod/v4";
// Note: The meta with id is added in openapi.ts to avoid duplicate registration
// This schema is exported through the main index and should not have an id here
export const ApiEntityWithMeta = ApiEntitySchema.meta({
id: "Entity",
// examples: [ENTITY_EXAMPLE],
});
export const entitiesOpenApi = {
"/customers/{customer_id}/entities": {
post: {
summary: "Create Entity",
tags: ["entities"],
requestParams: {
path: z.object({
customer_id: z.string(),
}),
},
requestBody: {
content: {
"application/json": { schema: CreateEntityParamsV0Schema },
},
},
responses: {
"200": {
description: "200 OK",
content: { "application/json": { schema: ApiEntityWithMeta } },
},
},
},
},
"/customers/{customer_id}/entities/{entity_id}": {
get: {
summary: "Get Entity",
tags: ["entities"],
requestParams: {
path: z.object({
customer_id: z.string(),
entity_id: z.string(),
}),
query: z.object({
expand: queryStringArray(z.enum(EntityExpand)).optional(),
}),
},
responses: {
"200": {
description: "200 OK",
content: { "application/json": { schema: ApiEntityWithMeta } },
},
},
},
delete: {
summary: "Delete Entity",
tags: ["entities"],
requestParams: {
path: z.object({
customer_id: z.string(),
entity_id: z.string(),
}),
},
responses: {
"200": {
description: "200 OK",
content: {
"application/json": {
schema: SuccessResponseSchema,
},
},
},
},
},
},
};