api.yaml

openapi: 3.0.3
info:
  title: Akros Marketplace
  version: 1.0.0
  x-api-id: e1208a31-c22b-12d4-2a88-72c398d3ac31
  x-audience: company-internal
  description: YAML Swagger Configuration for the Akros Marketplace
  contact:
    name: Akros Marketplace API Support
    url: https://www.akros.ch/kontakt/
    email: support@example.com

paths:
  /categories/{create}:
    get:
      tags:
        - Categories
      summary: List categories
      description: used for primary search page
      parameters:
        - name: create
          in: path
          required: true
          description: Return category fields for creation or for search
          schema:
            type: boolean
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CategoryResponseDTO"
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"

  /topics/{topicId}:
    get:
      tags:
        - Topics
      summary: Load a topic
      description: Load a topic
      parameters:
        - name: topicId
          in: path
          required: true
          description: Primary Key ID to Topic.
          schema:
            type: integer
            format: int64
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TopicLoadResponseDTO"
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"

    delete:
      tags:
        - Topics
      summary: Delete a topic
      description: Delete a topic
      parameters:
        - name: topicId
          in: path
          required: true
          description: Primary Key ID to Topic.
          schema:
            type: integer
            format: int64
      responses:
        200:
          description: OK
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"

  #/topic-searches:
  /topics/searches:
    post:
      tags:
        - Topics
      summary: Search for topics
      description: Search for topics
      requestBody:
        description: All fields for search query
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TopicSearchRequestDTO"
        required: true
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TopicSearchListResponseDTO"
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"
    get:
      tags:
        - Topics
      summary: Search for all topics
      description: Search for all topics
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TopicSearchListResponseDTO"
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"

  /users/{userId}:
    delete:
      tags:
        - Users
      summary: Delete a user
      description: Delete a user by id
      parameters:
        - name: userId
          in: path
          required: true
          description: The user uuid.
          schema:
            type: integer
            format: int64
      responses:
        204:
          description: Successfully deleted user
        400:
          description: invalid UUID
        401:
          description: User auth token is invalid
        403:
          description: User is not authorized to delete the user with the given id
        404:
          description: User not found
        503:
          description: Authentication server unavailable
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"
    put:
      tags:
        - Users
      summary: Update a user
      description: Update a user by id
      parameters:
        - name: userId
          in: path
          required: true
          description: The user uuid.
          schema:
            type: integer
            format: int64
      requestBody:
        description: User object to be updated
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserDTO"
        required: true
      responses:
        200:
          description: Successfully updated the user
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UserResponseDTO"
        400:
          description: UUID or user body are not in valid format
        401:
          description: User auth token is invalid
        403:
          description: User is not authorized to update the user with the given id
        404:
          description: User not found
        503:
          description: Authentication server unavailable
        default:
          description: Unexpected error
          content:
            "application/problem+json":
              schema:
                $ref: "#/components/schemas/Problem"


