boletins-api-ws/swagger.yaml at master · dte005/boletins-api-ws · 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
openapi: 3.1.0
info:
  title: Licitações RPA
  version: 1.0.0
  description: "API para acionamento dos workers responsáveis por recuperar dados de licitações via Azure Service Bus."
security:
  - BearerAuth: []
servers: [
  {
    url: "https://apisdev.estapar.com.br/platform/Bidding",
    description: "Url de dev base para request",
  },
  {
    url: "https://apishml.estapar.com.br/platform/Bidding",
    description: "Url de hml base para request",
  },
  {
    url: "https://apis.estapar.com.br/platform/Bidding",
    description: "Url de prd base para request",
  }
]
paths:
  /bulletin/:
    post:
      tags:
        - Boletim
      summary: Recuperar boletim
      operationId: retrieve_bulletin_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulletinRequestDto'
        required: true
      responses:
        '201':
          description: >
            Solicitação aceita com sucesso. A mensagem foi publicada na fila do Azure Service Bus
            para processamento assíncrono. O ID retornado pode ser usado para consultar o status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulletinResponseDto'
  /bidding/:
    post:
      tags:
        - Licitação
      summary: Recuperar licitação
      operationId: retrieve_bidding_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BiddingRequestDto'
        required: true
      responses:
        '201':
          description: >
            Solicitação aceita com sucesso. A mensagem foi publicada na fila do Azure Service Bus
            para processamento assíncrono. O ID retornado pode ser usado para consultar o status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiddingResponseDto'
  /compare/:
    post:
      tags:
        - Comparação
      summary: Comparar
      operationId: compare_compare_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompareRequestDto'
        required: true
      responses:
        '201':
          description: >
            Solicitação aceita com sucesso. A mensagem foi publicada na fila do Azure Service Bus
            para processamento assíncrono. O ID retornado pode ser usado para consultar o status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompareResponseDto'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    BiddingRequestDto:
      properties:
        bidding_id:
          type: string
          title: ID da Licitação
      required:
        - bidding_id
      title: DTO de Requisição de Licitação
      type: object

    BiddingResponseDto:
      properties:
        id:
          type: string
          title: ID
        status:
          $ref: '#/components/schemas/WorkerStatus'
        queue_name:
          type: string
          title: Nome da Fila
        task_name:
          type: string
          title: Nome da Tarefa
      required:
        - id
        - status
        - queue_name
        - task_name
      title: DTO de Resposta de Licitação
      type: object

    BulletinRequestDto:
      properties:
        period:
          allOf:
            - $ref: '#/components/schemas/PeriodType'
          default: MRN
        target_date:
          anyOf:
            - type: string
              format: date
            - type: string
          title: Data Alvo
      required:
        - period
        - target_date
      title: DTO de Requisição de Boletim
      type: object

    BulletinResponseDto:
      properties:
        id:
          type: string
          title: ID
        status:
          $ref: '#/components/schemas/WorkerStatus'
        queue_name:
          type: string
          title: Nome da Fila
        task_name:
          type: string
          title: Nome da Tarefa
      required:
        - id
        - status
        - queue_name
        - task_name
      title: DTO de Resposta de Boletim
      type: object

    CompareRequestDto:
      properties:
        bidding_id:
          type: string
          title: ID da Licitação
      required:
        - bidding_id
      title: DTO de Requisição de Comparação
      type: object

    CompareResponseDto:
      properties:
        id:
          type: string
          title: ID
        status:
          $ref: '#/components/schemas/WorkerStatus'
        queue_name:
          type: string
          title: Nome da Fila
        task_name:
          type: string
          title: Nome da Tarefa
      required:
        - id
        - status
        - queue_name
        - task_name
      title: DTO de Resposta de Comparação
      type: object

    PeriodType:
      enum:
        - MRN
        - AFT
        - EVN
      title: Tipo de Período
      type: string

    PipelineType:
      enum:
        - bulletin
        - bidding
        - compare
      title: Tipo de Pipeline
      type: string

    WorkerStatus:
      enum:
        - success
        - progress
        - failure
      title: Status do Worker
      type: string