swagger-api / swagger-api/swagger-codegen
[Python] JSON reference in $ref isn't acknowledged
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
It looks like I am having a couple issues.
$ref: '#/definitions/Tenant/properties/name'gets rendered in theTenantmodel with typeTenantpropertiesname- The rendered
Tenantmodel only has anameproperty. TheTenantdefinition below has 6 total properties which do not make it into the rendered model. - Replacing
$ref: '#/definitions/Tenant/properties/name'with a simpletype: stringfixes the type issue but still leaves a relatively emptyTemplatemodel.
@property
def name(self):
"""
Gets the name of this Tenant.
:return: The name of this Tenant.
:rtype: Tenantpropertiesname
"""
return self._name
Swagger-codegen version
2.2.3
Swagger declaration file content or url
patch:
description: Update a tenant record.
operationId: update
tags:
- tenants
parameters:
- $ref: "#/parameters/id"
- in: body
name: tenant
description: The tenant properties to update
schema:
type: object
required:
- name
properties:
name:
$ref: '#/definitions/Tenant/properties/name'
Tenant:
type: object
required:
- name
- handle
properties:
id:
type: integer
format: int32
readOnly: true
name:
type: string
handle:
type: string
pattern: '^[a-zA-Z0-9-]{0,62}$'
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
deletedAt:
type: string
format: date-time
readOnly: true
Command line used for generation
swagger-codegen generate --input-spec fetched/tenant-service.yaml --lang python --output sdk
Steps to reproduce
Related issues/PRs
I am not able to find a related issue.
Suggest a fix/enhancement
Unsure.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the reported swagger-codegen command with the supplied YAML declaration and inspect the generated Python Tenant model. Trace handling of the nested $ref to Tenant/properties/name and compare the result with all six properties in the Tenant definition. Done means the reference has the correct type and the generated model retains the complete Tenant property set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100