components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

  schemas:
    CategoryResponseDTO:
      type: object
      required:
        - categories
      properties:
        categories:
          type: array
          items:
            $ref: "#/components/schemas/CategoryDTO"

    CategoryDTO:
      type: object
      required:
        - category_id
        - key
        - sub_categories
      properties:
        category_id:
          type: integer
          format: int64
        key:
          type: string
        sub_categories:
          type: array
          items:
            $ref: "#/components/schemas/SubCategoryDTO"

    TopicImageDTO:
      type: object
      required:
        - topic_image_id
        - topic_id
        - thumbnail
        - value
      properties:
        topic_image_id:
          type: integer
          format: int64
        topic_id:
          type: integer
          format: int64
        thumbnail:
          type: boolean
        value:
          type: string
          format: byte

    SubCategoryDTO:
      type: object
      required:
        - subcategory_id
        - key
        - fields
      properties:
        subcategory_id:
          type: integer
          format: int64
        key:
          type: string
        fields:
          type: array
          items:
            $ref: "#/components/schemas/FieldResponseDTO"

    FieldResponseDTO:
      type: object
      required:
        - field_id
        - field_type_definition_id
        - key
        - searchable
        - creation
        - request
        - offer
        - required
      properties:
        field_id:
          type: integer
          format: int64
        field_type_definition_id:
          type: integer
          format: int32
        key:
          type: string
        sort_number:
          type: integer
          format: int32
        min_value:
          type: integer
          format: int32
        max_value:
          type: integer
          format: int32
        searchable:
          type: boolean
        request:
          type: boolean
        offer:
          type: boolean
        creation:
          type: boolean
        required:
          type: boolean
        field_options:
          type: array
          items:
            $ref: "#/components/schemas/FieldOptionResponseDTO"

    FieldOptionResponseDTO:
      type: object
      required:
        - field_option_id
        - key
      properties:
        field_option_id:
          type: integer
          format: int64
        key:
          type: string
        sort_number:
          type: integer
          format: int32

    TopicSaveRequestDTO:
      type: object
      required:
        - topic_id
        - subcategory_id
        - request_or_offer
        - topic_values
        - user_id
      properties:
        topic_id:
          type: integer
          format: int64
        subcategory_id:
          type: integer
          format: int64
        request_or_offer:
          type: string
        topic_values:
          type: array
          items:
            $ref: "#/components/schemas/TopicValueSaveRequestDTO"
        user_id:
          type: string

    TopicValueSaveRequestDTO:
      type: object
      required:
        - field_type_id
        - value
      properties:
        field_type_id:
          type: integer
          format: int64
        value:
          type: string

    TopicLoadResponseDTO:
      type: object
      required:
        - topic_id
        - category_id
        - subcategory_id
        - request_or_offer
        - topic_values
        - topic_images
      properties:
        topic_id:
          type: integer
          format: int64
        category_id:
          type: integer
          format: int64
        subcategory_id:
          type: integer
          format: int64
        request_or_offer:
          type: string
        topic_values:
          type: array
          items:
            $ref: "#/components/schemas/TopicValueLoadResponseDTO"
        topic_images:
          type: array
          items:
            $ref: "#/components/schemas/TopicImageDTO"

    TopicValueLoadResponseDTO:
      type: object
      required:
        - topic_value_id
        - field_id
      properties:
        topic_value_id:
          type: integer
          format: int64
        field_id:
          type: integer
          format: int64
        field_description:
          type: string
          example: Beschreibung
        field_short_description:
          type: string
          example: Beschreibung
        field_type_definition_id:
          type: integer
          format: int32
        field_type_definition_description:
          type: string
          example: Number
        min_value:
          type: integer
          format: int32
        max_value:
          type: integer
          format: int32
        value:
          type: string
        field_type_options:
          type: array
          items:
            $ref: "#/components/schemas/FieldOptionResponseDTO"

    TopicSearchRequestDTO:
      type: object
      required:
        - category_id
        - request_or_offer
      properties:
        category_id:
          type: integer
          format: int64
        subcategory_id:
          type: integer
          format: int64
        request_or_offer:
          type: string
        search_values:
          type: array
          items:
            $ref: "#/components/schemas/TopicSearchFieldValuesRequestDTO"

    TopicSearchFieldValuesRequestDTO:
      type: object
      required:
        - field_id
        - value
      properties:
        field_id:
          type: integer
          format: int64
        value_num_from:
          type: integer
          format: int32
        value_num_to:
          type: integer
          format: int32
        value:
          type: string

    TopicSearchListResponseDTO:
      type: object
      required:
        - topics
        - images
      properties:
        topics:
          type: array
          items:
            $ref: "#/components/schemas/TopicSearchResponseDTO"
        images:
          type: array
          items:
            $ref: "#/components/schemas/TopicImageDTO"

    TopicSearchResponseDTO:
      type: object
      required:
        - topic_id
      properties:
        topic_id:
          type: integer
          format: int64
        subcategory_id:
          type: integer
          format: int64
        subcategory_key:
          type: string
        topic_values:
          type: array
          items:
            $ref: "#/components/schemas/TopicSearchValueResponseDTO"
        topic_images:
          type: array
          items:
            $ref: "#/components/schemas/TopicImageDTO"

    TopicSearchValueResponseDTO:
      type: object
      required:
        - topic_id
        - field_id
        - key
        - value
      properties:
        topic_id:
          type: integer
          format: int64
        field_id:
          type: integer
          format: int64
        key:
          type: string
        value:
          type: string

    UserDTO:
      type: object
      required:
        - first_name
        - last_name
        - email
      properties:
        first_name:
          type: string
          nullable: false
          minLength: 1
          pattern: ^(?!\s*$).+
        last_name:
          type: string
          nullable: false
          minLength: 1
          pattern: ^(?!\s*$).+
        email:
          type: string
          format: email
          nullable: false
        phone_number:
          type: string

    UserResponseDTO:
      type: object
      required:
        - id
        - first_name
        - last_name
        - email
      properties:
        id:
          type: string
          format: uuid
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
          format: email
        phone_number:
          type: string

    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: >
            A URI reference that uniquely identifies the problem type only in the
            context of the provided API. Opposed to the specification in RFC-7807,
            it is neither recommended to be dereferenceable and point to a
            human-readable documentation nor globally unique for the problem type.
          default: "about:blank"
          example: "/problem/connection-error"
        title:
          type: string
          description: >
            A short summary of the problem type. Written in English and readable
            for engineers, usually not suited for non technical stakeholders and
            not localized.
          example: Service Unavailable
        status:
          type: integer
          format: int32
          description: >
            The HTTP status code generated by the origin server for this occurrence
            of the problem.
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
          example: 500
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurrence of the
            problem that is helpful to locate the problem and give advice on how
            to proceed. Written in English and readable for engineers, usually not
            suited for non technical stakeholders and not localized.
          example: Connection to database timed out
        instance:
          type: string
          format: uri-reference
          description: >
            A URI reference that identifies the specific occurrence of the problem,
            e.g. by adding a fragment identifier or sub-path to the problem type.
            May be used to locate the root of this problem in the source code.
          example: "/problem/connection-error#token-info-read-timed-out"

security:
  - bearerAuth: [ ]