Projet

Général

Profil

Demande #4529

Publier un fichier ServiceInfo pour drop

Ajouté par pitchum . il y a presque 4 ans. Mis à jour il y a plus de 3 ans.

Statut:
Rejeté
Priorité:
Normale
Assigné à:
Début:
03/06/2020
Echéance:
% réalisé:

50%

Temps estimé:

Description

Publier un fichier JSON qui respecte le format ServiceInfo qui serait mis à jour quotidiennement, par exemple à cette adresse : https://drop.chapril.org/_serviceinfo.json

Ce format ServiceInfo est encore expérimental. On est donc encore très libre d'inventer de nouveaux champs si on l'estime utile.
En tout cas, il y a un début de spécification formelle, et je propose de la compléter au fur et à mesure de nos expérimentations sur mon fork du projet ServiceInfo.

Un schéma JSON c'est assez difficile à lire donc pour démarrer rapidement je suggère de partir du fichier ServiceInfo du service XMPP et l'adapter.

Contexte

Chez Chapril on expérimente un mécanisme permettant de publier de façon
automatisée des informations sur les services proposés.
Ces informations pourront alors être collectées par des outils tels que
le site Web https://the-federation.info/ .

On va se baser sur des formalismes déjà existants :

- host-meta : un fichier XML au format XRD (standard normalisé par l'IETF)
- ServiceInfo : un format JSON permettant de décrire un service en ligne

Le fichier host-meta est un point d'entrée pour les crawlers et il est
hébergé sur bastion. On le maintient à la main pour l'instant. Ce
fichier ne changera pas souvent de toute façon, essentiellement à chaque
fois qu'on ajoutera un service. Ce fichier host-meta se contente de
déclarer les services et pour chacun il indique l'URL d'un fichier
JSON au format ServiceInfo à appeler pour obtenir les détails.

Historique

#1

Mis à jour par Romain H. il y a plus de 3 ans

  • Statut changé de Nouveau à En cours de traitement
  • % réalisé changé de 0 à 50

J'ai ajouté le _serviceinfo.json. Il n'y a pas de métriques encore, il faudrait décider lesquelles présenter.

#2

Mis à jour par Christian P. Momon il y a plus de 3 ans

  • Assigné à mis à Romain H.
#3

Mis à jour par pitchum . il y a plus de 3 ans

Tu peux retirer le bloc capabilities, tous ces noms sont spécifiques à XMPP.

"capabilities": [
    {
        "presence": false,
        "mam": false,
        "in-band-registration": false,
        "web-registration": false,
        "storage-quota": "1024",
        "upload-autovaccum": "5d",
        "irc-gateway": false
    }
]

Éventuellement tu pourrais ajouter un truc comme "capabilities": ["client-side-encryption": true] (ou false, je ne sais pas).

Pour les métriques, j'avoue que je n'aime pas le format actuel.
Malgré tout, peux-tu essayer de publier le nombre total de partages effectués et le nombre de partages sur le mois passé ?
(en considérant que 1 partage = 1 utilisateur)

"metrics": [
    {    
        "type": "totalUsers",
        "value": 175
    },
    {    
        "type": "activeUsers",
        "value": 35,
        "periodLength": 604800,
        "startTime": "2020-06-25T08:42:00Z" 
    },
]
#4

Mis à jour par pitchum . il y a plus de 3 ans

  • Assigné à changé de Romain H. à pitchum .
#5

Mis à jour par Christian P. Momon il y a plus de 3 ans

  • Statut changé de En cours de traitement à Rejeté

Remplacé par #4973.

#6

Mis à jour par Christian P. Momon il y a plus de 3 ans

  • Version cible changé de Backlog à Sprint 2020 novembre

Formats disponibles : Atom PDF