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:
      type: object
      properties:
        queryList:
          type: array
          items:
            type: object
            properties:
              espansa: "0 | 1"
              raddoppiata: "0 | 1"
              stringa: string
              tipo: "forma | lemma | lemmaForma | formLemma"
    output:
      type: array
      items:
        oneOf:
          type: object
          properties:
            cod: integer
            forma: string
            occ: integer
          type: object
          properties:
            cat_gr: "controlled vocabulary"
            cod: integer
            disambiguatore: string
            lemma: string
            occ: integer
          type: object
          properties:
            cat_gr: "controlled vocabulary"
            cod: integer
            disambiguatore: string
            forma: string
            lemma: string
            occ: integer
          type: object
          properties: "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:
      type: object
      properties:
        listResults:
          type: array
          items: "== risposta di simple_get_query"
        queryList:
          type: array
          items:
            oneOf:
              type: object
              properties:
                cod: integer
                forma: string
                occ: integer
                selected: boolean
              type: object
              properties:
                cat_gr: "controlled vocabulary"
                cod: integer
                disambiguatore: string
                lemma: string
                occ: integer
                selected: boolean
              type: object
              properties:
                cat_gr: "controlled vocabulary"
                cod: integer
                disambiguatore: string
                forma: string
                lemma: string
                occ: integer
                selected: boolean
    output:
      type: array
      items:
        type: object
        properties:
          "Anno finale": integer
          "Anno iniziale": integer
          "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: integer
          backup_piniz: integer
          cat_gr: "controlled vocabulary"
          cod: integer
          col: integer
          contesto: string
          contesto formattato: string
          disambiguatore: "controlled vocabulary"
          elemlen: integer
          formattazione contesto:
            type: array
            items: integer
          lemma: string
          links: integer
          mappa: integer
          ntx: integer
          numbrano: integer
          numorg: integer
          numperiod: integer
          pag: "string (?)"
          pfin: integer
          pifin: integer
          piniz: integer
          pitxt: integer
          riga: integer
          sigla: string
          stanza: integer
          tipostanza: integer
          verso: integer
          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:
      type: object
      properties:
        elem: "== get_context output"
        params:
          brani: "0 | 1"
          indice: "string (?)"
          parole: integer
          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:
      type: array
      items:
        type: object
        properties:
          "Anno finale": integer
          "Anno iniziale": integer
          "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: integer
          backup_piniz: integer
          cat_gr: "controlled vocabulary"
          cod: integer
          col: integer
          contesto: string
          "contesto formattato": string
          disambiguatore: "controlled vocabulary"
          elemlen: integer
          formattazione contesto:
            type: array
            items: integer
          formattazione testo associato:
            type: array
            items: integer
          lemma: string
          links: integer
          mappa: integer
          ntx: integer
          numbrano: integer
          numorg: integer
          numperiod: integer
          pag: "string (?)"
          pfin: integer
          pifin: integer
          piniz: integer
          pitxt: integer
          riga: integer
          sigla: string
          stanza: integer
          testo associato: string
          testo associato formattato: string
          tipostanza: "controlled vocabulary"
          verso: integer
          vol: string
        "nota": "è una variante della risposta di get_context"
    splittable: False