Progetto_2023-OVI/flask_be/doc/endpoints.yaml

- /simple_get_query:
    method: 'POST'
    description: "Cerca: 1. occorrenze forme e/o lemmi con opzioni; 2. cooccorrenze di 2+ forme e/o lemmi restituendo direttamente anche i loro contesti."
    input: 
      queryList:
        obj_type: "array"
        element_structure:
          espansa: "0 | 1"
          raddoppiata: "0 | 1"
          stringa": "string"
          tipo: "forma | lemma | lemmaForma | formLemma"
    output:
        obj_type: "array"
        element_structure_v1:
          "cod": "number"
          "forma": "string"
          "occ": "number"
        element_structure_v2:
          "cat_gr": "controlled vocabulary"
          "cod": "number"
          "disambiguatore": "string"
          "lemma": "string"
          "occ": "number"
        element_structure_v3:
          "cat_gr": "controlled vocabulary"
          "cod": "number"
          "disambiguatore": "string"
          "forma": "string"
          "lemma": "string"
          "occ": "number"
        element_structure_v4: "see 'get_context' output"
    splittable: "MAYBE"

- /get_context:
    method: 'POST'
    description: "Ricerca dei contesti di una lista di forme e/o lemmi (--> normalmente selezionati ad interfaccia in base alla risposta ottenuta da una chiamata a simple_get_query)"
    input:
      queryList:
        obj_type: "array"
        element_structure_v1:
          "cod": "number"
          "forma": "string"
          "occ": "number"
          "selected": "bool"
        element_structure_v2:
          "cat_gr": "controlled vocabulary"
          "cod": "number"
          "disambiguatore": "string"
          "lemma": "string"
          "occ": "number"
          "selected": "bool"
        element_structure_v3:
          "cat_gr": "controlled vocabulary"
          "cod": "number"
          "disambiguatore": "string"
          "forma": "string"
          "lemma": "string"
          "occ": "number"
          "selected": "bool"
    output:
      "Anno finale": "number"
      "Anno iniziale": "number"
      "Area generica": "controlled vocabulary (?)"
      "Area specifica": "controlled vocabulary (?)"
      "Autore": "string (authority?)"
      "Curatore": "string (authority?)"
      "Data codificata": "formatted date"
      "Data descrittiva": "human-readable date"
      "Forma": "controlled vocabulary"
      "Genere": "controlled vocabulary"
      "IQ": "controlled vocabulary"
      "Rif_organico": "controlled vocabulary"
      "Rig_completo": "controlled vocabulary"
      "Tipo": "controlled vocabulary"
      "Titolo": "string"
      "Titolo Abbreviato": "string"
      "backup_pfin": "number"
      "backup_piniz": "number"
      "cat_gr": "controlled vocabulary"
      "cod": "number"
      "col": "number"
      "contesto": "string"
      "contesto formattato": "string"
      "disambiguatore": "controlled vocabulary"
      "elemlen": "number"
      "formattazione contesto":
        object_type: "array"
        element_type: "number"
      "lemma": "string"
      "links": "number"
      "mappa": "number"
      "ntx": "number"
      "numbrano": "number"
      "numorg": "number"
      "numperiod": "number"
      "pag": "string (?)"
      "pfin": "number"
      "pifin": "number"
      "piniz": "number"
      "pitxt": "number"
      "riga": "number"
      "sigla": "string"
      "stanza": "number"
      "tipostanza": "number"
      "verso": "number"
      "vol": "string (?)"
    splittable: False

- /get_single_context:
    method: 'POST'
    description: "Ricerca informazioni aggiuntive per un singolo contesto (--> normalmente selezionato ad  interfaccia tra quelli ottenuti in risposta da una chiamata a get_context)"
    input:
      structure:
        elem: "== get_context output"
        params:
          "brani": "0 | 1"
          "indice": "string (?)"
          "parole": "number"
          "periodi": "0 | 1"
      nota1: "La struttura di 'elem' è forse troppo complicata? Forse andrebbe semplificata e/o disaccoppiata dall'endpoint precedente."
      nota2: "I params non sono selezionabili da FE inoltre non sono sicuro che abbiano una implementazione corretta a BE."
    output:
      "Anno finale": "number"
      "Anno iniziale": "number"
      "Area generica": "controlled vocabulary (?)"
      "Area specifica": "controlled vocabulary (?)"
      "Autore": "controlled vocabulary (authority?)"
      "Curatore": "controlled vocabulary (authority?)"
      "Data codificata": "formatted date"
      "Data descrittiva": "human-readable date"
      "Forma": "controlled vocabulary"
      "Genere": "controlled vocabulary"
      "IQ": "controlled vocabulary"
      "Rif_organico": "controlled vocabulary"
      "Rig_completo": "controlled vocabulary"
      "Tipo": "controlled vocabulary"
      "Titolo": "string"
      "Titolo Abbreviato": "string"
      "backup_pfin": "number"
      "backup_piniz": "number"
      "cat_gr": "controlled vocabulary"
      "cod": "number"
      "col": "number"
      "contesto": "string"
      "contesto formattato": "string"
      "disambiguatore": "controlled vocabulary"
      "elemlen": "number"
      "formattazione contesto":
        object_type: "array"
        element_type: "number"
      "formattazione testo associato":
        object_type: "array"
        element_type: "number"
      "lemma": "string"
      "links": "number"
      "mappa": "number"
      "ntx": "number"
      "numbrano": "number"
      "numorg": "number"
      "numperiod": "number"
      "pag": "string (?)"
      "pfin": "number"
      "pifin": "number"
      "piniz": "number"
      "pitxt": "number"
      "riga": "number"
      "sigla": "string"
      "stanza": "number"
      "testo associato": "string"
      "testo associato formattato": "string"
      "tipostanza": "controlled vocabulary"
      "verso": "number"
      "vol": "string"
    splittable: False