stores-api.yaml

openapi: 3.0.1
info:
  title: Stores API
  description: API to find a store nearby.
  version: "1.0"
servers:
- url: https://dds-wvv-backend.herokuapp.com/
- url: https://dev-dds-wvv-backend.herokuapp.com/
tags:
- name: Products API
  description: Products Controller
- name: Stores API
  description: Stores Controller
paths:
  /products/:
    get:
      tags:
      - Products API
      summary: get all products for one specific store
      operationId: getProductsByStoreIdUsingGET
      parameters:
      - name: storeId
        in: query
        description: storeId
        required: true
        allowEmptyValue: false
        schema:
          type: string
        example: ddf24dc6-1a2d-4391-8f34-c5c322b21c1e
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product'
        500:
          description: An unexpected error occurred
          content: {}
      deprecated: false
  /products/{id}:
    get:
      tags:
      - Products API
      summary: get one specific product by ID
      operationId: getProductByIdUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
        example: 885dfe52-c401-42fd-bf8d-80d6b7c80dd2
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
        500:
          description: An unexpected error occurred
          content: {}
      deprecated: false
  /stores/:
    get:
      tags:
      - Stores API
      summary: get stores / or filter by query
      operationId: getStoresByQueryUsingGET
      parameters:
      - name: neighborhood
        in: query
        description: id
        allowEmptyValue: false
        schema:
          type: string
        example: Neukölln
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Store'
        500:
          description: An unexpected error occurred
          content: {}
      deprecated: false
    post:
      tags:
      - Stores API
      summary: Create store
      description: |
        Creates a new store. 
        The store will is created with `published=false` and must be published manually.
        GeoLocation is filled automatically from `Address` if not present.
      security: 
        - basicAuth: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                storeData:
                  $ref: '#/components/schemas/StoreDraft'
                shopOwnerImage:
                  type: string
                  format: binary
                profileImageURL:
                  type: string
                  format: binary
            encoding:
              shopOwnerImage:
                contentType: image/png, image/jpeg
              profileImage:
                contentType: image/png, image/jpeg
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store'
        500:
          description: An unexpected error occurred
          content: {}
      deprecated: false
  /stores/{id}:
    get:
      tags:
      - Stores API
      summary: get a specific store by ID
      operationId: getStoreByIdUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
        example: ddf24dc6-1a2d-4391-8f34-c5c322b21c1e
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Store'
        500:
          description: An unexpected error occurred
          content: {}
      deprecated: false
  /stores/{id}/products:
    post:
      tags:
      - Stores API
      - Products API
      summary: Create a new product for the store
      security: 
      - basicAuth: []
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: string
        example: ddf24dc6-1a2d-4391-8f34-c5c322b21c1e
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                productData:
                  $ref: '#/components/schemas/ProductDraft'
                productImage:
                  type: string
                  format: binary
            encoding:
              productImage:
                contentType: image/png, image/jpeg
      responses:
        200:
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
        500:
          description: An unexpected error occurred
          content: {}
