04. Plugin: Tags

Top-Level Tags

The tags array at the top level of the OpenAPI specification serves as a top-level declaration of all tags used within the API.

tags {
    add(name = "Items", description = "Operations related to items.")
}

• Properties:
  • name: The unique name of the tag.
  • description: Optional description of the tag.

---

Example

install(Kopapi) {

    // ...
    // Top level tags.
    tags {
        add(name = "Items", description = "Operations related to items.")
        add(name = "Users", description = "Operations related to users.")
        add(name = "Orders", description = "Operations related to orders.")
    }
}