Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
5403 lines (5230 loc) · 182 KB
/
Copy pathopenapi.yaml
File metadata and controls
5403 lines (5230 loc) · 182 KB
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Sinapse Service Contracts
version: 0.1.0
description: Contratos versionados entre backend, serviço de IA e automações n8n.
servers:
- url: http://localhost:3001
description: Backend Node.js
- url: http://localhost:8000
description: Serviço de IA local
paths:
/api/v1/quality/configuration/definitions:
get:
summary: Consultar DoR e DoD da organização por nível
tags: [Quality]
security: [{bearerAuth: []}]
responses:
'200':
description: Definições descritivas, versão, autor e data; listas inicialmente vazias
content:
application/json:
schema:
type: object
properties:
version: {type: integer}
updated_by: {type: string, format: uuid, nullable: true}
updated_by_name: {type: string, nullable: true}
updated_at: {type: string, format: date-time}
levels: &workDefinitionLevels
type: object
additionalProperties: false
required: [epico, feature, pbi]
properties:
epico: &workDefinition
type: object
additionalProperties: false
required: [dor, dod]
properties:
dor: {type: array, maxItems: 50, uniqueItems: true, items: {type: string, minLength: 1, maxLength: 500, pattern: '^[^\r\n\u2028\u2029]*$'}}
dod: {type: array, maxItems: 50, uniqueItems: true, items: {type: string, minLength: 1, maxLength: 500, pattern: '^[^\r\n\u2028\u2029]*$'}}
feature: *workDefinition
pbi: *workDefinition
'401': {description: Autenticação obrigatória}
put:
summary: Administrador atualiza DoR e DoD sem alterar as verificações automáticas
tags: [Quality]
security: [{bearerAuth: []}]
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required: [expected_version, levels]
properties:
expected_version: {type: integer, minimum: 1, maximum: 2147483646}
levels: *workDefinitionLevels
responses:
'200': {description: Definições gravadas com versão incrementada, autor/data e auditoria; mesmo formato da consulta}
'400': {description: Condições inválidas, duplicadas ou acima dos limites}
'401': {description: Autenticação obrigatória}
'403': {description: Somente administrador pode alterar}
'409': {description: Versão desatualizada; recarregar antes de salvar}
/api/v1/projects/{projectId}/index-events:
parameters:
- {name: projectId, in: path, required: true, schema: {type: string, format: uuid}}
get:
summary: Lista os últimos 100 eventos de indexação do projeto
operationId: listIndexEvents
security: [{cookieAuth: []}]
responses:
'200':
description: Estados, versões, tentativas e códigos seguros de falha, sem conteúdo da origem.
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/IndexEvent'
'401': {$ref: '#/components/responses/Unauthorized'}
'404': {description: Projeto inexistente ou sem acesso}
/api/v1/projects/{projectId}/index-events/{eventId}/reprocess:
parameters:
- {name: projectId, in: path, required: true, schema: {type: string, format: uuid}}
- {name: eventId, in: path, required: true, schema: {type: string, format: uuid}}
post:
summary: Reenfileira um evento de indexação (admin ou PO)
operationId: reprocessIndexEvent
description: Repetir enquanto pendente preserva a fila. Eventos substituídos retornam 404; reserva ativa ou projeto arquivado retorna 409.
security: [{cookieAuth: []}]
responses:
'202':
description: Evento pendente
content:
application/json:
schema:
type: object
properties:
status: {type: string, enum: [pendente]}
'400': {$ref: '#/components/responses/ValidationError'}
'401': {$ref: '#/components/responses/Unauthorized'}
'403': {description: Sem permissão de escrita}
'404': {description: Projeto ou evento inexistente ou sem acesso}
'409': {description: Projeto arquivado ou evento em processamento}
/api/v1/projects/{projectId}/documents/{documentId}/excerpts:
parameters:
- {name: projectId, in: path, required: true, schema: {type: string, format: uuid}}
- {name: documentId, in: path, required: true, schema: {type: string, format: uuid}}
get:
summary: Lê o texto indexado do documento na página do trecho selecionado
operationId: readDocumentExcerpts
security: [{cookieAuth: []}]
parameters:
- {name: chunk_id, in: query, required: true, schema: {type: string, format: uuid}}
- {name: offset, in: query, schema: {type: integer, minimum: 0, maximum: 99999999}}
responses:
'200':
description: Página de até 20 trechos em ordem de origem, sem embeddings.
content:
application/json:
schema:
type: object
required: [document, items, offset, total, next_offset]
properties:
document:
type: object
properties:
id: {type: string, format: uuid}
name: {type: string}
project_id: {type: string, format: uuid}
items:
type: array
items:
type: object
properties:
id: {type: string, format: uuid}
text: {type: string}
index: {type: integer, minimum: 0}
offset: {type: integer, minimum: 0}
total: {type: integer, minimum: 0}
next_offset: {type: integer, nullable: true}
'400': {$ref: '#/components/responses/ValidationError'}
'401': {$ref: '#/components/responses/Unauthorized'}
'404': {description: Documento ou trecho indisponível ou sem acesso ao projeto}
/api/v1/admin/ai-harness/{mode}:
parameters:
- $ref: '#/components/parameters/HarnessMode'
get:
operationId: getHarnessConfiguration
summary: Consulta a revisão vigente e os schemas do modo (somente admin)
security: [{cookieAuth: []}]
responses:
'200':
description: Revisão vigente; versão zero corresponde à configuração distribuída
content:
application/json:
schema: {$ref: '#/components/schemas/HarnessRevision'}
'400': {description: Modo inválido}
'401': {description: Autenticação necessária}
'403': {description: Somente administrador}
put:
operationId: updateHarnessConfiguration
summary: Publica uma nova revisão independente; próxima solicitação usa a mudança sem reinício
security: [{cookieAuth: []}]
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required: [expected_version, config]
properties:
expected_version: {type: integer, minimum: 0, maximum: 2147483646}
config: {$ref: '#/components/schemas/HarnessConfig'}
responses:
'201':
description: Revisão publicada e imediatamente vigente
content:
application/json:
schema: {$ref: '#/components/schemas/HarnessRevision'}
'400': {description: Configuração ou modo inválido}
'401': {description: Autenticação necessária}
'403': {description: Somente administrador}
'409': {description: Outra revisão foi publicada; recarregue antes de salvar}
/api/v1/admin/ai-harness/{mode}/history:
get:
operationId: listHarnessHistory
summary: Histórico imutável do modo, até 50 revisões por página
security: [{cookieAuth: []}]
parameters:
- $ref: '#/components/parameters/HarnessMode'
- in: query
name: before
schema: {type: integer, minimum: 1, maximum: 999999999}
responses:
'200':
description: Histórico do mais recente para o mais antigo; next_before permite continuar
content:
application/json:
schema:
type: object
properties:
items:
type: array
items: {$ref: '#/components/schemas/HarnessRevision'}
next_before: {type: integer, nullable: true}
'400': {description: Modo ou cursor inválido}
'401': {description: Autenticação necessária}
'403': {description: Somente administrador}
/api/v1/admin/projects/{id}/purge:
post:
operationId: purgeProjectContext
summary: Expurgo transacional do contexto indexado do projeto (PBI-02.2.4 / S2-05)
description: >
Remove todo o conteúdo indexado (tabela chunk e fila de eventos) do projeto informado,
exigindo a confirmação explícita do nome do projeto. Preserva intactos os demais projetos
e registra auditoria da operação administrativa.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: ID do projeto a ser expurgado
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- confirmacao_nome
properties:
confirmacao_nome:
type: string
description: Digitação do nome exato do projeto para confirmar o expurgo
justificativa:
type: string
description: Justificativa opcional da operação de expurgo
responses:
'200':
description: Contexto do projeto expurgado com sucesso
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: sucesso
message:
type: string
projeto_id:
type: string
format: uuid
projeto_nome:
type: string
chunks_removidos:
type: integer
documentos_cancelados:
type: integer
description: Documentos tirados da fila e leases invalidados pelo expurgo
relatorios_cancelados:
type: integer
description: Relatórios com aprovação revogada e leases invalidados; exigem nova revisão humana
eventos_removidos:
type: integer
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Somente administrador
'404':
description: Projeto não encontrado
/api/v1/projects/{projectId}/ai/requests:
post:
operationId: runHarness
summary: Executa o harness local vigente sem gravar conteúdo do item
description: >
Exige admin ou PO e acesso ao projeto. Trechos de consulta/recomendação são recuperados
pelo backend no projeto autorizado; não podem ser fornecidos pelo cliente. Levantamento
aceita campos do nível e texto_livre. Consulta/recomendação aceitam pergunta. Combinações
válidas são levantamento/questionar,padronizar,cenarios; consulta/responder; recomendacao/similares.
Cenários detalhados são exclusivos de PBI e exigem a história completa (COMO UM, EU QUERO
e PARA QUE); sem ela a resposta é 400 HISTORIA_INCOMPLETA e o modelo não é consultado.
Cada cenário sugerido tem nome, tipo (caminho_principal, acesso_nao_autorizado ou alternativo),
dado, quando e entao. Há sempre um caminho_principal e, quando a história ou as regras citam
um termo de rules.permission_terms, também um acesso_nao_autorizado cujo entao descreve a recusa
(verificação lexical; não valida a regra de permissão em si) (S2-11). Schemas JSON
estritos por operação e nível estão disponíveis em getHarnessConfiguration. Qualquer falha
de geração ou validação retorna 503.
security: [{cookieAuth: []}]
parameters:
- in: path
name: projectId
required: true
schema: {type: string, format: uuid}
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required: [mode, operation]
properties:
mode: {type: string, enum: [levantamento, consulta, recomendacao]}
operation: {type: string, enum: [questionar, padronizar, cenarios, responder, similares]}
level: {type: string, enum: [epico, feature, pbi], default: pbi}
fields:
type: object
maxProperties: 10
additionalProperties: {type: string, maxLength: 6000}
responses:
'200':
description: Saída validada; nenhuma gravação no item e nenhum registro do prompt
content:
application/json:
schema:
type: object
required: [mode, version, schema_version, operation, level, result]
properties:
mode: {type: string, enum: [levantamento, consulta, recomendacao]}
version: {type: integer, minimum: 0}
schema_version: {type: integer, enum: [1]}
operation: {type: string}
level: {type: string, enum: [epico, feature, pbi]}
result: {type: object, description: Saída conforme o schema da operação/nível da revisão}
'400':
description: >
Solicitação inválida. Em cenarios com história incompleta, code é HISTORIA_INCOMPLETA
e details.campos lista os blocos vazios da história.
content:
application/json:
schema:
type: object
properties:
error: {type: string}
code: {type: string, enum: [VALIDATION_ERROR, HISTORIA_INCOMPLETA]}
details:
type: object
properties:
campos:
type: array
items: {type: string, enum: [historia_como_um, historia_eu_quero, historia_para_que]}
'401': {description: Autenticação necessária}
'403': {description: Perfil sem permissão}
'404': {description: Projeto inexistente ou sem acesso}
'503': {description: IA indisponível ou saída rejeitada; edição preservada}
/api/v1/projects/{projectId}/epicos:
$ref: './epics-compat.yaml#/collection'
/api/projects/{projectId}/epicos:
$ref: './epics-compat.yaml#/collection'
/api/v1/epicos/{id}:
$ref: './epics-compat.yaml#/item'
/api/epicos/{id}:
$ref: './epics-compat.yaml#/item'
/api/v1/epicos/{id}/complete:
$ref: './epics-compat.yaml#/complete'
/api/epicos/{id}/complete:
$ref: './epics-compat.yaml#/complete'
/health:
get:
summary: Verifica disponibilidade do serviço
security: []
responses:
'200':
description: Serviço saudável
'503':
description: Dependência indisponível
/api/v1/auth/login:
post:
summary: Autentica um usuário e inicia uma sessão
operationId: login
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
description: Autenticação realizada com sucesso
headers:
Set-Cookie:
description: Cookie HttpOnly da sessão. Em produção também utiliza Secure.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUserResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
description: Credenciais inválidas
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Usuário inativo
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Limite de tentativas de autenticação excedido temporariamente
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v1/auth/logout:
post:
summary: Encerra e revoga a sessão atual
operationId: logout
security:
- cookieAuth: []
responses:
'204':
description: Sessão encerrada com sucesso
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/auth/me:
get:
summary: Retorna o usuário autenticado
operationId: getAuthenticatedUser
security:
- cookieAuth: []
responses:
'200':
description: Usuário da sessão atual
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUserResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/projects:
post:
summary: Cadastra um novo projeto (PBI-01.1.1 / S1-03)
operationId: createProject
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403.
security:
- cookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
responses:
'201':
description: Projeto criado com sucesso com status ativo e auditoria registrada
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'403':
description: Perfil sem permissão de escrita
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
description: Conflito de nome duplicado entre projetos ativos
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
summary: Lista projetos com paginação e busca (S1-03)
operationId: listProjects
security:
- cookieAuth: []
parameters:
- name: status
in: query
required: false
description: Ausente exclui arquivados; arquivado retorna somente arquivados; todos inclui todos os estados.
schema:
type: string
enum: [ativo, em_andamento, concluido, arquivado, todos]
- name: busca
in: query
required: false
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
default: 50
minimum: 1
maximum: 100
- name: offset
in: query
required: false
schema:
type: integer
default: 0
minimum: 0
- name: order
in: query
required: false
schema:
type: string
enum: [created_at_desc, created_at_asc, nome_asc, nome_desc]
default: created_at_desc
responses:
'200':
description: Lista paginada de projetos
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProjectsResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/projects/{id}:
get:
summary: Obtém detalhes de um projeto por ID (S1-03)
operationId: getProjectById
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Detalhes do projeto com estatísticas
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Projeto não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
summary: Atualiza dados de um projeto (S1-03 / S1-08)
operationId: updateProject
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403. PATCH no mesmo caminho é um alias desta operação.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectRequest'
responses:
'200':
description: Projeto atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'403':
description: Perfil sem permissão de escrita
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Projeto não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Nome duplicado ou tentativa de editar projeto arquivado (somente leitura).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
patch:
summary: Atualiza dados de um projeto (S1-03 / S1-08) (parcial, mesmo corpo do PUT)
operationId: updateProjectPartial
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403. PATCH no mesmo caminho é um alias desta operação.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectRequest'
responses:
'200':
description: Projeto atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'403':
description: Perfil sem permissão de escrita
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Projeto não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Nome duplicado ou tentativa de editar projeto arquivado (somente leitura).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v1/projects/{id}/archive-impact:
get:
summary: Consulta quantidade de novos itens afetados pela cascata (S1-09)
operationId: getProjectArchiveImpact
description: Disponível para po e admin. Não modifica registros. Itens já arquivados não entram na contagem.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Contagens para confirmação explícita
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveImpact'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Perfil sem permissão de escrita
'404':
description: Projeto não encontrado
/api/v1/projects/{id}/archive:
patch:
summary: Arquiva projeto, épicos, features e PBIs em cascata (S1-09)
operationId: archiveProject
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [confirmado, impacto]
properties:
confirmado:
type: boolean
enum: [true]
impacto:
$ref: '#/components/schemas/ArchiveImpact'
justificativa:
type: string
maxLength: 2000
responses:
'400':
$ref: '#/components/responses/ValidationError'
'409':
description: Contagem mudou desde a prévia. Consultar novamente e pedir nova confirmação.
'200':
description: Cascata e auditoria confirmadas atomicamente. Repetição preserva as datas e não duplica auditoria.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'403':
description: Perfil sem permissão de escrita
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Projeto não encontrado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/api/v1/projects/{id}/backlog-tree:
get:
summary: Retorna a hierarquia do backlog e tecnologias associadas (S1-16)
operationId: getProjectBacklogTree
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Árvore ordenada dentro de um snapshot consistente do banco
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectBacklogTreeResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Projeto não encontrado
/api/v1/technologies:
get:
summary: Lista o catálogo de tecnologias para associação ao backlog
operationId: listTechnologies
security:
- cookieAuth: []
responses:
'200':
description: Catálogo ordenado sem dados pessoais de desenvolvedores
content:
application/json:
schema:
type: object
required: [items]
properties:
items:
type: array
items:
$ref: '#/components/schemas/TechnologyOption'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/epics:
post:
summary: Cadastra um épico dentro de um projeto (PBI-01.1.2 / S1-05)
operationId: createEpic
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403. Bloqueia projeto arquivado ou inexistente.
security:
- cookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEpicRequest'
responses:
'201':
description: Épico criado com status rascunho
content:
application/json:
schema:
$ref: '#/components/schemas/EpicResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Perfil sem permissão de escrita
'404':
description: Projeto não encontrado
get:
summary: Lista épicos de um projeto (S1-05)
operationId: listEpics
security:
- cookieAuth: []
parameters:
- name: projeto_id
in: query
schema:
type: string
format: uuid
- name: status
in: query
schema:
type: string
enum: [rascunho, concluido, ativo, arquivado, todos]
- name: limit
in: query
schema:
type: integer
default: 50
- name: offset
in: query
schema:
type: integer
default: 0
responses:
'200':
description: Lista paginada de épicos
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEpicsResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/epics/{id}:
get:
summary: Obtém detalhes de um épico por ID (S1-05)
operationId: getEpicById
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Detalhes do épico com estatísticas
content:
application/json:
schema:
$ref: '#/components/schemas/EpicResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: Épico não encontrado
put:
summary: Atualiza dados de um épico (S1-05)
operationId: updateEpic
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403. PATCH no mesmo caminho é um alias desta operação.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEpicRequest'
responses:
'200':
description: Épico atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/EpicResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Perfil sem permissão de escrita
'404':
description: Épico não encontrado
patch:
summary: Atualiza dados de um épico (S1-05) (parcial, mesmo corpo do PUT)
operationId: updateEpicPartial
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403. PATCH no mesmo caminho é um alias desta operação.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEpicRequest'
responses:
'200':
description: Épico atualizado
content:
application/json:
schema:
$ref: '#/components/schemas/EpicResponse'
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Perfil sem permissão de escrita
'404':
description: Épico não encontrado
/api/v1/epics/{id}/complete:
patch:
summary: Marca um épico como concluído quando os campos obrigatórios do guia e ao menos um critério existirem (PBI-01.1.2 / S1-05)
operationId: completeEpic
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Épico concluído
content:
application/json:
schema:
$ref: '#/components/schemas/EpicResponse'
'400':
description: Campos obrigatórios ou critérios de aceitação ausentes
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: Perfil sem permissão de escrita
'404':
description: Épico não encontrado
/api/v1/features:
post:
summary: Cadastra uma feature dentro de um épico (PBI-01.1.3 / S1-06)
operationId: createFeature
description: Escrita permitida apenas aos perfis po e admin; dev recebe 403.
security:
- cookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeatureRequest'