Kitura / Kitura/Kitura-OpenAPI

Ability to Add Descriptors to Endpoints

Open
#4 16 comments 0 reactions 1 assignee View on GitHub

@adam-rocska is already working on this.

Since May 19, 2026.

enhancement
Dominant language
Swift
Stars
37
Forks
16
PR merge metrics
No merged PRs in 30d

Description

This issue is more of an enhancement.
It would be useful to have the option to add additional information to each of the endpoints, like a description of the endpoint, any implementation notes, and maybe even ability to include the API owner's contact information.

For example:

GET /v1/todo
Description: List all todo items. Payload will contain all of your todo items.
Implementation Notes: Example payload { }.

I believe this provides the analogous functionality in Spring: http://docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/annotations/ApiOperation.html

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.