core ​
Interfaces ​
| Interface | Description |
|---|---|
| GenerateSpecOptions | Options for OpenAPI spec generation |
Type Aliases ​
| Type Alias | Description |
|---|---|
| ApiPermission | REDCap API permission levels |
| OpenApiSpec | OpenAPI specification (simplified type) |
Variables ​
| Variable | Description |
|---|---|
| CONTENT_KEY_MAPPING | Map PHP help.php keys to API content type names |
| CONTENT_TYPE_ACTIONS | Content type to supported actions mapping |
| CORE_CONTENT_TYPES | Content types available in all supported versions |
| getActionsForContentType | Get available actions for a content type |
| getContentTypesForVersion | Get all available content types for a version |
| getContentTypesInGroup | Get all content types in a tag group |
| getTagGroup | Get the tag group for a content type |
| isActionAvailable | Check if an action is available for a content type |
| isContentTypeAvailable | Check if a content type is available for a version |
| mapContentKeyToType | Map content key to normalized content type |
| mapPermission | Map permission code to readable name |
| PERMISSION_MAPPING | Map permission codes to readable names |
| TAG_GROUPS | OpenAPI tag groups for organizing endpoints |
| V15_CONTENT_TYPES | Content types added in v15+ |
| V16_CONTENT_TYPES | Content types added in v16+ |
Functions ​
| Function | Description |
|---|---|
| comparePaths | Compare paths between two specs |
| comparePatterns | Compare patterns and enums in matching schemas |
| compareSchemas | Compare schemas between two specs |
| compareSpecs | Compare two OpenAPI specs and return a summary |
| generateOpenApiSpec | Generate OpenAPI 3.1.0 specification from parsed REDCap data |
| parseActionFile | Parse an action file content to extract validation and response info |
| parseActionFiles | Parse multiple action files from a map of content |
| parseClassSchemas | Parse all class schemas from a map of class file contents |
| parseCurlExample | Parse a single curl example file |
| parseCurlExamples | Parse multiple curl example files |
| parseHelpPhp | Parse help.php content to extract documentation and parameters |
| parseIndexPhp | Parse index.php content to extract content types and routing |
| parseProjectSchemas | Parse Project.php content to extract project-related schemas |
| parseUserRightsSchemas | Parse UserRights.php content to extract user rights schema |
References ​
ActionFileInfo ​
Re-exports ActionFileInfo
ApiAction ​
Re-exports ApiAction
ComparisonResult ​
Re-exports ComparisonResult
ComparisonSummary ​
Re-exports ComparisonSummary
ContentTypeInfo ​
Re-exports ContentTypeInfo
HelpSection ​
Re-exports HelpSection
Parameter ​
Re-exports Parameter
ParameterType ​
Re-exports ParameterType
SchemaDefinition ​
Re-exports SchemaDefinition