marigold-dev / marigold-dev/openapi-router

allow overriding ui version

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

The ui version is pinned to v3. This could be made an optional parameter to allow upgrading to later versions of the UI as I did on my fork: https://github.com/marigold-dev/openapi-router/compare/master...joprice:openapi-router:flake?expand=1#diff-b52566891d1041a5b52c0c58c967fcd6096ce1c3674e4c869095fee0f327d66bR414. This assumes that the initialization script embedded in the library works for future versions, so but that could be worked around by ignoring the html from the doc_route and inlining a customized version. Assuming the config is relatively stable, allowing the version to be optionally specified is convenient to expose.

Contributor guide

No contributing guide indexed for this repository

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 with the pinned v3 UI reference and the initialization script shown in the linked fork comparison, then trace how doc_route embeds the UI HTML. The change is complete when callers can optionally select a UI version while the existing v3 behavior remains the default, including the documented configuration path.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.