Class EpAsyncApiDocument

Hierarchy

EpAsyncApiDocument

Index

Constructors

Properties

applicationDomainName assetsApplicationDomainName asyncApiDocument asyncApiDocumentJson epEventApiName? epEventApiVersionName? originalApiSpecJson overrideEpApplicationDomainName overrideEpAssetsApplicationDomainName prefixEpApplicationDomainName unprefixedApplicationDomainName unprefixedAssetsApplicationDomainName NotSemVerIssue

Constructors

constructor

new EpAsyncApiDocument(originalApiSpec: any, asyncApiDocument: AsyncAPIDocument, overrideEpApplicationDomainName: undefined | string, overrideEpAssetApplicationDomainName: undefined | string, prefixEpApplicationDomainName: undefined | string): EpAsyncApiDocument
Parameters
- originalApiSpec: any
- asyncApiDocument: AsyncAPIDocument
- overrideEpApplicationDomainName: undefined | string
- overrideEpAssetApplicationDomainName: undefined | string
- prefixEpApplicationDomainName: undefined | string
Returns EpAsyncApiDocument
- Defined in src/documents/EpAsyncApiDocument.ts:150

Properties

`Private` applicationDomainName

applicationDomainName: string

`Private` assetsApplicationDomainName

assetsApplicationDomainName: string

`Private` asyncApiDocument

asyncApiDocument: AsyncAPIDocument

`Private` asyncApiDocumentJson

asyncApiDocumentJson: any

`Private` `Optional` epEventApiName

epEventApiName?: string

`Private` `Optional` epEventApiVersionName

epEventApiVersionName?: string

`Private` originalApiSpecJson

originalApiSpecJson: any

`Private` overrideEpApplicationDomainName

overrideEpApplicationDomainName: undefined | string

`Private` overrideEpAssetsApplicationDomainName

overrideEpAssetsApplicationDomainName: undefined | string

`Private` prefixEpApplicationDomainName

prefixEpApplicationDomainName: undefined | string

`Private` unprefixedApplicationDomainName

unprefixedApplicationDomainName: string

`Private` unprefixedAssetsApplicationDomainName

unprefixedAssetsApplicationDomainName: string

`Static` NotSemVerIssue

NotSemVerIssue: string = 'Please use semantic versioning format for API version.'

Methods

`Private` createApplicationDomainName

createApplicationDomainName(prefix?: string): string
Parameters
- Optional prefix: string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:73

`Private` createAssetsApplicationDomainName

createAssetsApplicationDomainName(prefix?: string): string
Parameters
- Optional prefix: string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:92

`Private` createEpEventApiName

