swagger-api / swagger-api/swagger-parser

[swagger-parser-v2-converter] vendor extensions from body params not copied to RequestBody

Open
#1,715 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
867
Forks
560
Avg merge
2d 21h
Merged PRs (30d)
7

Description

Vendor extensions defined on body params are not copied over to the OpenAPI v3 RequestBody

Example:

{
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Person"
            },
            "x-log-mapping": {
              "$.name": "LAST_NAME",
              "$.firstName": "FIRST_NAME"
            }
}

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 in the swagger-parser-v2-converter body-parameter conversion path and trace how the example body parameter becomes an OpenAPI v3 RequestBody. Check how vendor extensions are handled during that conversion. Done means the x-log-mapping extension from the example is present on the resulting RequestBody, with a regression test covering it.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.