Function: addSchemaToQuery()

addSchemaToQuery(directory): (id, schema, version?, options?) => Promise<void>

Defined in: queries.ts:292

Add a schema to a query by it's id.

Optionally specify a version to add a schema to a specific version of the query.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
schema	{ fileName: string; schema: string; }
schema.fileName	string
schema.schema?	string
version?	string
options?	{ path: string; }
options.path?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

const { addSchemaToQuery } = utils('/path/to/eventcatalog');

// JSON schema example
const schema = {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
       "name": {
       "type": "string"
   },
   "age": {
     "type": "number"
   }
 },
 "required": ["name", "age"]
};

// adds a schema to the latest GetOrder query
await addSchemaToQuery('GetOrder', { schema, fileName: 'schema.json' });

// adds a file to a specific version of the GetOrder query
await addSchemaToQuery('GetOrder', { schema, fileName: 'schema.json' }, '0.0.1');