Struct JsonSchema

pub struct JsonSchema {

    pub ref: String,
    pub title: String,
    pub description: String,
    pub default: String,
    pub read_only: bool,
    pub example: String,
    pub multiple_of: f64,
    pub maximum: f64,
    pub exclusive_maximum: bool,
    pub minimum: f64,
    pub exclusive_minimum: bool,
    pub max_length: u64,
    pub min_length: u64,
    pub pattern: String,
    pub max_items: u64,
    pub min_items: u64,
    pub unique_items: bool,
    pub max_properties: u64,
    pub min_properties: u64,
    pub required: Vec<String>,
    pub array: Vec<String>,
    pub type: Vec<i32>,
    pub format: String,
    pub enum: Vec<String>,
    pub field_configuration: Option<FieldConfiguration>,
    pub extensions: HashMap<String, Value>,
}

JSONSchema represents properties from JSON Schema taken, and as used, in the OpenAPI v2 spec.

This includes changes made by OpenAPI v2.

See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

See also: https://cswr.github.io/JsonSchema/spec/basic_types/, https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json

Example:

message SimpleMessage { option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { json_schema: { title: “SimpleMessage” description: “A simple message.” required: [“id”] } };

// Id represents the message identifier.
string id = 1; [
    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
      description: "The unique identifier of the simple message."
    }];

}

Fields

ref: String

Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference, and that type must be imported into the protofile. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp".

title: String

The title of the schema.

description: String

A short description of the schema.

default: String

read_only: bool

example: String

A free-form property to include a JSON example of this field. This is copied verbatim to the output swagger.json. Quotes must be escaped. This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

multiple_of: f64

maximum: f64

Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,

exclusive_maximum: bool

minimum: f64

minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,

exclusive_minimum: bool

max_length: u64

min_length: u64

pattern: String

max_items: u64

min_items: u64

unique_items: bool

max_properties: u64

min_properties: u64

required: Vec<String>

array: Vec<String>

Items in ‘array’ must be unique.

type: Vec<i32>

format: String

Format

enum: Vec<String>

Items in enum must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1

field_configuration: Option<FieldConfiguration>

Additional field level properties used when generating the OpenAPI v2 file.

extensions: HashMap<String, Value>

Custom properties that start with “x-” such as “x-foo” used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

Implementations

impl JsonSchema

pub fn type( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<JsonSchemaSimpleTypes>>

Returns an iterator which yields the valid enum values contained in type.

pub fn push_type(&mut self, value: JsonSchemaSimpleTypes)

Appends the provided enum value to type.

Trait Implementations

impl Clone for JsonSchema

fn clone(&self) -> JsonSchema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsonSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsonSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for JsonSchema

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for JsonSchema

fn eq(&self, other: &JsonSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JsonSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JsonSchema