openapi-manifests/working_days__v1.yml at master · rollun-lc/openapi-manifests · 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
openapi: 3.0.0
info:
  version: "1"
  title: "WorkingDays"
  description: "A service that performs operations with working days"
servers:
  - url: http://utils/openapi/WorkingDays/v1
  - url: http://host.docker.internal:8091/openapi/WorkingDays/v1
  - url: http://localhost:8091/openapi/WorkingDays/v1
tags:
  - name: EndWorkingDate
  - name: WorkingDaysCount
paths:
  "/endWorkingDate":
    get:
      tags:
        - EndWorkingDate
      summary: "Add an amount of working time to a given start date-time"
      parameters:
        - name: startDate
          in: query
          required: true
          schema:
            type: string
            format: date-time
            example: '2025-01-27T16:00:00Z'
            description: "Start date and time in UTC format (Y-m-dTH:i:sZ)"
        - name: daysAmount
          in: query
          required: true
          schema:
            type: integer
            example: 3
            description: 'Amount of days need to add'
        - name: weekendDays
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
            example: [4, 5]
            description: 'Weekend days, where: 1 - Monday, 7 - Sunday (ISO-8601)'
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EndWorkingDateResult"
        '500':
          description: "Internal error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'

  "/workingDaysCount":
    get:
      tags:
        - WorkingDaysCount
      summary: "Return the number of working days between dates (including borders)"
      parameters:
        - name: startDate
          in: query
          required: true
          schema:
            type: string
            format: date
            example: '2038-01-19'
        - name: endDate
          in: query
          required: true
          schema:
            type: string
            format: date
            example: '2038-01-25'
        - name: weekendDays
          in: query
          required: false
          schema:
            type: array
            items:
              type: integer
            example: [4, 5]
            description: 'Weekend days, where: 1 - Monday, 7 - Sunday (ISO-8601)'
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkingDaysCountResult'
        "500":
          description: "Internal error"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResult"
components:
  schemas:
    ErrorResult:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: "#/components/schemas/Message"
      description: "Message field is not required"
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
        type:
          type: string
          enum:
            - UNDEFINED
            - LOGGER_MESSAGE
          description: >
            Enum for error types:
            UNDEFINED - Any undefined message type
            LOGGER_MESSAGE - Same as undefined
        text:
          type: string
          description: "Message describing what went wrong"
    SuccessResult:
      allOf:
        - $ref: '#/components/schemas/ErrorResult'
      type: object
      properties:
        data:
          type: object
    EndWorkingDateResultItem:
      type: object
      required:
        - endDate
      properties:
        endDate:
          type: string
          example: '2025-01-30T16:00:00Z'
          description: "Result of adding working days to a start date-time in UTC format (Y-m-dTH:i:sZ)"
    EndWorkingDateResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
      type: object
      properties:
        data:
          $ref: "#/components/schemas/EndWorkingDateResultItem"
    WorkingDaysCountResultItem:
      type: object
      required:
        - workingDays
      properties:
        workingDays:
          type: integer
          example: 6
    WorkingDaysCountResult:
      allOf:
        - $ref: '#/components/schemas/SuccessResult'
      type: object
      properties:
        data:
          $ref: '#/components/schemas/WorkingDaysCountResultItem'