Skip to content

Interface: ApiEndpoint ​

Defined in: cli/redcap-openapi/src/extractor/types.ts:21

API endpoint definition for extractor

Properties ​

action ​

action: ApiAction

Defined in: cli/redcap-openapi/src/extractor/types.ts:23


content ​

content: string

Defined in: cli/redcap-openapi/src/extractor/types.ts:22


description ​

description: string

Defined in: cli/redcap-openapi/src/extractor/types.ts:26


examples ​

examples: Example[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:31


operationId ​

operationId: string

Defined in: cli/redcap-openapi/src/extractor/types.ts:24


optionalParams ​

optionalParams: Parameter[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:28


permissions ​

permissions: string[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:29


requiredParams ​

requiredParams: Parameter[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:27


responseFormat ​

responseFormat: string[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:30


sourceFiles ​

sourceFiles: string[]

Defined in: cli/redcap-openapi/src/extractor/types.ts:32


summary ​

summary: string

Defined in: cli/redcap-openapi/src/extractor/types.ts:25