Skip to content

Swagger: Standardize module naming #94

@nishika26

Description

@nishika26

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions