swagger-api / swagger-api/swagger-codegen

Support version since of an operation

Open
#4,926 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

General: Suggestion
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

It would be great to have support for something like the javadoc @since

There has been a issue/suggestion for this in the OpenAPI-spec:
https://github.com/OAI/sig-lifecycle/issues/11

The name should be "x-since" (not language-specific).
This could also be used to track versions of the operations in the sample yaml files.

Related issues

https://github.com/OAI/sig-lifecycle/issues/11

Suggest a Fix

Implement the attribute "x-since".

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 source file, test, or entry point is named. Start by locating how swagger-codegen parses OpenAPI operation extensions and how those values reach generated outputs; done means the x-since attribute is supported consistently and can be used in the sample YAML files.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.