OpenAPITools / OpenAPITools/openapi-generator

[BUG][graphql-schema] doesn't support reuseble enum

Open
#5,815 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

graphql-schema generator doesn't support reusable enum

openapi-generator version

4.3.0

OpenAPI declaration file content or url
Resource:
      type: object
      properties:
        status:
            $ref: '#/components/schemas/ResourceStatus'
ResourceStatus:
      type: string
      enum:
        - a
        - b
        - c
Command line used for generation

npx openapi-generator generate -g graphql-schema -i example.yaml -o somedir

Steps to reproduce

Just run this command with schemas provided above, you will get an empty graphql file for this enum

# Paths for user service
# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
# The version of the OpenAPI document: 1.0.0
# Generated by OpenAPI Generator: https://openapi-generator.tech
#

type ResourceStatus {

}

Related issues/PRs
Suggest a fix

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 running the listed npx openapi-generator command with the provided example.yaml and inspect the graphql-schema generator output for ResourceStatus. Compare the generated schema with the reusable enum values a, b, and c shown in the issue. Done means the generated GraphQL output represents those enum values instead of an empty type.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.