swagger-api/swagger-codegen

Swagger ignores vendorextention for $ref type properties

Open

#2,219 opened on Feb 23, 2016

View on GitHub
 (11 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Issue: Bughelp wanted

Description

Hi @wing328 ,

Swagger ignores vendorextention for $ref type properties. For e.g. If there is a property as follows in yaml

  myObject:
       properties:
               myid:
                  type: int
                  x-app-extensions: {"aaid" : "bb", "ccid" : "dd"}
errors:
                   x-app-extensions: {"aaerr" : "bb", "ccerr" : "dd"}
    $ref: "#/definitions/errorModel"

Then, swagger model ignores vendorextensions for errors, and only has only $ref property in the parsed json node, and same in reflected in created java model. But, vendorextenion is correctly picked up for myid. The ignorance of vendor extension is due to an issue in following snippet of the code of io.swagger.util.PropertyDeserializer.propertyFromNode(JsonNode) method.

   JsonNode detailNode = node.get("$ref");
  if (detailNode != null) {
      return new RefProperty(detailNode.asText()).description(description);
  }

Is it expected that, $ref type nodes are not supposed to have any other properties?

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Swagger/OpenAPI specificationFamiliarity with JavaKnowledge of Jackson JSON parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the io.swagger.util.PropertyDeserializer.propertyFromNode method in the swagger codegen repository. Reproduce the issue with the latest version. Check if the code snippet is still present. Look for any existing PRs or discussions. If the bug persists, propose a fix that includes vendor extensions when processing $ref nodes.