openapi-processor / openapi-processor/openapi-processor-base

map inline names to nicer names

Open
#189 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Kotlin
Stars
2
Forks
4
Avg merge
4d 55m
Merged PRs (30d)
9

Description

  /bookings/{bookingId}/payment:
    post:
      responses:
        '200':

generates the response object as BookingsBookingIdPaymentPostResponse200.

Would it be useful to have the possibility to map that identifier to a nicer name?

mapping could use

  • json path to nice java name
  • generated java name to nice java name

the processor would have to warn if the inline name did not exists.

benefit:

it would not be necessary to define responses etc. as named schema to get a proper java class name

drawback:

harder to maintain?

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 file, test, or entry point is named. First clarify where name mappings would be configured and whether JSON paths or generated names are the supported keys; define the warning behavior for unmatched mappings before identifying the generator code and tests to change.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, openapi
Domain
backend-api-design, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.