{
 "openapi": "3.1.0",
 "info": {
  "title": "SSA-API",
  "version": "1.0.0",
  "summary": "Statens standardavtaler (SSA) som åpne data",
  "description": "Les-API over Statens standardavtaler (SSA) fra DFØ, digitalisert uendret fra DFØs Word-maler (bokmål). Teksten er kontrollert mot Word-filene tegn for tegn ved hver bygging. Lovtekst er hentet fra Lovdatas åpne data (NLOD 2.0). Avtaletekst og veiledning tilhører DFØ (anskaffelser.no). Dataene er ikke juridisk rådgivning. Under utvikling.",
  "contact": {
   "email": "hei@samuelandersen.com"
  }
 },
 "servers": [
  {
   "url": "https://samuelandersen.com/ssa/api/v1"
  }
 ],
 "tags": [
  {
   "name": "Avtaler"
  },
  {
   "name": "Regelverk og veiledning"
  }
 ],
 "paths": {
  "/katalog": {
   "get": {
    "tags": [
     "Avtaler"
    ],
    "operationId": "hentKatalog",
    "summary": "Alle avtalene med bilag",
    "responses": {
     "200": {
      "description": "Katalogen",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Katalog"
        }
       }
      }
     }
    }
   }
  },
  "/avtaler/{id}": {
   "get": {
    "tags": [
     "Avtaler"
    ],
    "operationId": "hentAvtale",
    "summary": "Én avtale: avtaletekst (punkter) og bilag med deler, roller og felt",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "enum": [
        "ssa-k",
        "ssa-v",
        "ssa-t",
        "ssa-s",
        "ssa-l",
        "ssa-lille-sky",
        "ssa-sky",
        "ssa-d",
        "ssa-b",
        "ssa-b-enkel",
        "ssa-o",
        "ssa-f",
        "ssa-r"
       ]
      },
      "description": "Avtalens id, f.eks. ssa-k"
     }
    ],
    "responses": {
     "200": {
      "description": "Avtalen",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Avtale"
        }
       }
      }
     },
     "404": {
      "description": "Finnes ikke"
     }
    }
   }
  },
  "/regelverk": {
   "get": {
    "tags": [
     "Regelverk og veiledning"
    ],
    "operationId": "hentRegelverk",
    "summary": "Henvisninger til lov og forskrift per avtale, kontrollert mot Lovdata, og paragrafer for prosessen",
    "responses": {
     "200": {
      "description": "Regelverket",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/Regelverk"
        }
       }
      }
     }
    }
   }
  },
  "/veiledning": {
   "get": {
    "tags": [
     "Regelverk og veiledning"
    ],
    "operationId": "hentVeiledning",
    "summary": "DFØs veiledning om SSA-ene (Markdown, med kilde og dato)",
    "responses": {
     "200": {
      "description": "Veiledningen",
      "content": {
       "application/json": {
        "schema": {
         "type": "object"
        }
       }
      }
     }
    }
   }
  }
 },
 "components": {
  "schemas": {
   "Katalog": {
    "type": "object",
    "properties": {
     "bygget": {
      "type": "string",
      "format": "date-time"
     },
     "avtaler": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/KatalogAvtale"
      }
     }
    }
   },
   "KatalogAvtale": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "kort": {
      "type": "string",
      "examples": [
       "SSA-K"
      ]
     },
     "navn": {
      "type": "string"
     },
     "versjon": {
      "type": "string"
     },
     "url": {
      "type": "string",
      "format": "uri",
      "description": "DFØs side for malen"
     },
     "punkter": {
      "type": "integer"
     },
     "bilag": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/BilagKort"
      }
     }
    }
   },
   "BilagKort": {
    "type": "object",
    "properties": {
     "nr": {
      "type": "integer"
     },
     "id": {
      "type": "string"
     },
     "tittel": {
      "type": "string"
     },
     "ansvar": {
      "$ref": "#/components/schemas/Ansvar"
     },
     "type": {
      "$ref": "#/components/schemas/Bilagstype"
     },
     "deler": {
      "type": "integer"
     }
    }
   },
   "Ansvar": {
    "type": "string",
    "enum": [
     "kunde",
     "leverandor",
     "leverandor-etter-foringer",
     "begge",
     "etter-inngaelse"
    ],
    "description": "Hvem som fyller ut bilaget (fra tabellen i avtalens punkt 1.2)"
   },
   "Bilagstype": {
    "type": "string",
    "enum": [
     "krav",
     "svar",
     "pris",
     "tjenesteniva",
     "endring-avtaletekst",
     "endring-etter",
     "databehandler",
     "annet"
    ]
   },
   "Avtale": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string"
     },
     "kort": {
      "type": "string"
     },
     "navn": {
      "type": "string"
     },
     "versjon": {
      "type": "string"
     },
     "url": {
      "type": "string"
     },
     "utgiver": {
      "type": "string"
     },
     "bilagsoversikt": {
      "type": [
       "object",
       "null"
      ]
     },
     "strukturavvik": {
      "type": [
       "array",
       "null"
      ],
      "items": {
       "type": "string"
      }
     },
     "generell": {
      "type": "object",
      "properties": {
       "fil": {
        "type": "string"
       },
       "sha256": {
        "type": "string",
        "description": "SHA-256 av DFØs Word-fil"
       },
       "nedlasting": {
        "type": "string"
       },
       "forside": {
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/Blokk"
        }
       },
       "punkter": {
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/Punkt"
        }
       }
      }
     },
     "bilag": {
      "type": [
       "object",
       "null"
      ],
      "properties": {
       "fil": {
        "type": "string"
       },
       "sha256": {
        "type": "string"
       },
       "innledning": {
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/Blokk"
        }
       },
       "liste": {
        "type": "array",
        "items": {
         "$ref": "#/components/schemas/Bilag"
        }
       }
      }
     }
    }
   },
   "Punkt": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "examples": [
       "ssa-k/2024/pkt/2.2.6"
      ]
     },
     "nr": {
      "type": "string",
      "examples": [
       "2.2.6"
      ]
     },
     "niva": {
      "type": "integer"
     },
     "tittel": {
      "type": "string"
     },
     "sha": {
      "type": "string",
      "description": "12 første hex av SHA-256 av normalisert tekst"
     },
     "bilag": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Bilag punktet viser til"
     },
     "blokker": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Blokk"
      }
     }
    }
   },
   "Bilag": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "examples": [
       "ssa-k/2024/b1"
      ]
     },
     "nr": {
      "type": "integer"
     },
     "tittel": {
      "type": "string"
     },
     "ansvar": {
      "$ref": "#/components/schemas/Ansvar"
     },
     "type": {
      "$ref": "#/components/schemas/Bilagstype"
     },
     "innledning": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Blokk"
      }
     },
     "deler": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Del"
      }
     }
    }
   },
   "Del": {
    "type": "object",
    "properties": {
     "id": {
      "type": "string",
      "examples": [
       "ssa-k/2024/b1/2.2.6"
      ]
     },
     "tittel": {
      "type": "string"
     },
     "punkt": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Punktene i avtaleteksten delen hører til"
     },
     "niva": {
      "type": "integer"
     },
     "sha": {
      "type": "string"
     },
     "pakrevd": {
      "type": "integer"
     },
     "roller": {
      "type": "object",
      "additionalProperties": {
       "type": "integer"
      }
     },
     "blokker": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Blokk"
      }
     }
    }
   },
   "Blokk": {
    "type": "object",
    "description": "t = h (overskrift) · p (avsnitt) · tabell · veiledning (DFØs tekstboks)",
    "properties": {
     "t": {
      "type": "string",
      "enum": [
       "h",
       "p",
       "tabell",
       "veiledning"
      ]
     },
     "n": {
      "type": "integer",
      "description": "Overskriftsnivå"
     },
     "m": {
      "type": "string",
      "description": "Words nummer eller listemerke"
     },
     "l": {
      "type": "integer"
     },
     "v": {
      "type": "integer",
      "description": "Avkrysning (☐)"
     },
     "gruppe": {
      "type": "string"
     },
     "flervalg": {
      "type": "integer"
     },
     "r": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Tekstlop"
      }
     },
     "rader": {
      "type": "array",
      "items": {
       "type": "array",
       "items": {
        "type": "object"
       }
      }
     },
     "b": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/Blokk"
      }
     },
     "rolle": {
      "type": "string",
      "enum": [
       "veiledning",
       "bestemmelse",
       "mal",
       "valg",
       "alternativ",
       "etikett",
       "tabell",
       "felt"
      ],
      "description": "Bare i bilagsdeler: vår vurdering av hva DFØ-teksten er"
     },
     "rk": {
      "type": "string",
      "enum": [
       "kontrollert",
       "usikker",
       "regel"
      ]
     }
    }
   },
   "Tekstlop": {
    "type": "object",
    "required": [
     "x"
    ],
    "properties": {
     "x": {
      "type": "string",
      "description": "Teksten, ordrett"
     },
     "i": {
      "type": "boolean"
     },
     "b": {
      "type": "boolean"
     },
     "u": {
      "type": "boolean"
     },
     "f": {
      "type": "integer",
      "description": "Felt som skal fylles ut"
     },
     "id": {
      "type": "string",
      "description": "Feltets adresse, f.eks. ssa-b-enkel/2026/pkt/4.1#f2"
     }
    }
   },
   "Regelverk": {
    "type": "object",
    "properties": {
     "kilde": {
      "type": "string"
     },
     "lisens": {
      "type": "string"
     },
     "lovdataBygget": {
      "type": "string"
     },
     "avtaler": {
      "type": "object",
      "additionalProperties": {
       "type": "array",
       "items": {
        "type": "object"
       }
      }
     },
     "prosess": {
      "type": "array",
      "items": {
       "type": "object"
      }
     }
    }
   }
  }
 }
}