Interface IParameters

Whether the type is deprecated or not.

Detailed description of the schema.

Example value.

List of example values as key-value pairs.

Whether to allow null value or not.

Properties of the object.

The properties means a list of key-value pairs of the object's regular properties. The key is the name of the regular property, and the value is the type schema info.

If you need additional properties that is represented by dynamic key, you can use the additionalProperties instead.

List of key values of the required properties.

The required means a list of the key values of the required properties. If some property key is not listed in the required list, it means that property is optional. Otherwise some property key exists in the required list, it means that the property must be filled.

Below is an example of the properties and required.

interface SomeObject {
  id: string;
  email: string;
  name?: string;
}
Copy

As you can see, id and email properties are required, so that they are listed in the required list.

{
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "email": { "type": "string" },
    "name": { "type": "string" }
  },
  "required": ["id", "email"]
}
Copy

Title of the schema.

Discriminator value of the type.