{
  "openapi": "3.1.0",
  "info": {
    "title": "Plattformsguiden, öppna data",
    "version": "1",
    "description": "Plattformsguiden jämför SaaS och affärssystem för svenska företag. Priser och fakta med källa och datum, och en öppen metod för hur vi rankar systemen. Varje uppgift har källa och datum. Null betyder att uppgiften inte är belagd, aldrig nej."
  },
  "servers": [
    {
      "url": "https://plattformsguiden.se/api/v1"
    }
  ],
  "paths": {
    "/kategorier": {
      "get": {
        "summary": "Alla kategorier med antal system och nyckeltal: hur många som har vad, lägsta pris, med datum.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/kategorier/{slug}": {
      "get": {
        "summary": "Kategorins index: varje fråga med antal som har, inte har och där det inte står, priserna och listans tio första.",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/system": {
      "get": {
        "summary": "Alla system, eller systemen i en kategori.",
        "parameters": [
          {
            "name": "kategori",
            "in": "query",
            "required": false,
            "description": "Kategorins slug, till exempel crm-system.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/system/{slug}": {
      "get": {
        "summary": "Ett system med varje uppgift, datum för kontrollen och adressen till källan.",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/jamfor": {
      "get": {
        "summary": "Två eller flera system mot varandra, kriterium för kriterium. En lucka är null, aldrig ett nej.",
        "parameters": [
          {
            "name": "system",
            "in": "query",
            "required": true,
            "description": "Systemens slug med komma emellan.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/kriterier": {
      "get": {
        "summary": "Frågorna varje system prövas mot.",
        "parameters": [
          {
            "name": "kategori",
            "in": "query",
            "required": false,
            "description": "Kategorins slug.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/topplistor": {
      "get": {
        "summary": "Topplistorna med kraven de räknas på.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/topplistor/{slug}": {
      "get": {
        "summary": "En topplista med varje systems plats, vilka krav det uppfyller, hur många uppgifter som är belagda och vad som skulle flytta upp det.",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/fragor": {
      "get": {
        "summary": "Frågor som köpare ställer, med svar räknade ur uppgifterna. Varje fråga har ett fast id.",
        "parameters": [
          {
            "name": "kategori",
            "in": "query",
            "required": false,
            "description": "Kategorins slug.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "system",
            "in": "query",
            "required": false,
            "description": "Ett systems slug.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/artiklar": {
      "get": {
        "summary": "Notiser och förklaringar med sina källor.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/andringar": {
      "get": {
        "summary": "De senast uppdaterade uppgifterna: vad som står nu och när det skrevs in. Ett byte kan vara vår egen rättning, så det gamla värdet lämnas inte ut.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "JSON",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "404": {
            "description": "Finns inte"
          }
        }
      }
    },
    "/komplettering": {
      "post": {
        "summary": "Lämna en rättelse eller komplettering om ett system åt en människa. Den hamnar i redaktionens kö och publiceras aldrig direkt.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "system",
                  "uppgift",
                  "namn",
                  "epost"
                ],
                "properties": {
                  "system": {
                    "type": "string",
                    "description": "Systemets slug."
                  },
                  "uppgift": {
                    "type": "string",
                    "minLength": 10,
                    "maxLength": 600,
                    "description": "Vad som är fel eller saknas, med rätt uppgift."
                  },
                  "sida": {
                    "type": "string",
                    "description": "Sidan där uppgiften står, helst på leverantörens egen sajt."
                  },
                  "kriterium": {
                    "type": "string",
                    "description": "Kriteriets nyckel."
                  },
                  "typ": {
                    "type": "string",
                    "enum": [
                      "rattelse",
                      "komplettering"
                    ]
                  },
                  "namn": {
                    "type": "string",
                    "description": "Personen agenten skickar åt."
                  },
                  "epost": {
                    "type": "string",
                    "description": "Personens e-post."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Mottagen"
          },
          "400": {
            "description": "Fält saknas eller har fel form, med en lista över vilka"
          }
        }
      }
    }
  }
}