Verwenden von Datentypattributen

Name

Name des Datentyps oder der Eigenschaft.

Stammelement für die Datentyp- oder Eigenschaftsdefinition.

Description (Beschreibung)

Beschreibung der Eigenschaft

description

Required (Erforderlich)

Boolescher Wert. Gibt an, ob eine Eigenschaft erforderlich oder optional ist.

• OAS 3.0 und Swagger 2.0: Erforderliche Eigenschaften werden in einem required-Element (erforderlich) auf Objektebene aufgelistet.
• RAML: required (erforderlich)

Restrictions (Einschränkungen)

Legt fest, ob die Eigenschaft im Request, in der Antwort oder in beidem verfügbar ist.

• OAS 3.0: Eigenschaften können über ein writeOnly- oder readOnly-Element (Nur Schreiben / Nur Lesen) mit einem booleschen Wert verfügen.
• Kein entsprechendes Element in Swagger 2.0 oder RAML 1.0.

Examples (Beispiele)

Beispielwerte für die Eigenschaft. Diese Werte können bei Verwendung eines API-Mocks zurückgegeben werden.

• OAS 3.0 und Swagger 2.0: Der erste Wert wird in einem example-Element (Beispiel) verwendet. Andere Werte werden ignoriert.
  InformationshinweisAnmerkung: Die OAS 3.0-Spezifikation umfasst ein examples-Element (Beispiele), dieses wird von Talend Cloud API Designer jedoch nicht unterstützt.
• RAML: examples (Beispiele)

Additional properties (Zusätzliche Eigenschaften)

Boolescher Wert. Gibt an, ob das Objekt Eigenschaften akzeptiert, die nicht in der Datentypdefinition enthalten sind. Diese Option ist standardmäßig aktiviert.

additionalProperties (zusätzliche Eigenschaften)

Min items (Min. Elemente) und Max items (Max. Elemente)

Minimale und maximale Anzahl an Elementen in einem Array.

minItems (min. Elemente) und maxItems (max. Elemente)

Unique items (Eindeutige Elemente)

Boolescher Wert. Gibt an, ob jedes Element in einem Array eindeutig sein muss.

• OAS 3.0 und RAML 1.0: uniqueItems (eindeutige Elemente)
• Kein entsprechendes Element in Swagger 2.0.

Enum

(Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft.

enum

Min length (Min. Länge) und Max length (Max. Länge)

Minimale und maximale Anzahl an Bytes im Wert.

minLength (min. Länge) und maxLength (max. Länge)

Pattern (Muster)

Regulärer Ausdruck, dem der Wert entsprechen muss.

pattern (Muster)

Default (Standard)

Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird.

default (Standard)

Enum

(Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft.

enum

Format

Für eine Zahl bzw. eine Ganzzahl (Integer) zu verwendendes Format.

format

Minimum und Maximum

Mindest- und Höchstwert für eine Zahl bzw. Ganzzahl (Integer).

minimum und maximum

Default (Standard)

Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird.

default (Standard)

Enum

(Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft.

enum

Default (Standard)

Wert, der verwendet wird, wenn ein Wert nicht bereitgestellt wird.

default (Standard)

Enum

(Enumeration/Aufzählung) Mögliche Werte für die Eigenschaft.

enum

Format

Für eine Datums-/Uhrzeitangabe (datetime) zu verwendendes Format.

• RAML 1.0: format (Format)
• OAS 3.0: Die Datums/Uhrzeiteigenschaften in OAS 3.0 werden als Zeichenfolgen (Strings) im Format date-time (Datum-Uhrzeit) definiert. Standardmäßig wird das Datums-/Uhrzeitformat RFC3339 verwendet, wenn jedoch rfc2616 ausgewählt wird, wird ein benutzerdefiniertes date-time-rfc2616-Format verwendet.
• Swagger 2.0: Die Datums-/Uhrzeiteigenschaften werden wie in in OAS 3.0 definiert, Swagger 2.0 bietet jedoch keine Unterstützung für benutzerdefinierte Formate. Diese werden als FC3339 interpretiert, ungeachtet des jeweils ausgewählten Formats.

Min length (Min. Länge) und Max length (Max. Länge)

Minimale und maximale Anzahl an Bytes im Wert.

minLength (min. Länge) und maxLength (max. Länge)

File types (Dateitypen)

Zu verwendender Dateityp im Format */*. Beispiel: image/png

• RAML 1.0: fileTypes (Dateitypen)