4.3. Notices and Remarks (Hinweise und Anmerkungen)

4.3. Notices and Remarks (Hinweise und Anmerkungen)

Die Datenstrukturen "notices" und "remarks" haben dieselbe Form. Die notices-Struktur bezeichnet Informationen über den Dienst, der RDAP-Informationen bereitstellt, und/oder Informationen über die gesamte Antwort, während die remarks-Struktur Informationen über die Objektklasse bezeichnet, die sie enthält (siehe Abschnitt 5 bezüglich Objektklassen).

Beide sind Arrays von Objekten. Jedes Objekt enthält eine "title"-Zeichenkette, die den Titel des Objekts darstellt, eine "type"-Zeichenkette, die einen registrierten Typ von Anmerkung oder Hinweis bezeichnet (siehe Abschnitt 10.2.1), ein Array von Zeichenketten namens "description" zum Zweck der Übermittlung beschreibenden Textes und ein "links"-Array, wie in Abschnitt 4.2 beschrieben. Das "description"-Array MUSS enthalten sein. Alle anderen JSON-Werte sind OPTIONAL.

Ein Beispiel für die notices-Datenstruktur:

"notices" :
[
  {
    "title" : "Terms of Use",
    "description" :
    [
      "Service subject to The Registry of the Moon's TOS.",
      "Copyright (c) 2020 LunarNIC"
    ],
    "links" :
    [
      {
        "value" : "https://example.net/entity/XXXX",
        "rel" : "alternate",
        "type" : "text/html",
        "href" : "https://www.example.com/terms_of_use.html"
      }
    ]
  }
]

Es ist die Aufgabe der Clients, Zeilenumbrüche, Abstände und Anzeigeprobleme für Sätze innerhalb der Zeichenketten des "description"-Arrays zu bestimmen. Jede Zeichenkette im "description"-Array enthält eine einzelne vollständige Unterteilung von menschenlesbarem Text, die den Clients anzeigt, wo semantische Unterbrechungen vorliegen.

Ein Beispiel für die remarks-Datenstruktur:

"remarks" :
[
  {
    "description" :
    [
      "She sells sea shells down by the sea shore.",
      "Originally written by Terry Sullivan."
    ]
  }
]

Beachten Sie, dass Objekte im "remarks"-Array auch ein "links"-Array haben können.

Während die Felder "title" und "description" in erster Linie für den menschlichen Gebrauch bestimmt sind, enthält die "type"-Zeichenkette einen bekannten Wert, der bei IANA registriert werden soll (siehe Abschnitt 10.2.1) für programmatische Nutzung.

Ein Beispiel für die remarks-Datenstruktur:

"remarks" :
[
  {
    "type" : "object truncated due to authorization",
    "description" :
    [
      "Some registration data may not have been given.",
      "Use proper authorization credentials to see all of it."
    ]
  }
]

Während das "remarks"-Array in vielen Objektklassen in einer Antwort erscheint, erscheint das "notices"-Array nur im obersten Objekt einer Antwort.