Navigation
API > API/Plugins > API/Plugins/WebAPIOpenAPI
https://swagger.io/specification/#schema-object
| Name | FSchemaObject |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIOpenAPI/Public/V3/WebAPIOpenAPISchema.h |
| Include Path | #include "V3/WebAPIOpenAPISchema.h" |
Syntax
class FSchemaObject : public UE::WebAPI::OpenAPI::V3::FSchemaObjectBase
Inheritance Hierarchy
- FSchemaObjectBase → FSchemaObject
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | FSchemaObjectBase | V3/WebAPIOpenAPISchema.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdditionalProperties | TOptional< FString > | V3/WebAPIOpenAPISchema.h | ||
| AllOf | TOptional< TArray< Json::TJsonReference< FSchemaObject > > > | V3/WebAPIOpenAPISchema.h | ||
| AnyOf | TOptional< TArray< Json::TJsonReference< FSchemaObject > > > | V3/WebAPIOpenAPISchema.h | ||
| bExclusiveMaximum | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| bExclusiveMinimum | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| bNullable | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| bReadOnly | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| bUniqueItems | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| bWriteOnly | TOptional< bool > | V3/WebAPIOpenAPISchema.h | ||
| Default | TOptional< FString > | V3/WebAPIOpenAPISchema.h | ||
| Discriminator | TOptional< Json::TJsonReference< FDiscriminatorObject > > | V3/WebAPIOpenAPISchema.h | ||
| Enum | TOptional< TArray< FString > > | V3/WebAPIOpenAPISchema.h | ||
| Example | TSharedPtr< FJsonObject > | V3/WebAPIOpenAPISchema.h | ||
| ExternalDocs | TOptional< TSharedPtr< FExternalDocumentationObject > > | V3/WebAPIOpenAPISchema.h | ||
| Format | TOptional< FString > | V3/WebAPIOpenAPISchema.h | ||
| Items | TOptional< Json::TJsonReference< FSchemaObject > > | V3/WebAPIOpenAPISchema.h | ||
| Maximum | TOptional< float > | V3/WebAPIOpenAPISchema.h | ||
| MaxItems | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| MaxLength | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| MaxProperties | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| Minimum | TOptional< float > | V3/WebAPIOpenAPISchema.h | ||
| MinItems | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| MinLength | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| MinProperties | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| MultipleOf | TOptional< int32 > | V3/WebAPIOpenAPISchema.h | ||
| Not | TOptional< TArray< Json::TJsonReference< FSchemaObject > > > | V3/WebAPIOpenAPISchema.h | ||
| OneOf | TOptional< TArray< Json::TJsonReference< FSchemaObject > > > | V3/WebAPIOpenAPISchema.h | ||
| Pattern | TOptional< FString > | V3/WebAPIOpenAPISchema.h | ||
| Properties | TOptional< TMap< FString, Json::TJsonReference< FSchemaObject > > > | V3/WebAPIOpenAPISchema.h | ||
| Title | TOptional< FString > | V3/WebAPIOpenAPISchema.h | ||
| Type | TOptional< FString > | MAY be extended with Specification Extensions. | V3/WebAPIOpenAPISchema.h | |
| Xml | TOptional< TSharedPtr< FString > > | V3/WebAPIOpenAPISchema.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool FromJson
(
const TSharedRef< FJsonObject >& InJson |
V3/WebAPIOpenAPISchema.h |