Şema, giriş/çıkış verilerinin biçimini tanımlamak için kullanılır. Bir OpenAPI 3.0 şema nesnesinin seçili alt kümesini temsil eder. İleride gerekirse daha fazla alan eklenebilir.
İmza:
export interface FunctionDeclarationSchemaProperty
Özellikler
Özellik | Tür | Açıklama |
---|---|---|
description | dize | İsteğe bağlı. Tesisin açıklaması. |
enum | dize[] | İsteğe bağlı. Özelliğin sıralaması. |
örnek | bilinmiyor | İsteğe bağlı. Mülkün örneği. |
biçim | dize | İsteğe bağlı. Özelliğin biçimi. |
items | FunctionDeclarationSchema | İsteğe bağlı. Mülkün öğeleri. FunctionDeclarationSchema |
null değer | boolean | İsteğe bağlı. Mülkün boş değerli olup olmadığı. |
özellikler | { [k: string]: FunctionDeclarationSchema; } | İsteğe bağlı. FunctionDeclarationSchema haritası. |
zorunlu | dize[] | İsteğe bağlı. Zorunlu özellik dizisi. |
tür | FunctionDeclarationSchemaType | İsteğe bağlı. Mülkün türü. FunctionDeclarationSchemaType alt türünü değiştirebilirsiniz. |
FunctionDeclarationSchemaProperty.açıklaması
İsteğe bağlı. Tesisin açıklaması.
İmza:
description?: string;
FunctionDeclarationSchemaProperty.enum adresine gidin
İsteğe bağlı. Özelliğin sıralaması.
İmza:
enum?: string[];
FunctionDeclarationSchemaProperty.örnek
İsteğe bağlı. Mülkün örneği.
İmza:
example?: unknown;
FunctionDeclarationSchemaProperty.format
İsteğe bağlı. Özelliğin biçimi.
İmza:
format?: string;
FunctionDeclarationSchemaProperty.items öğeleri
İsteğe bağlı. Mülkün öğeleri. FunctionDeclarationSchema
İmza:
items?: FunctionDeclarationSchema;
FunctionDeclarationSchemaProperty.nullable (İşlev DeclarationSchemaProperty.nullable)
İsteğe bağlı. Mülkün boş değerli olup olmadığı.
İmza:
nullable?: boolean;
FunctionDeclarationSchemaProperty.properties
İsteğe bağlı. FunctionDeclarationSchema haritası.
İmza:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
FunctionDeclarationSchemaProperty.gerekli
İsteğe bağlı. Zorunlu özellik dizisi.
İmza:
required?: string[];
FunctionDeclarationSchemaProperty.type [İşlevDeclarationSchemaProperty.type]
İsteğe bağlı. Mülkün türü. FunctionDeclarationSchemaType alt türünü değiştirebilirsiniz.
İmza:
type?: FunctionDeclarationSchemaType;