package io.apibuilder.spec.v0.models

import com.fasterxml.jackson.annotation.JsonIgnoreProperties
import com.fasterxml.jackson.annotation.JsonProperty
import java.io.Serializable
import kotlin.String

/**
 * This code was generated by [models.generator.kotlin.KotlinGenerator]
 * Used to indicate an API concern for a field that is specific to the field's usage but not
 * necessarily its data type. For example, you might use annotations to mark that certain fields
 * contain PII or PCI data and thus should not be stored once processing is complete. Annotations
 * communicate meaning to consumers of an API and may also be used within an implementation or tooling;
 * for example, using static analysis tools to detect logging of sensitive data.
 */
@JsonIgnoreProperties(ignoreUnknown=true)
data class Annotation(
  @JsonProperty("name")
  @get:JsonProperty("name")
  val name: String,
  @JsonProperty("description")
  @get:JsonProperty("description")
  val description: String?,
  @JsonProperty("deprecation")
  @get:JsonProperty("deprecation")
  val deprecation: Deprecation?
) : Serializable {
  fun toJsonString(): String =
      io.apibuilder.spec.v0.models.JacksonObjectMapperFactory.create().writeValueAsString(this)

  companion object {
    fun parseJson(json: String): Annotation =
        io.apibuilder.spec.v0.models.JacksonObjectMapperFactory.create().readValue( json,
        Annotation::class.java)
  }
}