Skip to main content

Function: versionService()

versionService(directory): (id) => Promise<void>

Defined in: services.ts:246

Version a service by it's id.

Takes the latest service and moves it to a versioned directory. All files with this service are also versioned. (e.g /services/InventoryService/openapi.yml)

Parameters

ParameterType
directorystring

Returns

Function

Parameters

ParameterType
idstring

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// moves the latest InventoryService service to a versioned directory
// the version within that service is used as the version number.
await versionService('InventoryService');