API docs: openapi-v3.schemaref | LoopBack Documentation

Page Contents

SchemaRef type

Custom LoopBack extension: a reference to Schema object that’s bundled inside definitions property.

Signature:

export type SchemaRef = ReferenceObject & {
    definitions: SchemasObject;
};

Example

const spec: SchemaRef = {
  $ref: '/components/schemas/Product',
  definitions: {
    Product: {
      title: 'Product',
      properties: {
        // etc.
      }
    }
  }
}