Skip to content

Feature Request: Root-relative $ref paths or path aliases for multi-file specs #2498

@maxd

Description

@maxd

When working with a deeply nested multi-file OpenAPI spec, $ref paths become very long and hard to maintain:

$ref: '../../../../../components/schemas/requests/orders/order_items.yaml#/OrderItems'

This breaks easily on any directory restructure and hurts readability.

Would it be possible to support any of the following?

  1. Root-relative paths$ref resolved relative to the root openapi.yaml, e.g.:

    $ref: '/components/schemas/requests/orders/order_items.yaml#/OrderItems'
  2. Path aliases — configured in zudoku.config.tsx, e.g.:

    aliases: { '@schemas': './apis/components/schemas' }

    so refs like $ref: '@schemas/requests/orders/order_items.yaml#/OrderItems' work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions