Add AsyncAPI 3.0 Documentation and Configuration Support

Summary

This PR adds comprehensive documentation and configuration support for AsyncAPI 3.0 specification in the language server (apidom-ls). It builds upon the work done in PR #5095 by completing the documentation coverage for all AsyncAPI 3.0 objects and properties.

What Changed

1. New AsyncAPI 3.0 Configuration Directories

Added complete configuration structure for 5 new AsyncAPI 3.0-specific objects:

• messages/ - Messages Object configuration
• operations/ - Operations Object configuration
• operation-reply/ - Operation Reply Object configuration
• operation-reply-address/ - Operation Reply Address Object configuration
• multi-format-schema/ - Multi Format Schema Object configuration

Each directory includes:

• documentation.ts - Hover documentation with links to AsyncAPI 3.0 spec
• completion.ts - Empty completion arrays (reserved for future use)
• lint/index.ts - Linting configuration structure
• meta.ts - Metadata configuration
• All registered in config.ts

2. AsyncAPI 3.0 Support for Channel Item

Enhanced channel-item/ configuration with AsyncAPI 3.0 properties:

New Properties Documented:

• address - String representation of the channel's address
• messages - Map of messages sent to this channel
• title - Human-readable title
• summary - Short summary
• tags - List of tags
• externalDocs - External documentation
• servers - Servers this channel is available on
• parameters - Parameters in the channel address
• bindings - Protocol-specific bindings

New Lint Rules:

• allowed-fields-3-0.ts - Validates allowed fields for AsyncAPI 3.0
• address--type.ts - Type validation for address
• messages--type.ts - Type validation for messages
• title--type.ts - Type validation for title
• summary--type.ts - Type validation for summary
• tags--type.ts - Type validation for tags
• external-docs--type.ts - Type validation for externalDocs

3. Completed Missing Documentation

Added missing documentation for several AsyncAPI objects:

asyncapi3/documentation.ts

• Added comprehensive AsyncAPI Object documentation with all fixed fields (asyncapi, id, info, servers, defaultContentType, channels, operations, components)

operation/documentation.ts

• Added missing required channel property documentation

components/documentation.ts

• Added missing operations property documentation

security-requirement/documentation.ts

• Added AsyncAPI 3.0-specific variant with updated role names support

4. JSON Schema Support for AsyncAPI 3.0

Updated common/schema/documentation.ts to extend all JSON Schema keywords for AsyncAPI 3.0:

Updated 46 JSON Schema keywords to support AsyncAPI 3.0:

• Type validation: type, enum, const
• Numeric validation: multipleOf, maximum, minimum, exclusiveMaximum, exclusiveMinimum
• String validation: maxLength, minLength, pattern
• Array validation: items, additionalItems, maxItems, minItems, uniqueItems, contains
• Object validation: maxProperties, minProperties, required, properties, patternProperties, additionalProperties, dependencies, propertyNames
• Conditional: if, then, else
• Boolean logic: allOf, anyOf, oneOf, not
• Reference: $ref
• Metadata: title, description, examples, deprecated

AsyncAPI-specific Schema Properties:

• default - Added AsyncAPI 3.0 support (value must conform to defined type)
• discriminator - Added separate AsyncAPI 3.0 entry with updated spec links
• externalDocs - Added separate AsyncAPI 3.0 entry with updated spec links

5. Documentation

Added CLAUDE.md to help future Claude Code instances understand the repository structure and development workflow.

Key Technical Details

AsyncAPI 2.0 vs 3.0 Major Differences

• Channels: In v2, channels had subscribe/publish; in v3, they have messages + address
• Operations: Moved from channel-level to top-level with action, channel, and reply properties
• Server: Changed from url to host + pathname; added title, summary, externalDocs
• Messages: Added MultiFormatSchema support
• Components: Added operations, replies, and replyAddresses

Documentation Pattern

All documentation entries follow this pattern:

{
  target: 'propertyName',  // or docs for object-level documentation
  docs: '#### [Object Name](spec-url)...',  // Markdown with spec links
  targetSpecs: AsyncAPI3,  // or [...AsyncAPI2, ...AsyncAPI3] for shared docs
}

Completion Pattern

All completion files are currently empty arrays:

const completion: ApidomCompletionItem[] = [];
export default completion;

Files Changed

• 36 files changed: 633 insertions(+), 48 deletions(-)
• New directories: 5 configuration directories for AsyncAPI 3.0 objects
• New files: 31 new configuration and documentation files
• Updated files: 5 existing documentation files enhanced with AsyncAPI 3.0 support

References

• AsyncAPI 3.0.0 Specification
• Migrating to v3
• AsyncAPI 3.0.0 Release Notes