Class EpAsyncApiMessageDocument

Hierarchy

EpAsyncApiMessageDocument

Constructors

constructor

new EpAsyncApiMessageDocument(epAsyncApiDocument: EpAsyncApiDocument, epAsyncApiChannelDocument: undefined | EpAsyncApiChannelDocument, asyncApiMessageKey: undefined | string, asyncApiMessage: Message): EpAsyncApiMessageDocument
Parameters
- epAsyncApiDocument: EpAsyncApiDocument
- epAsyncApiChannelDocument: undefined | EpAsyncApiChannelDocument
- asyncApiMessageKey: undefined | string
- asyncApiMessage: Message
Returns EpAsyncApiMessageDocument
- Defined in src/documents/EpAsyncApiMessageDocument.ts:82

Properties

`Private` asyncApiMessage

asyncApiMessage: Message

`Private` asyncApiMessageKey

asyncApiMessageKey: string

`Private` contentType

contentType: APPLICATION_JSON

`Private` epAsyncApiChannelDocument

epAsyncApiChannelDocument: undefined | EpAsyncApiChannelDocument

`Private` epAsyncApiDocument

epAsyncApiDocument: EpAsyncApiDocument

`Private` schemaFormatType

schemaFormatType: E_EpAsyncApiSchemaFormatType

`Static` ContentTypeIssue

ContentTypeIssue: string = 'contentType === undefined, neither message has a contentType nor api has a defaultContentType'

Methods

`Private` determineContentType

determineContentType(): APPLICATION_JSON
Returns APPLICATION_JSON
- Defined in src/documents/EpAsyncApiMessageDocument.ts:24

`Private` determineSchemaFormatType

determineSchemaFormatType(): E_EpAsyncApiSchemaFormatType
Returns E_EpAsyncApiSchemaFormatType
- Defined in src/documents/EpAsyncApiMessageDocument.ts:48

`Private` extractMessageKey

extractMessageKey(asyncApiMessage: Message): string
Parameters
- asyncApiMessage: Message
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:66

getContentType

getContentType(): APPLICATION_JSON
Returns APPLICATION_JSON
- Defined in src/documents/EpAsyncApiMessageDocument.ts:118

getDescription

getDescription(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:131

getMessageKey

getMessageKey(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:107

getMessageName

getMessageName(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:109

getMessageNameAsFilePath

getMessageNameAsFilePath(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:139

getOriginalPayloadSchema

getOriginalPayloadSchema(): any
Returns any
- Defined in src/documents/EpAsyncApiMessageDocument.ts:122

getPayloadSchema

getPayloadSchema(): any
Returns any
- Defined in src/documents/EpAsyncApiMessageDocument.ts:155

getPayloadSchemaAsString

getPayloadSchemaAsString(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:126

getPayloadSchemaName

getPayloadSchemaName(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:143

getSchemaAsSanitizedJson

getSchemaAsSanitizedJson(): any
Returns any
- Defined in src/documents/EpAsyncApiMessageDocument.ts:169

getSchemaFileName

getSchemaFileName(): string
Returns string
- Defined in src/documents/EpAsyncApiMessageDocument.ts:150

getSchemaFormatType

getSchemaFormatType(): E_EpAsyncApiSchemaFormatType
Returns E_EpAsyncApiSchemaFormatType
- Defined in src/documents/EpAsyncApiMessageDocument.ts:120

validate

validate(): void
Returns void
- Defined in src/documents/EpAsyncApiMessageDocument.ts:91

validate_BestPractices

validate_BestPractices(): void
Returns void
- Defined in src/documents/EpAsyncApiMessageDocument.ts:101