Apicurio-studio: Die Pfadreihenfolge in der yml-API ist nicht geordnet und stimmt nicht mit dem Pfad in der Benutzeroberfläche überein

Ups, Entschuldigung, ich habe vergessen, die YML anzuhängen, die ich für die ReDoc-Screenshots verwendet habe
(Dasjenige, das ich eingefügt habe, hat keine Operationen, daher generiert ReDoc ein leeres Dokument.)

openapi: 3.0.2
info:
    title: 'Test API'
    version: 1.0.0
paths:
    '/foo/{id_foo}':
        get:
            summary: 'Obtain a foo'
            parameters:
                -
                    name: id_foo
                    in: path
                    required: true
                    schema:
                        type: number
            responses:
                '201':
                    description: 'A foo'
    /bar:
        post:
            summary: 'Create a bar'
            responses:
                '200':
                    description: 'A bar'
    '/bar/{id_bar}':
        get:
            summary: 'Obtain a bar'
            parameters:
                -
                    name: id_bar
                    in: path
                    required: true
                    schema:
                        type: number
            responses:
                '201':
                    description: 'Bar created'
    /foo:
        post:
            summary: 'Create a foo'
            responses:
                '200':
                    description: 'Foo created'

Dies ist ein interessantes Thema, das überraschenderweise noch nie zuvor aufgetreten ist! Es gibt tatsächlich einige Stellen in der Benutzeroberfläche, an denen wir meiner Meinung nach Ihre Option C bereitstellen sollten - die Elemente in der Reihenfolge anzeigen, in der sie im Dokument erscheinen, aber Optionen zum Sortieren und Neuordnen anbieten (vermutlich per Drag & Drop).

Eine vorübergehende Lösung wäre jedoch, die Pfade und andere Listen zu sortieren, bevor der Inhalt an ReDoc übergeben wird. Das wäre schnell und einfach zu erledigen und würde das spezifische Problem der Apicurio-Vorschaufunktion beheben.

Irgendwelche Gedanken/Ideen dazu, @jsenko ?

Ich bin auch auf diese Probleme gestoßen; Meine Beobachtung dazu ist, dass APICURIO einfach eine neue Definition an die aktuelle YAML anhängt, wenn wir neue Pfade erstellen; oder wenn wir yaml vollständig ersetzen (zum Beispiel für einzelne Pfade, wenn ich etwas auf der Registerkarte „Quelle“ ändere).

Ich bearbeite die Datenbank manuell, um dies zu beheben, nachdem ich YAML selbst geändert habe (dann aktualisiere ich die Spalte), und irgendwie ist alles kaputt gegangen, dass ich das Projekt entfernen und neu starten muss.

Wie @EricWittmann sagte, denke ich, dass es am besten ist, die Pfade und andere Listen zu sortieren, bevor der Inhalt an ReDoc übergeben wird, oder wir könnten eine andere Schaltfläche auf der Registerkarte „Quelle“ neben der Schaltfläche „Format“ verwenden (vielleicht mit der Bezeichnung „Pfade sortieren“). die wir selbst bewältigen können.

Wie bei #394 denke ich, dass die allgemeine Idee hier ist, dass die Apicurio-Benutzeroberfläche der YAML-Reihenfolge für alle Arten von Elementen (Pfade, Felder, wahrscheinlich Datentypen) entsprechen sollte, da diese Reihenfolge manchmal wichtig ist (z. B. zum Generieren von Dokumentation).

Eine einfache Sache, die hier hilfreich wäre, besteht darin, die Schaltfläche Speichern zu aktivieren, wenn Sie die rohe YAML bearbeiten und nur die Reihenfolge der Elemente ändern. Derzeit ist Apicurio etwas zu schlau und blendet den Speichern-Button aus, wenn sich nur die Reihenfolge der Elemente geändert hat.

Ich denke, das Beste ist, dass die Reihenfolge in der Benutzeroberfläche der Quelle entspricht (wie erwähnt) und dass die Benutzer Dinge per Drag & Drop verschieben können. Das ist keine triviale Änderung, aber meiner Meinung nach das Richtige. Gedanken @jsenko ?