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
    +
    61
    + /v1/tasks:
    62
    + get:
    63
    + summary: Get List of Tasks
    64
    + operationId: GetTaskList
    65
    + responses:
    66
    + '200':
    67
    + description: Successfully retrieved list of tasks
    68
    + content:
    69
    + application/json:
    70
    + schema:
    71
    + type: array
    72
    + items:
    73
    + $ref: '#/components/schemas/Task'
    74
    + '400':
    75
    + description: Bad request
    76
    + content:
    77
    + application/json:
    78
    + schema:
    79
    + $ref: '#/components/schemas/Error'
    80
    + '403':
    81
    + description: Not Authorized
    82
    + content:
    83
    + application/json:
    84
    + schema:
    85
    + $ref: '#/components/schemas/Unauthorized'
    86
    + '500':
    87
    + description: Internal server error
    88
    + content:
    89
    + application/json:
    90
    + schema:
    91
    + $ref: '#/components/schemas/Error'
    92
    + description: Retrieves a list of all tasks
    93
    + security:
    94
    + - authorization: []
    95
    + parameters:
    96
    + - in: query
    97
    + name: limit
    98
    + schema:
    99
    + type: integer
    100
    + minimum: 1
    101
    + maximum: 100
    102
    + default: 20
    103
    + description: The maximum number of tasks to return
    104
    + - in: query
    105
    + name: offset
    106
    + schema:
    107
    + type: integer
    108
    + minimum: 0
    109
    + default: 0
    110
    + description: The number of tasks to skip before starting to return results
    111
     
    112
      components:
    113
      schemas:
    114
      Task:
    115
      properties:
    116
      comments:
    117
      type: string
    118
      creationDate:
    119
      type: string
    120
      taskId:
    121
      type: string
    122
      description:
    123
      type: string
    124
      lastUpdate:
    125
      type: string
    126
      type: object
    127
      additionalProperties: false
    128
      Error:
    129
      properties:
    130
      error:
    131
      type: string
    132
      required:
    133
      - error
    134
      type: object
    135
      Unauthorized:
    136
      properties:
    137
      message:
    138
      type: string
    139
      required:
    140
      - message
    141
      type: object
    142
      securitySchemes:
    143
      authorization:
    144
      type: http
    145
    + scheme: bearer

  • 2024-08-01