openapi-generators / openapi-generators/openapi-python-client
Inline oneOf variants with properties/required fail: "Invalid property in union"
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 2k
- Forks
- 293
- Merge moyen
- 34 min
- PR mergées (30 j)
- 1
Description
Description
When a schema uses oneOf with inline object variants (each having properties and required but no $ref), the generator fails with:
Invalid property in union <property_name>
This happens regardless of whether anyOf or oneOf is used. The issue is that the generator cannot process inline discriminated union variants that define their own properties — it expects $ref pointers to named component schemas.
Minimal Reproduction
openapi: "3.0.3"
info:
title: Test
version: "1.0"
paths: {}
components:
schemas:
MyModel:
type: object
properties:
rules:
type: array
items:
type: object
oneOf:
- properties:
rule_type:
type: string
enum: ["type_a"]
value_a:
type: string
required: ["rule_type", "value_a"]
- properties:
rule_type:
type: string
enum: ["type_b"]
value_b:
type: integer
required: ["rule_type", "value_b"]
$ openapi-python-client generate --path spec.yaml
Unable to process schema /components/schemas/MyModel:
Invalid property in union rules_item
Workaround
Extracting each variant into a named component schema and using $ref works:
components:
schemas:
RuleTypeA:
type: object
properties:
rule_type:
type: string
enum: ["type_a"]
value_a:
type: string
required: ["rule_type", "value_a"]
RuleTypeB:
type: object
properties:
rule_type:
type: string
enum: ["type_b"]
value_b:
type: integer
required: ["rule_type", "value_b"]
MyModel:
type: object
properties:
rules:
type: array
items:
oneOf:
- $ref: "#/components/schemas/RuleTypeA"
- $ref: "#/components/schemas/RuleTypeB"
Related
- #868 — similar "Invalid property in union" error with
anyOf/allOfcombinations - Both inline
oneOfandanyOfvariants trigger the same failure
Version
- openapi-python-client: 0.28.2
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par exécuter openapi-python-client generate --path spec.yaml avec la reproduction minimale et suivez le traitement des unions de schémas qui signale Invalid property in union. Comme aucun fichier source ni chemin de test n’est indiqué dans l’issue, localisez d’abord la gestion existante des variantes oneOf/anyOf basées sur $ref. Le travail est terminé lorsque les variantes inline avec properties et required sont générées correctement, tandis que le workaround documenté de $ref continue de fonctionner.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- tooling
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 52/100