sumup-openapi/common.yaml at main · sumup/sumup-openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
components:
  schemas:
    Problem:
      type: object
      description: |
        A RFC 9457 problem details object.

        Additional properties specific to the problem type may be present.
      required:
        - type
      additionalProperties: true
      properties:
        type:
          type: string
          format: uri
          description: A URI reference that identifies the problem type.
          example: https://developer.sumup.com/problem/not-found
        title:
          type: string
          description: A short, human-readable summary of the problem type.
          example: Requested resource couldn't be found.
        status:
          type: integer
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          example: 404
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: The requested resource doesn't exist or does not belong to you.
        instance:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem.
    Metadata:
      description: >-
        Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
      type: object
      maxProperties: 64
      example: {}
      additionalProperties: true
      x-go-type-skip-optional-pointer: true
  parameters:
    MerchantCode:
      name: merchant_code
      description: Short unique identifier for the merchant.
      in: path
      required: true
      schema:
        type: string
        example: MK10CL2A