adobe / adobe/jsonschema2md

Feature request, resolver parameter to allow mix of local and remote resolving.

Open
#581 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description


### Expected Behaviour
Lets say I have some schemas locally that I don't have on the server yet.

`jsonschema2md -d schemas -r "https://hai.ai/schemas/=schemas/"`

### Actual Behaviour
`cannot resolve https://hai.ai/schemas/components/tool/v1/tool.schema.json`

`jsonschema2md -d schemas -i schemas` also fails because of not resolving the base schemas in a doc with an $id like "$schema": "http://json-schema.org/draft-07/schema#",

Would love a way to detect a prefix in a resolver for some files, but not all (as with -i)

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the two examples with jsonschema2md using -d, -r, and -i, focusing on how resolver prefixes handle local and remote schemas. Done means a resolver can apply a local mapping for matching files while continuing remote resolution for others, including base schemas identified by $id.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.