openfga / openfga/api

Feature: Have a release tag

Open
#221 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
27
Forks
24
Avg merge
12d 6h
Merged PRs (30d)
1

Description

Situation

We are using the OpenAPI spec contained in this repo in order to create a HTTP client using OpenAPI generator, as the pre-built Java SDK does not suite our needs.

Everything works like a charm, yet as a matter of production maturity, we strive for immutable builds.

As we do not wanna manually download the spec file on change, we leverage the "remoteSpec" feature of the OpenAPI Gradle plugin.

The problem

The remote spec we consume just points to the main branch if this project, making our build mutable.

Feature request

Please introduce some sort of release management to this repo, so that we can consume a tagged version of the spec.
The tag is easily accessible via GitHub core features, yet the tag just needs to be created.

Side note

Having dedicated releases might also come in handy for other use cases our API stability management at all.

Thanks
✌️

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

Start by locating the OpenAPI spec consumed from the main branch and checking the repository’s GitHub release or tag configuration. Define how a tagged version of the spec should be created, then verify that the OpenAPI Gradle plugin’s remoteSpec can consume the tag instead of main.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, openapi
Domain
api, release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.