Skip to content

Add family-aware docs diagnostics and service contract navigation - #959

Open
jacob-delgado-47 wants to merge 3 commits into
daveshanley:mainfrom
jacob-delgado-47:codex/asyncapi-service-navigation
Open

Add family-aware docs diagnostics and service contract navigation#959
jacob-delgado-47 wants to merge 3 commits into
daveshanley:mainfrom
jacob-delgado-47:codex/asyncapi-service-navigation

Conversation

@jacob-delgado-47

Copy link
Copy Markdown

@daveshanley This is a downstream update associated with the earlier doctor change. pb33f/doctor#116

Summary

This MR extends vacuum docs so OpenAPI and AsyncAPI contracts can be validated according to their specification family while appearing together in a coherent service documentation site.

It:

  • Adds separate OpenAPI and AsyncAPI ruleset configuration for documentation diagnostics.
  • Selects the appropriate parser and ruleset for each contract instead of treating every discovered specification as OpenAPI.
  • Propagates service identity and contract-role configuration into Doctor, allowing HTTP APIs, published events, and consumed events to be grouped and navigated as contracts of the same service.
  • Adds coverage for mixed OpenAPI and AsyncAPI catalogs, family-specific diagnostics, and configuration isolation.
  • Makes concurrent lint resource cleanup safe when multiple workers share parsed resources.
  • Upgrades Doctor to v0.0.80, which provides the underlying service and contract navigation support.

The result is a documentation workflow where OpenAPI and AsyncAPI retain their own validation semantics without creating separate or inconsistent browsing experiences.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants