API reference / @chanx-js/codegen / JsonSchema

Interface: JsonSchema

Defined in: schema.ts:3

The slice of AsyncAPI 3 that chanx emits. Deliberately permissive.

Indexable

[key: string]: unknown

Properties

$ref?

optional $ref?: string;

Defined in: schema.ts:4

---

additionalProperties?

optional additionalProperties?: boolean | JsonSchema;

Defined in: schema.ts:16

---

allOf?

optional allOf?: JsonSchema[];

Defined in: schema.ts:19

---

anyOf?

optional anyOf?: JsonSchema[];

Defined in: schema.ts:17

---

const?

optional const?: unknown;

Defined in: schema.ts:8

---

default?

optional default?: unknown;

Defined in: schema.ts:10

---

description?

optional description?: string;

Defined in: schema.ts:6

---

discriminator?

optional discriminator?: 
  | string
  | {
  propertyName?: string;
};

Defined in: schema.ts:20

---

enum?

optional enum?: unknown[];

Defined in: schema.ts:9

---

format?

optional format?: string;

Defined in: schema.ts:11

---

items?

optional items?: JsonSchema;

Defined in: schema.ts:15

---

nullable?

optional nullable?: boolean;

Defined in: schema.ts:12

---

oneOf?

optional oneOf?: JsonSchema[];

Defined in: schema.ts:18

---

properties?

optional properties?: Record<string, JsonSchema>;

Defined in: schema.ts:13

---

required?

optional required?: string[];

Defined in: schema.ts:14

---

title?

optional title?: string;

Defined in: schema.ts:5

---

type?

optional type?: string | string[];

Defined in: schema.ts:7