@ordercloud/oc-codegen
Version:
OpenAPI codegen tool built for the OrderCloud API
43 lines (42 loc) • 1.09 kB
TypeScript
import { Operation } from './operation.model';
import { Resource } from './resource.model';
import { Model } from './model.model';
import { Info } from './info.model';
import { OpenAPIV3 } from 'openapi-types';
export interface TemplateData {
/**
* meta information about the api
*/
info: Info;
/**
* array of all models in the API
* ie Order, LineItem, etc.
*/
models: Model[];
/**
* array of all operations in the API (not grouped)
* ie List Orders, Create LineItem etc.
*/
operations: Operation[];
/**
* array of all api resources and their operations
* ie Orders, CreditCards, etc.
*/
resources: Resource[];
/**
* only present on contextual **model** templates
*/
model?: Model;
/**
* only present on contextual **resource** templates
*/
resource?: Resource;
/**
* only present on contextual **operation** templates
*/
operation?: Operation;
/**
*
*/
rawSpec?: OpenAPIV3.Document;
}