{
  "openapi": "3.1.0",
  "info": {
    "title": "FridgeBase comparison API",
    "version": "1.0.0",
    "description": "The comparison's models, their filters and our data (official data with its source). Today's prices, ratings and photos are on each model's page (url field)."
  },
  "servers": [
    {
      "url": "https://fridgebase.com"
    }
  ],
  "paths": {
    "/api/search": {
      "get": {
        "operationId": "searchModels",
        "summary": "Search models by need (free text) and exact filters.",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": false,
            "description": "Need in plain words",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "filters",
            "in": "query",
            "required": false,
            "description": "Exact filters as JSON: {key: [values]} or {key: {min, max}} (keys and values: /api/filters)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 10
            }
          },
          {
            "name": "market",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "us",
                "fr"
              ],
              "default": "us"
            },
            "description": "The market: us = United States (Amazon.com), fr = France (Amazon.fr)"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/api/models/{slug}": {
      "get": {
        "operationId": "getModel",
        "summary": "All the data of one model.",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "market",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "us",
                "fr"
              ],
              "default": "us"
            },
            "description": "The market: us = United States (Amazon.com), fr = France (Amazon.fr)"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/api/compare": {
      "get": {
        "operationId": "compareModels",
        "summary": "Compare 2 to 4 models.",
        "parameters": [
          {
            "name": "slugs",
            "in": "query",
            "required": true,
            "description": "Comma-separated slugs",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "market",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "us",
                "fr"
              ],
              "default": "us"
            },
            "description": "The market: us = United States (Amazon.com), fr = France (Amazon.fr)"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/api/filters": {
      "get": {
        "operationId": "listFilters",
        "summary": "The comparison's filters, their values and what each means.",
        "parameters": [
          {
            "name": "market",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "us",
                "fr"
              ],
              "default": "us"
            },
            "description": "The market: us = United States (Amazon.com), fr = France (Amazon.fr)"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    },
    "/api/guides": {
      "get": {
        "operationId": "listGuides",
        "summary": "The site's buying guides.",
        "parameters": [
          {
            "name": "market",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "us",
                "fr"
              ],
              "default": "us"
            },
            "description": "The market: us = United States (Amazon.com), fr = France (Amazon.fr)"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        }
      }
    }
  }
}