swagger-api / swagger-api/swagger-ui

Annotation--Hostname Addition

Open
#5,103 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: support
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Provide a new annotation which exposes the server name. This would be helpful when going through VIPs and other routing abstractions to know which server is actually serving up the Swagger UI page.

Apologies in advance if this has already been discussed or has an issue (searched and didn't see anything).

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, test, or entry point is named in the issue, so first locate the annotation handling and the Swagger UI page that displays the server information. Done means a new annotation exposes the server name when the UI is served through VIPs or other routing abstractions, with coverage for the resulting behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.