mattpolzin / mattpolzin/OpenAPIKit

Support local dereferencing of `$ref` to `$anchor`

Open
#363 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

module: OpenAPIKit v5.x
Dominant language
Swift
Stars
333
Forks
49
Avg merge
19h 9m
Merged PRs (30d)
10

Description

Currently, local dereferencing only supports looking up in the Components Object.

This depends on other upcoming work that will expand `JSONReference.InternalReference` to support anchors in addition to components and paths.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the local dereferencing implementation and the JSONReference.InternalReference type mentioned in the issue. Confirm how component and path references are currently resolved, then support local $ref targets using $anchor once the related InternalReference expansion is available; done means local anchors dereference successfully without regressing existing component and path lookups.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.