Skip to content

Type Alias: ResourcefulModelOpenApiSchema

ts
type ResourcefulModelOpenApiSchema = SchemaObject & {
  x-resourceful-aggregatable?: string[];
  x-resourceful-auto-create?: string[];
  x-resourceful-filterable?: {
   [key: string]: any;
  };
  x-resourceful-sortable?: string[];
};

Type Declaration

NameTypeDescription
x-resourceful-aggregatable?string[]Array of field names that can be used in aggregation operations
x-resourceful-auto-create?string[]Properties of this model which are "auto-created" i.e. not required for creation even though they're not nullable
x-resourceful-filterable?{ [key: string]: any; }Array of field names that can be used in filter operations, including dot-notation for relationships
x-resourceful-sortable?string[]Array of field names that can be used in sort operations