Skip to content

Read configuration options from annotations #236

@stuebingerb

Description

@stuebingerb

KGraphQL should respect existing annotations for configuration options like property names (cf. #166), deprecations or ignored properties.

This should be completely optional and ideally not introduce new dependencies for consumers that do not need this functionality (e.g. by having it as a separate module).

Currently planned (open for discussion):

  • @kotlin.Deprecated(<reason>) marks a property as deprecated with reason <reason>
  • @kotlin.jvm.Transient sets the ignored of a property to true
  • @kotlinx.serialization.Transient sets the ignored of a property to true
  • @com.fasterxml.jackson.annotation.JsonIgnore sets the ignored of a property to true
  • @kotlinx.serialization. SerialName(<value>) sets the name of a property to <value>
  • @com.fasterxml.jackson.annotation.JsonProperty(<value>) sets the name of a property to <value>

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestinput wantedTarget solution is not yet clear or more input is wanted on an issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions