cebe / cebe/php-openapi

[RFC] Handle OpenAPI 3.1 BC Breaks

Offen
#130 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
openapi 3.1
Vorherrschende Sprache
PHP
Sterne
500
Forks
99
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

It's nice to see the work for the OpenAPI 3.1 standard. I think a big part are the deprecated fields or type changes like:
- The nullable keyword has been removed from the Schema Object (null can be used as a type value).
- the type can be now an array with the type and `null`
- exclusiveMaximum and exclusiveMinimum cannot accept boolean values (following JSON Schema).
- See more at [Stoplight Blog](https://blog.stoplight.io/difference-between-open-v2-v3-v31) and [OpenAPI Release Notes](https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0-rc0)

How would you like to handle these breaking changes?
My first idea was to duplicate the spec files into a 3.0 and 3.1 Folder and use them according to the given OpenAPI version.
The positive parts are that static code analysis or the IDE knows which type of Object is used and the user don't have to handle multiple types. For example the `type` as string in OpenAPi 3.0 and `type` as array in OpenAPI 3.1 with null item. Also the spec could be validated and it's not necessary to add version switches for fields that are required or not.

The second Idea is to "convert" the Structure into the existing Spec Files. So a type with two items in OpenAPI would be an `oneOf` or if the type includes `null` the nullable flag would be added. But then you need to convert the items back to the new structure if you want to write a OpenAPI 3.1 file. The other part is, that you then support a converter from OpenAPI 3.0 to OpenAPI 3.1 and i don't think this is a feature to maintain in this library.

The last solution is to try to handle both versions into a single file. But that could be hard because of the breaking changes in OpenAPI 3.1. Even OpenAPI 3.1 didn't make a release without breaking changes. It could be complex to handle it here.

My preferred solution is version one because of the strict types and the clear break between Version 3.0 and 3.1
The Version and Specs for Version 3.0 are already feature complete and all changes effects only the new Spec files and couldn't break anything.

I look forward to your opinion. Maybe this should be clear before we make more changes into https://github.com/cebe/php-openapi/pull/128 ?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Lesen Sie zunächst die vorhandenen OpenAPI 3.0-Spezifikationsdateien und die Änderungen in pull request 128, und vergleichen Sie sie anschließend mit den aufgeführten Breaking Changes von OpenAPI 3.1 und den verknüpften Release Notes. Dieser RFC ist erst abgeschlossen, wenn die Maintainer einen Ansatz zur Darstellung von 3.1 ausgewählt und dokumentiert haben, ohne die abgeschlossene Unterstützung für 3.0 zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, php
Bereich
api, backend-api-design
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
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.