openapi.yml

openapi: "3.0.0"
info:
  description: ""
  version: "0.2.0"
  title: "liquide bleiben"
  contact:
    email: "wir-bleiben-liquide@gmail.com"
  license:
    name: "MIT"
    url: "https://github.com/TimMaa/liquide-bleiben/blob/master/LICENSE"
servers:
  - url: "https://finder.wir-bleiben-liqui.de"
    description: "Production server"
paths:
  /api/offers:
    get:
      summary: "Get all available offers"
      operationId: "getOffers"
      parameters:
      - $ref: "#/components/parameters/state"
      - $ref: "#/components/parameters/trade"
      - $ref: "#/components/parameters/age"
      - $ref: "#/components/parameters/legal"
      - $ref: "#/components/parameters/sales"
      - $ref: "#/components/parameters/employees"
      responses:
        200:
          description: "Succesful"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/response-offers"
        400:
          description: "Bad Input"
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  error:
                    type: "string"
  /api/descriptions:
    get:
      summary: "Get easy to understand descriptions for different types of clusters"
      operationId: "getDescriptions"
      responses:
        200:
          description: "Succesful"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/response-descriptions"
  /api/selects:
    get:
      summary: "Get option values for selection"
      operationId: "getSelects"
      responses:
        200:
          description: "Succesful"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/response-selects"
components:
  parameters:
    state:
      in: "query"
      name: "state"
      description: "german state the company is located in"
      required: false
      schema:
        type: "string"
        enum:
        - "Baden-Württemberg"
        - "Bayern"
        - "Berlin"
        - "Brandenburg"
        - "Bremen"
        - "Hamburg"
        - "Hessen"
        - "Mecklenburg-Vorpommern"
        - "Niedersachsen"
        - "Nordrhein-Westfalen"
        - "Rheinland-Pfalz"
        - "Saarland"
        - "Sachsen-Anhalt"
        - "Sachsen"
        - "Schleswig-Holstein"
        - "Thüringen"
    trade:
      in: "query"
      name: "trade"
      description: "trade of the company"
      required: false
      schema:
        type: "string"
        enum:
        - "Land- und Forstwirtschaft Fischerei und Fischzucht"
        - "Bergbau und Gewinnung von Steinen und Erden"
        - "Verarbeitendes Gewerbe"
        - "Energie- und Wasserversorgung"
        - "Handel"
        - "Baugewerbe"
        - "Dienstleistung"
        - "Gesundheit / Pflege / Soziales"
        - "Gastronomie / Hotel"
        - "Sonstige"
    age:
      in: "query"
      name: "age"
      description: "age of the company in years"
      required: false
      schema:
        type: "integer"
    legal:
      in: "query"
      name: "legal"
      description: "legal form of the company"
      required: false
      schema:
        type: "string"
        enum:
        - "GmbH"
        - "UG"
        - "AG"
        - "GBR"
        - "E.K."
        - "GmbH & Co. KG"
        - "OHG"
        - "Einzelunternehmer"
    sales:
      in: "query"
      name: "sales"
      description: "last years sales of the company (rounded to full Euro)"
      required: false
      schema:
        type: "integer"
    employees:
      in: "query"
      name: "employees"
      description: "employees of the company"
      required: false
      schema:
        type: "integer"
  schemas:
    cluster:
      type: "object"
      properties:
        name:
          type: "string"
        offers:
          type: "array"
          items:
            type: "object"
            properties:
              id:
                type: "number"
              name:
                type: "string"
              fields:
                type: "object"
                properties:
                  main:
                    $ref: "#/components/schemas/offer-fields"
                  details:
                    $ref: "#/components/schemas/offer-fields"
    offer-fields:
      type: "array"
      items:
        type: "object"
        properties:
          id:
            type: "number"
          name:
            type: "string"
          value:
            type: "string"
    response-descriptions:
      type: "array"
      items:
        type: "object"
        properties:
          name:
            type: "string"
          html:
            type: "string"
    response-offers:
      type: "array"
      items:
        $ref: "#/components/schemas/cluster"
    response-selects:
      type: "array"
      items:
        type: "object"
        properties:
          id:
            type: "integer"
          name:
            type: "string"
          options:
            type: "array"
            items:
              type: "object"
              properties:
                id:
                  type: "integer"
                name:
                  type: "string"
externalDocs:
  url: "https://devpost.com/software/liquiditat-fur-den-mittelstand"