components:
  schemas:
    Address:
      title: Address
      type: object
      properties:
        city:
          type: string
        country:
          type: string
          description: Alpha-2
        id:
          type: string
        postalCode:
          type: string
        region:
          type: string
        state:
          type: string
        streetName:
          type: string
        streetNumber:
          type: string
    Attribute:
      title: Attribute
      type: object
      properties:
        name:
          type: string
    GeoJSON:
      title: GeoJSON
      type: object
      properties:
        type:
          type: string
          enum:
          - Point
        coordinates:
          type: array
          description: Array containing longitudea and latitude
          items:
            type: number
          minItems: 2
          maxItems: 2
      example:
        type: Point
        coordinates:
        - 13.408134
        - 52.489908
    Image:
      title: Image
      type: object
      properties:
        dimensions:
          $ref: '#/components/schemas/ImageDimensions'
        label:
          type: string
        url:
          type: string
    ImageDimensions:
      title: ImageDimensions
      type: object
      description: Dimensions of the original image. This can be used by your application for example to determine whether the image is large enough to display a zoom view.
      properties:
        h:
          type: integer
          format: int32
        w:
          type: integer
          format: int32
    Price:
      title: Price
      type: object
      properties:
        currencyCode:
          type: string
        value:
          type: number
    Product:
      title: Product
      type: object
      properties:
        description:
          $ref: '#/components/schemas/LocalizedString'
        id:
          type: string
        masterVariant:
          $ref: '#/components/schemas/ProductVariant'
        name:
          $ref: '#/components/schemas/LocalizedString'
        price:
          $ref: '#/components/schemas/Price'
        slug:
          $ref: '#/components/schemas/LocalizedString'
      example:
        id: 6a19bf78-dce2-4830-845f-b029ada5472e
        name:
          de_DE: 2x kleine Hamamtücher 50x90cm
        description:
          de_DE: |-
            Du bekommst 2x kleine Hamamtücher 50x90cm aus 100% Baumwolle perfekt im Bad oder Küche
            Voraussichtliche Lieferung: ab sofort
        slug:
          en_US: 2-hamam-50-90cm-rot-weiss
          de_DE: 2x-kleine-hamamtuecher-50x90cm
        price:
          value: 25
          currencyCode: EUR
        masterVariant:
          assets: []
          attributes: []
          id: 1
          images:
          - url: https://7cbf5172f31e91cb7a5d-d8e96be60ea1fd7ad98fb07a482142ee.ssl.cf3.rackcdn.com/2-hamam-50-90cm-rot--q9KcG8UT.jpg
            dimensions:
              w: 566
              h: 566
            label: 2 Hamamtücher 50 x 90cm
          key: 2-hamam-50-90cm-rot-weiss
          sku: 2-hamam-50-90cm-rot-weiss
    ProductDraft:
      title: ProductDraft
      type: object
      properties:
        description:
          $ref: '#/components/schemas/LocalizedString'
        name:
          $ref: '#/components/schemas/LocalizedString'
        price:
          $ref: '#/components/schemas/Price'
        slug:
          $ref: '#/components/schemas/LocalizedString'
      example:
        name:
          de_DE: 2x kleine Hamamtücher 50x90cm
        description:
          de_DE: |-
            Du bekommst 2x kleine Hamamtücher 50x90cm aus 100% Baumwolle perfekt im Bad oder Küche
            Voraussichtliche Lieferung: ab sofort
        slug:
          en_US: 2-hamam-50-90cm-rot-weiss
          de_DE: 2x-kleine-hamamtuecher-50x90cm
        price:
          value: 25
          currencyCode: EUR    
    ProductVariant:
      title: ProductVariant
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
        id:
          type: integer
          format: int32
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
        sku:
          type: string
    LocalizedString:
      title: LocalizedString
      description: |
        A localized string is a JSON object where the keys are of IETF language tag,
        and the values the corresponding strings used for that language.
        For SBH, currently only `de-DE` is used.
      type: object
      example:
        de-DE: Deutscher Text
        en-US: American English text
    Store:
      title: Store
      type: object
      properties:
        address:
          $ref: '#/components/schemas/Address'
        contact:
          type: string
          deprecated: true
        description:
          $ref: '#/components/schemas/LocalizedString'
        email:
          type: string
          deprecated: true
          description: Use contactEmail instead
        geoLocation:
          $ref: '#/components/schemas/GeoJSON'
        homepage:
          type: string
          deprecated: true
          description: Use contactHomepage instead
        name:
          $ref: '#/components/schemas/LocalizedString'
        neighborhood:
          type: array
          items:
            type: string
          deprecated: true
        shopCategory:
          type: string
        phone:
          type: string
          deprecated: true
          description: Use contactPhone instead
        contactEmail:
          type: string
        contactPhone:
          type: string
        contactHomepage:
          type: string  
        contactWhatsapp:
          type: string
        contactInstagram:
          type: string
        contactFacebook:
          type: string
        contactFacetime:
          type: string
        contactSkype:
          type: string
        contactTwitter:
          type: string
        profileImage:
          type: string
        profileVideoURL:
          type: string
        hasDelivery:
          type: boolean
        hasPickup:
          type: boolean
        hasShipping:
          type: boolean
        shopOwnerImage:
          type: string
        shopOwnerName:
          type: string
          deprecated: true
          description: Use shopOwnerFirstName/shopOwnerLastName instead
        shopOwnerFirstName:
          type: string
        shopOwnerLastName:
          type: string
        id:
          type: string
        published:
          type: boolean
      example:
        id: c3d6517f-b285-4a9e-b650-345c850bb01c
        name:
          de_DE: Agas Own 2
        description:
          de_DE: "\"Agas Own 2\" in Berlin Kreuzberg am Südstern. Erlebe einen Traum\
            \ von Vielfalt aus dem Raum Asien im Bereich: Wohnaccessoires, ein Raum\
            \ der Begegnung. \n\nHallo liebe Leute, Ihr seid auf mein bereits bestehendes\
            \ Projekt/Ladengeschäft aufmerksam geworden. Ich betreibe seit über einem\
            \ Jahr in Berlin-Kreuzberg am Südstern ein Ladengeschäft für Wohnaccessoires\
            \ aus der Türkei, Thailand, Indonesien, Indien. Ich wohne selber seit\
            \ einigen Jahren in der Körtestraße. Deshalb liegen mir als gebürtigem\
            \ Berliner und Kreuzberger der Zusammenhalt im Kiez, der Austausch von\
            \ Anliegen und die Mitmenschen, die ich in meinem Geschäft täglich antreffe,\
            \ am Herzen."
        address:
          country: DE
          streetName: Körtestraße
          streetNumber: "34"
          postalCode: "10967"
          city: Berlin
          state: ""
        geoLocation:
          type: Point
          coordinates:
          - 13.408134
          - 52.489908
        profileVideoURL: https://youtu.be/PBkb2mzbqKE
        shopOwnerImage: https://drive.google.com/file/d/1Ls5Yjc760oEfnibC9Xv29OtALtmV_Ss4/view?usp=sharing
        shopOwnerFirstName: Oskar
        shopOwnerLastName: Fleer
        contactPhone: 030 98388469
        contactHomepage: https://www.startnext.com/agas-own-2
    StoreDraft:
      title: StoreDraft
      type: object
      properties:
        address:
          $ref: '#/components/schemas/Address'
        description:
          $ref: '#/components/schemas/LocalizedString'
        name:
          $ref: '#/components/schemas/LocalizedString'
        shopCategory:
          type: string
        contactEmail:
          type: string
        contactHomepage:
          type: string
        contactPhone:
          type: string
        contactWhatsapp:
          type: string
        contactInstagram:
          type: string
        contactFacebook:
          type: string
        contactFacetime:
          type: string
        contactSkype:
          type: string
        contactTwitter:
          type: string
        profileVideoURL:
          type: string
        hasDelivery:
          type: boolean
        hasPickup:
          type: boolean
        hasShipping:
          type: boolean
        shopOwnerFirstName:
          type: string
        shopOwnerLastName:
          type: string
        shopOwnerPhone:
          type: string
          description: Only used internally and MUST not be used in the frontend
        shopOwnerEmail:
          type: string
          description: Only used internally and MUST not be used in the frontend
        numberOfEmployees:
          type: number
          format: int32
          description: Only used internally and MUST not be used in the frontend
      example:
        name:
          de_DE: Agas Own 2
        description:
          de_DE: "\"Agas Own 2\" in Berlin Kreuzberg am Südstern. Erlebe einen Traum\
            \ von Vielfalt aus dem Raum Asien im Bereich: Wohnaccessoires, ein Raum\
            \ der Begegnung. \n\nHallo liebe Leute, Ihr seid auf mein bereits bestehendes\
            \ Projekt/Ladengeschäft aufmerksam geworden. Ich betreibe seit über einem\
            \ Jahr in Berlin-Kreuzberg am Südstern ein Ladengeschäft für Wohnaccessoires\
            \ aus der Türkei, Thailand, Indonesien, Indien. Ich wohne selber seit\
            \ einigen Jahren in der Körtestraße. Deshalb liegen mir als gebürtigem\
            \ Berliner und Kreuzberger der Zusammenhalt im Kiez, der Austausch von\
            \ Anliegen und die Mitmenschen, die ich in meinem Geschäft täglich antreffe,\
            \ am Herzen."
        address:
          country: DE
          streetName: Körtestraße
          streetNumber: "34"
          postalCode: "10967"
          city: Berlin
          state: ""
        profileVideoURL: https://youtu.be/PBkb2mzbqKE
        shopOwnerFirstName: Oskar
        shopOwnerLastName: Fleer
        contactPhone: 030 98388469
        contactHomepage: https://www.startnext.com/agas-own-2
  securitySchemes:
    basicAuth:     # <-- arbitrary name for the security scheme
      type: http
      scheme: basic