createEpEventApiName(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:108

`Private` createEpEventApiVersionName

createEpEventApiVersionName(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:113

`Private` createOriginalApiSpecJson

createOriginalApiSpecJson(originalApiSpec: any): any
Parameters
- originalApiSpec: any
Returns any
- Defined in src/documents/EpAsyncApiDocument.ts:118

getApplicationDomainName

getApplicationDomainName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:254

getAsJson

getAsJson(): any
Returns any
- Defined in src/documents/EpAsyncApiDocument.ts:292

getAsYamlString

getAsYamlString(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:304

getAssetsApplicationDomainName

getAssetsApplicationDomainName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:258

getAsyncApiSpecVersion

getAsyncApiSpecVersion(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:242

getDefaultContentType

getDefaultContentType(): undefined | string
Returns undefined | string
- Defined in src/documents/EpAsyncApiDocument.ts:374

getDescription

getDescription(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:248

getEpEventApiName

getEpEventApiName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:270

getEpEventApiVersionName

getEpEventApiVersionName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:281

`Private` getJSON

getJSON(asyncApiDocument: AsyncAPIDocument): any
Parameters
- asyncApiDocument: AsyncAPIDocument
Returns any
- Defined in src/documents/EpAsyncApiDocument.ts:52

getLogInfo

getLogInfo(): T_EpAsyncApi_LogInfo
Returns T_EpAsyncApi_LogInfo
- Defined in src/documents/EpAsyncApiDocument.ts:380

getOriginalSpecAsJson

getOriginalSpecAsJson(): any
Returns any
- Defined in src/documents/EpAsyncApiDocument.ts:314

getOriginalSpecAsYamlString

getOriginalSpecAsYamlString(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:318

getSupportedContentTypes

getSupportedContentTypes(): string[]
Returns string[]
- Defined in src/documents/EpAsyncApiDocument.ts:370

getTitle

getTitle(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:244

getTitleAsFileName

getTitleAsFileName(ext: string): string
Parameters
- ext: string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:266

getTitleAsFilePath

getTitleAsFilePath(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:262

getUnprefixedApplicationDomainName

getUnprefixedApplicationDomainName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:256

getUnprefixedAssetsApplicationDomainName

getUnprefixedAssetsApplicationDomainName(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:260

getVersion

getVersion(): string
Returns string
- Defined in src/documents/EpAsyncApiDocument.ts:246

`Private` get_X_EpApplicationDomainName

get_X_EpApplicationDomainName(): undefined | string
Returns undefined | string
- Defined in src/documents/EpAsyncApiDocument.ts:63

`Private` get_X_EpAssetsApplicationDomainName

get_X_EpAssetsApplicationDomainName(): undefined | string
Returns undefined | string
- Defined in src/documents/EpAsyncApiDocument.ts:68

validate

validate(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:216

validate_BestPractices

validate_BestPractices(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:229

`Private` validate_EpEventApiName

validate_EpEventApiName(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:163

`Private` validate_EpEventApiVersionName

validate_EpEventApiVersionName(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:182

`Private` validate_VersionIsSemVerFormat

validate_VersionIsSemVerFormat(): void
Returns void
- Defined in src/documents/EpAsyncApiDocument.ts:201

Class EpAsyncApiDocument

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

originalApiSpec: any

asyncApiDocument: AsyncAPIDocument

overrideEpApplicationDomainName: undefined | string

overrideEpAssetApplicationDomainName: undefined | string

prefixEpApplicationDomainName: undefined | string

Returns EpAsyncApiDocument

Properties

Private applicationDomainName

Private assetsApplicationDomainName

Private asyncApiDocument

Private asyncApiDocumentJson

Private Optional epEventApiName

Private Optional epEventApiVersionName

Private originalApiSpecJson

Private overrideEpApplicationDomainName

Private overrideEpAssetsApplicationDomainName

Private prefixEpApplicationDomainName

Private unprefixedApplicationDomainName

Private unprefixedAssetsApplicationDomainName

Static NotSemVerIssue

Methods

Private createApplicationDomainName

Parameters

Optional prefix: string

Returns string

Private createAssetsApplicationDomainName

Parameters

Optional prefix: string

Returns string

Private createEpEventApiName

Returns void

Private createEpEventApiVersionName

Returns void

Private createOriginalApiSpecJson

Parameters

originalApiSpec: any

Returns any

getApplicationDomainName

Returns string

getAsJson

Returns any

getAsYamlString

Returns string

getAssetsApplicationDomainName

Returns string

getAsyncApiSpecVersion

Returns string

getDefaultContentType

Returns undefined | string

getDescription

Returns string

getEpAsyncApiChannelDocumentMap

Returns T_EpAsyncApiChannelDocumentMap

getEpAsyncApiEventNames

Returns T_EpAsyncApiEventNames

getEpAsyncApiMessageDocumentMap

Returns T_EpAsyncApiMessageDocumentMap

getEpEventApiName

Returns string

getEpEventApiVersionName

Returns string

Private getJSON

Parameters

asyncApiDocument: AsyncAPIDocument

Returns any

getLogInfo

Returns T_EpAsyncApi_LogInfo

getOriginalSpecAsJson

Returns any

getOriginalSpecAsYamlString

Returns string

`Private` applicationDomainName

`Private` assetsApplicationDomainName

`Private` asyncApiDocument

`Private` asyncApiDocumentJson

`Private` `Optional` epEventApiName

`Private` `Optional` epEventApiVersionName

`Private` originalApiSpecJson

`Private` overrideEpApplicationDomainName

`Private` overrideEpAssetsApplicationDomainName

`Private` prefixEpApplicationDomainName

`Private` unprefixedApplicationDomainName

`Private` unprefixedAssetsApplicationDomainName

`Static` NotSemVerIssue

`Private` createApplicationDomainName

`Optional` prefix: string

`Private` createAssetsApplicationDomainName

`Optional` prefix: string

`Private` createEpEventApiName

`Private` createEpEventApiVersionName

`Private` createOriginalApiSpecJson

`Private` getJSON

`Private` get_X_EpApplicationDomainName

`Private` get_X_EpAssetsApplicationDomainName

`Private` validate_EpEventApiName

`Private` validate_EpEventApiVersionName

`Private` validate_VersionIsSemVerFormat