OpenAPITools / OpenAPITools/openapi-generator

[REQ] Atproto lexicon generation from OpenID spec

Open
#22,614 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

The problem

Atproto is growing in popularity for good reason, its a very nice way to unify applications.

This can be done by declaring a lexicon which defines data formats and endpoints in a structured way that can be integrated with atproto. https://atproto.com/specs/lexicon

This will be using the data from an openapi.json file but i couldn't find a tool for generating a lexicon from an openid files.

The Solution

A tool that generates a lexicon definition file from an openapi.json spec , the developer can then edit it down to just the functions and types they want to use on atproto and then publish it in the specific location on their site.

Alternatives

I have considered doing this myself but i'm not so familiar with OpenAPI internals and figured that for someone who is used to this it would reasonably simple.

I am happy to help with making this happen and finding ways to test it. I think this will be something quite a few people will use because atproto is growing massively.

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 with the openapi.json input and review the linked Atproto Lexicon specification to understand the required output structure. Determine how OpenAPI data should map to lexicon definitions and endpoints, then validate the generated lexicon against representative specifications. Done means a usable generator produces an editable lexicon definition from an OpenAPI document.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
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.