validator-api.yml

openapi: "3.0.0"

info:
  description: >
    API permettant d'appeler [IGNF/validator](https://github.com/IGNF/validator) pour valider et normaliser des dossiers contenant une arborescence de fichiers.


    Pour signaler un problème : [tickets GitHub](https://github.com/IGNF/validator-api/issues).


    **Authentification** : créer, modifier et supprimer une validation nécessite d'être authentifié.
    Seul le créateur d'une validation peut la modifier ou la supprimer.
    La consultation d'une validation (et de ses rapports) reste publique.
  version: "0.7.14"
  title: "API Validator"
  license:
    name: "AGPL-3.0-or-later"
    url: "https://www.gnu.org/licenses/agpl-3.0.txt"

tags:
  - name: "Validation"
    description: "Une demande de validation de documents"

paths:

  /api/validations/:
    get:
      tags:
        - Validation
      operationId: list_validations
      summary: "Lister les validations"
      description: "Liste paginée des validations de l'utilisateur authentifié, ou de toutes les validations pour les administrateurs (rôle client OIDC_ADMIN_ROLE), des plus récentes aux plus anciennes. Indisponible (405) sans authentification activée."
      security:
        - bearerAuth: []
        - cookieAuth: []
      parameters:
        - name: page
          in: query
          description: "Numéro de page (à partir de 1)"
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: "Nombre de validations par page"
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: status
          in: query
          description: "Filtre sur le statut"
          schema:
            type: string
        - name: owner
          in: query
          description: "Filtre sur l'identifiant (sub) du créateur (administrateurs uniquement, ignoré pour les autres utilisateurs)"
          schema:
            type: string
      responses:
        200:
          description: "Page de validations"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationPage"
        401:
          $ref: "#/components/responses/Unauthorized"
        405:
          description: "Authentification désactivée sur l'instance"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      tags:
        - Validation
      operationId: upload_dataset
      summary: "Téléverser un jeu de données à faire valider"
      description: "Téléverser un jeu de données sur le serveur afin demander une validation plus tard"
      security:
        - {}
        - bearerAuth: []
        - cookieAuth: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                dataset:
                  type: string
                  format: binary
      responses:
        201:
          description: "Téléversement réussi"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Validation"
        400:
          description: Jeu de données (dans un fichier compressé .zip) manquant, autre type de fichier fourni ou nom de fichier invalide (le nom sans .zip doit respecter ^[A-Za-z0-9_][A-Za-z0-9_.-]{0,99}$)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        401:
          $ref: "#/components/responses/Unauthorized"
        429:
          description: Trop de demandes depuis cette adresse IP ou pour cet utilisateur (VALIDATION_RATE_LIMIT par heure)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /api/validations/{uid}:
    get:
      tags:
        - Validation
      operationId: get_validation
      summary: "Voir une validation"
      description: "Voir les détails d'une demande de validation"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        200:
          description: Récupération réussie
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Validation"
        400:
          description: "Paramètre uid manquant"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: "Aucune demande de validation ne correspond à l'uid"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

    patch:
      tags:
        - Validation
      security:
        - {}
        - bearerAuth: []
        - cookieAuth: []
      operationId: update_arguments
      summary: "Préciser les arguments de validator"
      description: "Préciser les arguments et les options pour le programme ligne de commandes Validator"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ValArgs"
      responses:
        200:
          description: "Mise à jour réussie"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Validation"
        400:
          description: Paramètres uid ou arguments manquants, ou certains des arguments fournis ne sont pas autorisés
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        401:
          $ref: "#/components/responses/Unauthorized"
        403:
          description: La validation a été archivée (par défaut 5 jours après la création), ou l'utilisateur n'est ni le créateur de la validation ni un administrateur
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: Aucune demande de validation ne correspond à l'uid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        409:
          description: La validation est en cours de traitement
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        429:
          description: Trop de demandes depuis cette adresse IP ou pour cet utilisateur (VALIDATION_RATE_LIMIT par heure)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

    delete:
      tags:
        - Validation
      operationId: delete_validation
      security:
        - {}
        - bearerAuth: []
        - cookieAuth: []
      summary: "Supprimer une validation"
      description: "Demander la suppression de la validation et tous les fichiers qui lui sont associés"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        204:
          description: "Suppression réussie"
        400:
          description: Paramètres uid manquant
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: Aucune demande de validation ne correspond à l'uid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        401:
          $ref: "#/components/responses/Unauthorized"
        403:
          $ref: "#/components/responses/Forbidden"
        409:
          description: La validation est en cours de traitement
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /api/validations/{uid}/results.csv:
    get:
      tags:
        - Validation
      operationId: get_validation_csv
      summary: "Télécharger le résultat au format CSV"
      description: "Télécharger le résultat au format CSV"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        200:
          description: Récupération réussie
          content:
            text/csv: {}
        403:
          description: La validation n'a pas encore été exécutée
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: "Aucune demande de validation ne correspond à l'uid, ou la validation n'a pas de résultats"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /api/validations/{uid}/report:
    get:
      tags:
        - Validation
      operationId: get_validation_report
      summary: "Consulter le rapport imprimable"
      description: "Rapport de validation au format HTML, à imprimer ou enregistrer en PDF avec le navigateur. Le paramètre print ouvre directement la boîte de dialogue d'impression."
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
        - description: "Ouvre la boîte de dialogue d'impression du navigateur"
          in: query
          name: print
          required: false
          schema:
            type: string
      responses:
        200:
          description: Récupération réussie
          content:
            text/html: {}
        403:
          description: La validation n'a pas encore été exécutée
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: "Aucune demande de validation ne correspond à l'uid, ou la validation n'a pas de résultats"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /api/validations/{uid}/logs:
    get:
      tags:
        - Validation
      operationId: get_validation_logs
      summary: "Consulter les logs du validateur"
      description: "Log d'exécution de validator-cli.jar (validator-debug.log), disponible aussi pour les validations en erreur"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        200:
          description: Récupération réussie
          content:
            text/plain: {}
        403:
          description: La validation a été archivée
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: "Aucune demande de validation ne correspond à l'uid, ou aucun log n'est disponible"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"


  /api/validations/{uid}/files/source:
    get:
      tags:
        - Validation
      summary: "Télécharger les données de source"
      description: "Télécharger les données de source dans un fichier compressé (zip) et nommé {nom_dataset}-source.zip"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        200:
          description: "Contenu téléchargeable trouvé"
          content:
            application/zip:
              schema:
                format: binary
        403:
          description: Téléchargement désactivé sur cette instance (DATA_DOWNLOAD_ENABLED), ou aucun contenu téléchargeable trouvé parce que la validation a été archivée (par défaut 5 jours après la création)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: Aucune demande de validation ne correspond à l'uid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

  /api/validations/{uid}/files/normalized:
    get:
      tags:
        - Validation
      summary: "Télécharger les données normalisées"
      description: "Télécharger les données normalisées générées par le validateur dans un fichier compressé (zip) nommé {nom_dataset}-normalized.zip"
      parameters:
        - description: "Identifiant unique de la validation"
          in: path
          name: uid
          required: true
          schema:
            type: string
          example: g7258vq1t639uagbv8rg7b97
      responses:
        200:
          description: "Contenu téléchargeable trouvé"
          content:
            application/zip:
              schema:
                format: binary
        403:
          description: Téléchargement désactivé sur cette instance (DATA_DOWNLOAD_ENABLED), ou aucun contenu téléchargeable trouvé parce que soit la validation n'a pas encore été exécutée, elle a été archivée (par défaut 5 jours après la création), ou bien elle a terminé en une erreur
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        404:
          description: Aucune demande de validation ne correspond à l'uid
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"


components:
  securitySchemes:
    bearerAuth:
      description: "Jeton d'accès (JWT) délivré par le fournisseur OIDC (OIDC_ISSUER_URL), dont l'audience contient OIDC_CLIENT_ID"
      type: http
      scheme: bearer
      bearerFormat: JWT
    cookieAuth:
      description: "Session de la démo, après connexion sur /login"
      type: apiKey
      in: cookie
      name: PHPSESSID

  responses:
    Unauthorized:
      description: "Authentification requise (authentification activée sur l'instance)"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
    Forbidden:
      description: "Seuls le créateur de la validation et les administrateurs peuvent la modifier ou la supprimer"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"

  schemas:

    Validation:
      description: "Une validation avec ses informations et ses résultats"
      type: object
      properties:
        uid:
          type: string
          example: g7258vq1t639uagbv8rg7b97
        status:
          type: string
          enum:
            - waiting_for_args
            - pending
            - processing
            - finished
            - error
            - archived
          example: waiting_for_args
        dataset_name:
          type: string
          example: 130010853_PM3_60_20180516
        arguments:
          type: object
          example: null
        date_creation:
          type: string
          example: "2020-10-14T17:46:54+02:00"
        message:
          type: string
          example: null
        date_start:
          type: string
          example: null
        date_finish:
          type: string
          example: null
        results:
          description: "Erreurs et avertissements du validateur, ou erreurs de pré-validation de l'archive zip (sans level)"
          type: array
          nullable: true
          items:
            type: object
            properties:
              level:
                type: string
                example: ERROR
              code:
                type: string
                example: FILE_EMPTY
              message:
                type: string
              file:
                type: string
          example: null
        document_info:
          description: "Métadonnées du document extraites par le validateur. Uniquement disponible lorsque la validation a été exécutée avec l'argument \"normalize\" activé"
          type: object
          example: null
        delete_data:
          description: "Suppression des données à la fin de la validation (argument delete-data)"
          type: boolean
          example: false
        can_edit:
          description: "L'utilisateur courant peut modifier et supprimer la validation (toujours vrai sans authentification)"
          type: boolean
          example: true

    ValidationPage:
      type: object
      properties:
        items:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/Validation"
              - type: object
                properties:
                  owner:
                    description: "Identifiant (sub) du créateur"
                    type: string
                    nullable: true
                  owner_name:
                    description: "Nom du créateur à la création"
                    type: string
                    nullable: true
        total:
          type: integer
          example: 42
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20

    Error:
      type: object
      properties:
        code:
          type: integer
          description: code HTTP de l'erreur rencontrée
          example: 400
        status:
          type: string
          description: libellé du code HTTP
          example: Bad Request
        message:
          type: string
          description: message précis de l'erreur rencontrée
        details:
          type: array
          description: "détail des erreurs (ex : arguments invalides)"
          items:
            type: object

    ValArgs:
      $ref: "./schema/validator-arguments.json#/"