OAI / OAI/sig-lifecycle

Add optional field to the Operation object to indicate initial version containing the implementation

Open
#11 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I would love to add a version-related field to the Operation object (so per HTTP method of an Endpoint) that indicates the first version of the API that shipped with this functionality implemented.

For instance, the current API version is 18.0.0 but operation "GET /api/v1/jobs" was first shipped in version 17.1.0.

Nice to know for backward compatibility.

Also nice for developers to keep track of what versions offer what features. 😜

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.

Research direction

The issue names no files or tests; start by locating the Operation object and existing API versioning definitions. Done means agreeing on the optional field's semantics and documenting how it identifies the first API version containing an operation's implementation.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.