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

use x-tension value in annotation mapping

Open
#190 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Kotlin
Stars
2
Forks
4
Avg merge
4d 55m
Merged PRs (30d)
9

Description

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})

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the extensions mapping syntax shown in the issue and tracing how x-foobar annotations are currently generated. Determine how an x-tension value and an annotation parameter placeholder should be represented, then define what mapping behavior and coverage would demonstrate that the value reaches the generated annotation.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
backend-api-design, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.