pulp / pulp/pulp-cli

Auto-refresh api-spec for other than version-changes

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

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
43
Forks
52
Avg merge
11h 38m
Merged PRs (30d)
11

Description

Currently we will auto-update api-spec if we notice that the pulp-instance you're pointing at, is running different versions than when last we refreshed the spec.

However - there are other ways for a spec to be invalid. If one instance has domains enabled, for example, and a second one running the same versions does not, their specs will not match.

We should trigger auto-refresh on more than just the version-list.

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 tracing the existing api-spec auto-refresh logic that compares version lists. Identify how instance capabilities such as domains enabled can make specs differ even when versions match. Done means refreshes are triggered for relevant spec-invalidating differences beyond version changes, with tests covering the behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.