4.3. Notices and Remarks (Avis et remarques)
4.3. Notices and Remarks (Avis et remarques)
Les structures de données "notices" et "remarks" prennent la même forme. La structure notices désigne des informations sur le service fournissant des informations RDAP et/ou des informations sur l'ensemble de la réponse, tandis que la structure remarks désigne des informations sur la classe d'objet qui la contient (voir la section 5 concernant les classes d'objets).
Les deux sont des tableaux d'objets. Chaque objet contient une chaîne "title" représentant le titre de l'objet, une chaîne "type" désignant un type enregistré de remarque ou d'avis (voir la section 10.2.1), un tableau de chaînes nommé "description" aux fins de transmettre tout texte descriptif, et un tableau "links" tel que décrit dans la section 4.2. Le tableau "description" DOIT être inclus. Toutes les autres valeurs JSON sont OPTIONNELLES.
Un exemple de la structure de données notices:
"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"
}
]
}
]
C'est le travail des clients de déterminer les sauts de ligne, l'espacement et les problèmes d'affichage pour les phrases dans les chaînes de caractères du tableau "description". Chaque chaîne dans le tableau "description" contient une division complète unique de texte lisible par l'homme indiquant aux clients où se trouvent les ruptures sémantiques.
Un exemple de la structure de données remarks:
"remarks" :
[
{
"description" :
[
"She sells sea shells down by the sea shore.",
"Originally written by Terry Sullivan."
]
}
]
Notez que les objets dans le tableau "remarks" peuvent également avoir un tableau "links".
Bien que les champs "title" et "description" soient principalement destinés à la consommation humaine, la chaîne "type" contient une valeur bien connue à enregistrer auprès de l'IANA (voir la section 10.2.1) pour une utilisation programmatique.
Un exemple de la structure de données remarks:
"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."
]
}
]
Alors que le tableau "remarks" apparaîtra dans de nombreuses classes d'objets dans une réponse, le tableau "notices" apparaît uniquement dans l'objet le plus haut d'une réponse.