cebe / cebe/php-openapi

allOf validation not working?

Offen
#120 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
good first issue hacktoberfest help wanted
Vorherrschende Sprache
PHP
Sterne
500
Forks
99
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Hi, I'm having issues getting an example spec using `allOf` to work. This is the spec, as provided by the [OpenAPI docs](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/):

```yml
openapi: 3.0.0
info:
title: AllOf.v1
version: '1.0'
servers:
- url: 'http://localhost:3000'
paths:
/pets:
patch:
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Cat'
- $ref: '#/components/schemas/Dog'
discriminator:
propertyName: pet_type
responses:
'200':
description: Updated
components:
schemas:
Pet:
type: object
required:
- pet_type
properties:
pet_type:
type: string
Dog: # "Dog" is a value for the pet_type property (the discriminator value)
allOf: # Combines the main `Pet` schema with `Dog`-specific properties
- $ref: '#/components/schemas/Pet'
- type: object
# all other properties specific to a `Dog`
properties:
bark:
type: boolean
breed:
type: string
enum: [ Dingo, Husky, Retriever, Shepherd ]
Cat: # "Cat" is a value for the pet_type property (the discriminator value)
allOf: # Combines the main `Pet` schema with `Cat`-specific properties
- $ref: '#/components/schemas/Pet'
- type: object
# all other properties specific to a `Cat`
properties:
hunts:
type: boolean
age:
type: integer
```
My test attempts to send a JSON `PATCH` request to the `/pets` endpoint, using:
```php
[
'pet_type' => 'Cat',
'age' => 3,
'hunts' => true,
]
```
However, this only results in:
```sh
Request body did not match provided JSON schema.
```
Digging in a bit more, it appears that the validator doesn't see the `pet_type` property it should be inheriting from the `Pet` component.

Any experience with this, or ideas? Thanks in advance.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Reproduziere die JSON-PATCH-Anfrage gegen `/pets` unter Verwendung des bereitgestellten OpenAPI-Dokuments und der `allOf`-Referenz des `Cat`-Schemas auf `Pet`. Verfolge, wie der Validator `Pet` und dessen geerbte Eigenschaft `pet_type` auflöst, und stelle anschließend fest, ob die Anfrage akzeptiert wird oder warum die Validierung sie ablehnt. Im Issue sind keine Projektdateien oder Tests genannt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, php
Bereich
api
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.