progenitor requires operationId to be set

Open
#1,105 16 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi, rust
Domain
api, tooling

Research direction

Start by tracing the OpenAPI 3 operationId handling in the code-generation entry points. Check the specification's operationId field and the existing discussion for constraints on deriving identifiers from paths and HTTP methods. Done means OAS3 documents without operationId can generate clients while preserving valid, stable operation identifiers.

Written by the indexing model from the issue text.

Description

In OAS 3, there is no such requirement.

See operationId field in the table in the spec here: https://swagger.io/specification/v3/#fixed-fields-8.

Progenitor requiring opIds makes a lot of OAS3 files unsuitable for code generation unnecessarily. There should be an easy way to generate opIds from path and http method.

Dominant language
Rust
Stars
1k
Forks
136
Avg merge
8h 36m
Merged PRs (30d)
14

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.

More from oxidecomputer/progenitor

All issues in oxidecomputer/progenitor

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.