openapi-processor / openapi-processor/openapi-processor-base

use x-tension value in annotation mapping

Offen
#190 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Kotlin
Sterne
2
Forks
4
Ø Merge
4 T. 55 Min.
Gemergte PRs (30 T.)
9

Beschreibung

Having an x-tension property with value

    Foo:
      type: object
      properties:
        bar:
          type: integer
          x-foobar: raboof

it would probably be nice if I could pass the value to the annotation.

how wold the mapping look like?

  extensions:
    # the mapping expects the source type to be a `string`. It would need 
    # - an identifier to represent the x-tension value and
    # - an identifier as placeholder for the annotation parameter

    # placeholder could look like this
    x-foobar: ?? @ io.openapiprocessor.annotation.Foobar(value = {value})
 
    # value source type could be this?
    x-foobar: {value} @ io.openapiprocessor.annotation.Foobar(value = {value})

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die im Issue gezeigte Syntax der Extensions-Zuordnung zu prüfen und nachzuverfolgen, wie x-foobar-Annotationen derzeit generiert werden. Bestimme, wie ein x-tension-Wert und ein Platzhalter für einen Annotation-Parameter dargestellt werden sollten, und definiere anschließend, welches Zuordnungsverhalten und welche Abdeckung zeigen würden, dass der Wert die generierte Annotation erreicht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
kotlin
Bereich
backend-api-design, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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