Using a reference in items of array results in error

Offen

#464 erstellt am 15.2.2023 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

@joschi arbeitet bereits daran.

Seit 26.2.2023.

#470 von @joschi — offen

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 20/100

Issue-Typ: Bug
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java
Bereich: api

Rechercherichtung

Beginne mit der angehängten example.zip und reproduziere den CLI-Befehl; lies dann RefPointer.java, insbesondere getRefName und resolveRef, zusammen mit dem im Trace genannten Aufrufpfad von SchemaDiff und DeferredSchemaCache. Als erledigt gilt die Aufgabe, wenn der $ref zur Geschwisterdatei des Array-Elements ohne die Ausnahme Invalid ref aufgelöst wird und der Vergleich abgeschlossen wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

duplicate

When a reference is used in items: of an array, e.g. :

type: object
description: Model for response from call to GET products requiring an array of products to be returned.
title: GetProductResponse
properties:
  Products:
    type: array
    items:
      $ref: Product.yaml

and error is thrown while resolving the references:

$ java -jar openapi-diff-cli-2.1.0-beta.4-all.jar --error --fail-on-incompatible source/specification/openapi.yaml destination/specification/openapi.yaml
Unexpected exception. Reason: Invalid ref: ./common/models/Product.yaml
java.lang.IllegalArgumentException: Invalid ref: ./common/models/Product.yaml
        at org.openapitools.openapidiff.core.utils.RefPointer.getRefName(RefPointer.java:60)
        at org.openapitools.openapidiff.core.utils.RefPointer.resolveRef(RefPointer.java:16)
        at org.openapitools.openapidiff.core.compare.SchemaDiff.computeDiffForReal(SchemaDiff.java:337)
        at org.openapitools.openapidiff.core.model.deferred.DeferredSchemaCache.processSchemaQueue(DeferredSchemaCache.java:86)
        at org.openapitools.openapidiff.core.model.deferred.DeferredSchemaCache.process(DeferredSchemaCache.java:64)
        at org.openapitools.openapidiff.core.compare.OpenApiDiff.compare(OpenApiDiff.java:100)
        at org.openapitools.openapidiff.core.compare.OpenApiDiff.compare(OpenApiDiff.java:64)
        at org.openapitools.openapidiff.core.OpenApiCompare.fromSpecifications(OpenApiCompare.java:102)
        at org.openapitools.openapidiff.core.OpenApiCompare.fromLocations(OpenApiCompare.java:91)
        at org.openapitools.openapidiff.cli.Main.main(Main.java:175)

Files GetProductResponse.yaml and Product.yaml both reside in the same directory.

Attachment contains the source and destination folders, which contain a copy of the same openapi spec.
example.zip

Vorherrschende Sprache: Java
Sterne: 1.1k
Forks: 190
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus OpenAPITools/openapi-diff

In openapi-diff-cli add old and new filenames to the output Offen

enhancement

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#506 · Erstellt am 04.4.2023
HtmlRender: Notes of Parameters shows always the new description Offen

good first issue help wanted

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#364 · Erstellt am 05.4.2022
Property `type` change on referenced component schema is silently ignored Offen

bug OpenAP 3.1.0 Support

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100

OpenAPITools/openapi-diff#910 · 1 Kommentar · Erstellt am 12.6.2026
Changes reported in operations but only securityScheme changed Offen

Render capabilities

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

OpenAPITools/openapi-diff#893 · 1 Kommentar · Erstellt am 25.2.2026
[Bug] Backward compatibility check fails on reordered discriminator mappings Offen

Breaking/Non-Breaking classification

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

OpenAPITools/openapi-diff#886 · Erstellt am 30.1.2026

Alle Issues in OpenAPITools/openapi-diff