swagger-api / swagger-api/swagger-ui
Discriminator property in component disappears from component when mapping is used under discriminator
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
When I have the discriminator property explicitly listed on the components that are under a oneOf, it disappears when mapping is used under discriminator.
For example with the following document, the example is
{
"prop2": "string"
}
but with mapping removed it changes into
{
"prop2": "string",
"type": "string"
}
OpenAPI document
openapi: 3.0.3
info:
title: ''
version: 0.0.0
paths:
/test/:
post:
operationId: test_create
tags:
- events
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TestPolymorphic'
responses:
'200':
description: ''
components:
schemas:
Test1:
type: object
properties:
prop1:
type: string
type:
type: string
required:
- prop1
- type
Test2:
type: object
properties:
prop2:
type: string
type:
type: string
required:
- prop2
- type
TestPolymorphic:
oneOf:
- $ref: '#/components/schemas/Test2'
- $ref: '#/components/schemas/Test1'
discriminator:
propertyName: type
mapping:
Test2: '#/components/schemas/Test2'
Test1: '#/components/schemas/Test1'
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
Use the OpenAPI document in the issue as the reproduction input and compare the generated example with and without discriminator.mapping. Verify that the discriminator property remains in the component example when mapping is present; no source file or test is identified in the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100