openfga / openfga/api

Document protobufs in favor of OpenAPI

Open
#84 0 comments 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

Originally posted by @jon-whit in https://github.com/openfga/api/pull/83#discussion_r1258460799

Currently the documentations are OpenAPI based, we should consider moving/adding it to protobufs

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 files, tests, or entry points are identified in the issue. Start by locating the existing OpenAPI documentation and the repository's protobuf definitions, then determine the intended documentation format and what parity between them would count as done.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.