Support preview of REST api docs from local instance

Open

#83 opened on Aug 21, 2024 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 4/5
Estimated time: 3-5 days
Newbie friendliness: 38/100

Issue type: Feature
Clarity: Mostly clear
Activity status: Stale
Tech stack: html
Domain: api, documentation

Research direction

Start by locating the build step that fetches the api-spec from pulp-docs' docs-data branch and the generated website entry point; no file is named in the issue. Define how a local Pulp instance on port 5001 is selected, then verify the served site renders API docs from that local instance.

Written by the indexing model from the issue text.

Description

enhancement

Currently the REST Api docs are build from the api-spec fetched from pulp-docs "docs-data" branch.

We should add an option (or automatic behavior) of trying to fetch from a local Pulp instance (like the one on port 5001), so the developer can preview the generated API docs from the pulp-docs served website.

Dominant language: HTML
Stars: 2
Forks: 17
Avg merge: 7d 18h
Merged PRs (30d): 3

Contributor guide

Open the contributing guide

First steps

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

Similar issues

Use `charmlibs.interfaces.oauth` instead of deprecated `hydra.oauth` Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

canonical/paas-charm#368 · 1 comment · Opened Sep 23, 2026
Model API: distributable field returns false even when "Allow Distributed Inference Across Workers" is checked Open

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

gpustack/gpustack#6275 · Opened Sep 23, 2026
attachment_urls parameter descriptions do not state that the value must be a reference Open

tech debt

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

epam/ai-dial-quickapps-backend#579 · Opened Sep 23, 2026
fix: in-app bug reports carry the user-report label — ADR 0143's P1 door never fires Open

area:workflow bug ready-for-agent

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

fil-donadoni/tolaria#4409 · Opened Sep 23, 2026
PHP warning in document.php after importing a saved header template in Elementor 4.3.0 Open

status/awaiting_triage

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

elementor/elementor#37396 · Opened Sep 23, 2026

More Backend & API Design issues