pulp / pulp/pulpcore

add API_HOSTAME setting to override the hostname used for OpenAPI schema

Open
#5,167 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature
Dominant language
Python
Stars
598
Forks
168
Avg merge
1d 4h
Merged PRs (30d)
86

Description

Is your feature request related to a problem? Please describe.

The OpenAPI schema provides a list of servers that currently looks like this in our deployment:

    "servers": [
        {
            "url": "http://pulp-api-svc.pulp-stage.svc.cluster.local:24817/"
        }
    ]

We would like to be able to set the hostname to match that of the gateway that we use to access the API.

The API_HOSTNAME should default to the hostname of the machine it is running on. The value is just the hostname. It is distinct and separate from API_ROOT.

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

No file or test is named. Start by locating the OpenAPI schema generation entry point and the existing API_ROOT setting, then trace how the server hostname is selected. Done means an API_HOSTNAME setting can override that hostname, defaults to the machine hostname, and remains distinct from API_ROOT.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.