Swagger: Standardize module naming
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- api, documentation
Research direction
Start by locating the relevant APIRouter declarations in the guardrails service and inspect their current tags in the generated Swagger documentation. Standardize the section tags to title case and remove redundant suffixes such as "Configs". Done means the affected Swagger sections use consistent, polished names.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem?
There is inconsistency in the naming of modules in our Swagger documentation, which makes it appear unpolished and harder to scan for users. Mixed casing and naming conventions across section tags lead to confusion.
Describe the solution you'd like
- Standardize all Swagger section tags to consistent title case.
- Remove redundant suffixes from section names.
- Update the tags field on the relevant APIRouter declarations in the guardrails service.
Original issue
Describe the current behaviour
Swagger docs have inconsistency across the names of modules — section tags use mixed casing and inconsistent naming conventions. For example, guardrails is all lowercase while Ban Lists and Topic Relevance Configs are title case. Additionally, "Configs" is appended to one section name but not others, making the docs look unpolished and harder to scan.
Describe the enhancement you'd like
Standardise all Swagger section tags to use consistent title case with no redundant suffixes. This requires updating the tags field on the relevant APIRouter declarations in the guardrails service.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
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.
More from ProjectTech4DevAI/kaapi-guardrails
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
ProjectTech4DevAI/kaapi-guardrails#158 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
All issues in ProjectTech4DevAI/kaapi-guardrails
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100