Orders Service (Changelog)

Service that handles orders

Service

  • 2024-08-01 (latest)

    openapi.yml CHANGED
    openapi: 3.1.0
    0
      info:
    1
      title: Simple Task - API
    2
    - version: 1.0.0
    3
      description: Simple Api
    4
      contact: {}
    5
      license:
    6
      name: apache 2.0
    7
      identifier: apache-2.0
    8
      url: https://www.apache.org/licenses/LICENSE-2.0.html
    9
     
    10
      servers:
    11
      - url: https://example.com/
    12
     
    13
      paths:
    14
      /v1/task/{id}:
    15
      put:
    16
      summary: Do Simple Task
    17
      operationId: DoSimpleTask
    18
      responses:
    19
      '200':
    20
      description: do a task by id
    21
      content:
    22
      application/json:
    23
      schema:
    24
      $ref: '#/components/schemas/Task'
    25
      '204':
    26
      description: No content
    27
      '400':
    28
      description: Problem with data
    29
      content:
    30
      application/json:
    31
      schema:
    32
      $ref: '#/components/schemas/Error'
    33
      '403':
    34
      description: Not Authorized
    35
      content:
    36
      application/json:
    37
      schema:
    38
      $ref: '#/components/schemas/Unauthorized'
    39
      '404':
    40
      description: not found
    41
      content:
    42
      application/json:
    43
      schema:
    44
      $ref: '#/components/schemas/Error'
    45
      '500':
    46
      description: Internal server error
    47
      content:
    48
      application/json:
    49
      schema:
    50
      $ref: '#/components/schemas/Error'
    51
      description: Allows to do a simple task
    52
      security:
    53
      - authorization: []
    54
      parameters:
    55
      - in: path
    56
      name: id
    57
      required: true
    58
      schema:
    59
      type: string
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
    60
     
    61
      components:
    62
      schemas:
    63
      Task:
    64
      properties:
    65
      comments:
    66
      type: string
    67
      creationDate:
    68
      type: string
    69
      taskId:
    70
      type: string
    71
      description:
    72
      type: string
    73
      lastUpdate:
    74
      type: string
    75
      type: object
    76
      additionalProperties: false
    77
      Error:
    78
      properties:
    79
      error:
    80
      type: string
    81
      required:
    82
      - error
    83
      type: object
    84
      Unauthorized:
    85
      properties:
    86
      message:
    87
      type: string
    88
      required:
    89
      - message
    90
      type: object
    91
      securitySchemes:
    92
      authorization:
    93
      type: http
    94
    - scheme: bearer
     
    0
      info:
    1
      title: Simple Task - API
    2
    + version: 1.0.2
    3
      description: Simple Api
    4
      contact: {}
    5
      license:
    6
      name: apache 2.0
    7
      identifier: apache-2.0
    8
      url: https://www.apache.org/licenses/LICENSE-2.0.html
    9
     
    10
      servers:
    11
      - url: https://example.com/
    12
     
    13
      paths:
    14
      /v1/task/{id}:
    15
      put:
    16
      summary: Do Simple Task
    17
      operationId: DoSimpleTask
    18
      responses:
    19
      '200':
    20
      description: do a task by id
    21
      content:
    22
      application/json:
    23
      schema:
    24
      $ref: '#/components/schemas/Task'
    25
      '204':
    26
      description: No content
    27
      '400':
    28
      description: Problem with data
    29
      content:
    30
      application/json:
    31
      schema:
    32
      $ref: '#/components/schemas/Error'
    33
      '403':
    34
      description: Not Authorized
    35
      content:
    36
      application/json:
    37
      schema:
    38
      $ref: '#/components/schemas/Unauthorized'
    39
      '404':
    40
      description: not found
    41
      content:
    42
      application/json:
    43
      schema:
    44
      $ref: '#/components/schemas/Error'
    45
      '500':
    46
      description: Internal server error
    47
      content:
    48
      application/json:
    49
      schema:
    50
      $ref: '#/components/schemas/Error'
    51
      description: Allows to do a simple task
    52
      security:
    53
      - authorization: []
    54
      parameters:
    55
      - in: path
    56
      name: id
    57
      required: true
    58
      schema:
    59
      type: string
    60
    + delete:
    61
    + summary: Delete Task
    62
    + operationId: DeleteTask
    63
    + responses:
    64
    + '204':
    65
    + description: Task deleted
    66
    + '400':
    67
    + description: Problem with data
    68
    + content:
    69
    + application/json:
    70
    + schema:
    71
    + $ref: '#/components/schemas/Error'
    72
    + '403':
    73
    + description: Not Authorized
    74
    + content:
    75
    + application/json:
    76
    + schema:
    77
    + $ref: '#/components/schemas/Unauthorized'
    78
    + '404':
    79
    + description: not found
    80
    + content:
    81
    + application/json:
    82
    + schema:
    83
    + $ref: '#/components/schemas/Error'
    84
    + '500':
    85
    + description: Internal server error
    86
    + content:
    87
    + application/json:
    88
    + schema:
    89
    + $ref: '#/components/schemas/Error'
    90
    + description: Delete a task
    91
    + security:
    92
    + - authorization: []
    93
    + parameters:
    94
    + - in: path
    95
    + name: id
    96
    + required: true
    97
    + schema:
    98
    + type: string
    99
    + /v1/tasks:
    100
    + get:
    101
    + summary: Get List of Tasks
    102
    + operationId: GetTaskList
    103
    + responses:
    104
    + '200':
    105
    + description: Successfully retrieved list of tasks
    106
    + content:
    107
    + application/json:
    108
    + schema:
    109
    + type: array
    110
    + items:
    111
    + $ref: '#/components/schemas/Task'
    112
    + '400':
    113
    + description: Bad request
    114
    + content:
    115
    + application/json:
    116
    + schema:
    117
    + $ref: '#/components/schemas/Error'
    118
    + '403':
    119
    + description: Not Authorized
    120
    + content:
    121
    + application/json:
    122
    + schema:
    123
    + $ref: '#/components/schemas/Unauthorized'
    124
    + '500':
    125
    + description: Internal server error
    126
    + content:
    127
    + application/json:
    128
    + schema:
    129
    + $ref: '#/components/schemas/Error'
    130
    + description: Retrieves a list of all tasks
    131
    + security:
    132
    + - authorization: []
    133
    + parameters:
    134
    + - in: query
    135
    + name: limit
    136
    + schema:
    137
    + type: integer
    138
    + minimum: 1
    139
    + maximum: 100
    140
    + default: 20
    141
    + description: The maximum number of tasks to return
    142
    + - in: query
    143
    + name: offset
    144
    + schema:
    145
    + type: integer
    146
    + minimum: 0
    147
    + default: 0
    148
    + description: The number of tasks to skip before starting to return results
    149
     
    150
      components:
    151
      schemas:
    152
      Task:
    153
      properties:
    154
      comments:
    155
      type: string
    156
      creationDate:
    157
      type: string
    158
      taskId:
    159
      type: string
    160
      description:
    161
      type: string
    162
      lastUpdate:
    163
      type: string
    164
      type: object
    165
      additionalProperties: false
    166
      Error:
    167
      properties:
    168
      error:
    169
      type: string
    170
      required:
    171
      - error
    172
      type: object
    173
      Unauthorized:
    174
      properties:
    175
      message:
    176
      type: string
    177
      required:
    178
      - message
    179
      type: object
    180
      securitySchemes:
    181
      authorization:
    182
      type: http
    183
    + scheme: bearer

  • 2024-08-01