Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit fb89ba5

Browse files
author
Tenda Digital
committed
Update layers-backend OpenAPI specifications according to commit eabe478b
1 parent ec7d758 commit fb89ba5

File tree

2 files changed

+141
-19
lines changed

2 files changed

+141
-19
lines changed

‎scripts/data/apis/apihub.json

+113-14
Original file line numberDiff line numberDiff line change
@@ -702,13 +702,14 @@
702702
"community": {
703703
"type": "string",
704704
"description": "Identificador da comunidade",
705-
"example": "test"
705+
"example": "idcomunidadeteste"
706706
}
707707
}
708708
},
709709
"secret": {
710710
"type": "string",
711-
"description": "Chave secreta específica do app"
711+
"description": "Chave secreta específica do app",
712+
"example": "exemplo1-e000-11xe-2m33-4444444plo"
712713
}
713714
}
714715
},
@@ -730,7 +731,8 @@
730731
"limit": {
731732
"type": "number",
732733
"format": "integer",
733-
"description": "Quantidade máxima de publicações que devem ser retornadas"
734+
"description": "Quantidade máxima de publicações que devem ser retornadas",
735+
"example": 10
734736
},
735737
"after": {
736738
"type": "string",
@@ -761,7 +763,8 @@
761763
"limit": {
762764
"type": "number",
763765
"format": "integer",
764-
"description": "Quantidade máxima de eventos que devem ser retornados"
766+
"description": "Quantidade máxima de eventos que devem ser retornados",
767+
"example": 10
765768
},
766769
"after": {
767770
"type": "string",
@@ -914,7 +917,8 @@
914917
"properties": {
915918
"id": {
916919
"type": "string",
917-
"description": "Identificador do usuário"
920+
"description": "Identificador do usuário",
921+
"example": "61b087e1a608106241d30a8a"
918922
},
919923
"name": {
920924
"type": "string",
@@ -1544,7 +1548,7 @@
15441548
},
15451549
"url": {
15461550
"type": "string",
1547-
"description": "URL para fazer download do anexo. Obrigatóriamente uma url HTTPS",
1551+
"description": "URL para fazer download do anexo. Obrigatoriamente uma url HTTPS",
15481552
"example": "https://calculo.pdf"
15491553
}
15501554
}
@@ -1686,7 +1690,7 @@
16861690
},
16871691
"url": {
16881692
"type": "string",
1689-
"description": "URL para fazer download do anexo. Obrigatóriamente uma url HTTPS",
1693+
"description": "URL para fazer download do anexo. Obrigatoriamente uma url HTTPS",
16901694
"example": "https://calculo.pdf"
16911695
}
16921696
}
@@ -1712,7 +1716,7 @@
17121716
"properties": {
17131717
"url": {
17141718
"type": "string",
1715-
"description": "URL para videoconferência. Obrigatóriamente uma url HTTPS",
1719+
"description": "URL para videoconferência. Obrigatoriamente uma url HTTPS",
17161720
"example": "https://meet.google.com/ABCD"
17171721
},
17181722
"type": {
@@ -2017,7 +2021,7 @@
20172021
},
20182022
"url": {
20192023
"type": "string",
2020-
"description": "URL para fazer download do anexo. Obrigatóriamente uma url HTTPS",
2024+
"description": "URL para fazer download do anexo. Obrigatoriamente uma url HTTPS",
20212025
"example": "https://calculo.pdf"
20222026
}
20232027
}
@@ -2313,7 +2317,7 @@
23132317
},
23142318
"url": {
23152319
"type": "string",
2316-
"description": "URL para fazer download do anexo. Obrigatóriamente uma url HTTPS",
2320+
"description": "URL para fazer download do anexo. Obrigatoriamente uma url HTTPS",
23172321
"example": "https://calculo.pdf"
23182322
}
23192323
}
@@ -2435,6 +2439,40 @@
24352439
}
24362440
}
24372441
}
2442+
},
2443+
"attachments": {
2444+
"type": "array",
2445+
"description": "Arquivo com quadro horário",
2446+
"items": {
2447+
"type": "object",
2448+
"required": [
2449+
"title",
2450+
"type",
2451+
"url"
2452+
],
2453+
"properties": {
2454+
"title": {
2455+
"type": "string",
2456+
"description": "Título do anexo",
2457+
"example": "Horarios.pdf"
2458+
},
2459+
"type": {
2460+
"type": "string",
2461+
"enum": [
2462+
"file",
2463+
"link",
2464+
"image"
2465+
],
2466+
"description": "Tipo do anexo",
2467+
"example": "file`"
2468+
},
2469+
"url": {
2470+
"type": "string",
2471+
"description": "URL para fazer download do anexo. Obrigatoriamente uma url HTTPS",
2472+
"example": "https://Horarios.pdf"
2473+
}
2474+
}
2475+
}
24382476
}
24392477
}
24402478
}
@@ -2729,7 +2767,7 @@
27292767
},
27302768
"url": {
27312769
"type": "string",
2732-
"description": "URL do arquivo. Obrigatóriamente uma url HTTPS",
2770+
"description": "URL do arquivo. Obrigatoriamente uma url HTTPS",
27332771
"example": "https://hospitalexample.com.br/prontuariojaneiro.pdf"
27342772
}
27352773
}
@@ -2930,7 +2968,7 @@
29302968
"properties": {
29312969
"link": {
29322970
"type": "string",
2933-
"description": "URL de download do boleto. Obrigatóriamente uma url HTTPS",
2971+
"description": "URL de download do boleto. Obrigatoriamente uma url HTTPS",
29342972
"example": "https://boleto.pdf"
29352973
},
29362974
"code": {
@@ -2981,7 +3019,7 @@
29813019
},
29823020
"url": {
29833021
"type": "string",
2984-
"description": "Link para baixar o anexo. Obrigatóriamente uma url HTTPS",
3022+
"description": "Link para baixar o anexo. Obrigatoriamente uma url HTTPS",
29853023
"example": "https://url.para-download.com"
29863024
}
29873025
}
@@ -3547,7 +3585,68 @@
35473585
"fields": {
35483586
"type": "object",
35493587
"description": "Campos personalizados para o grupo",
3550-
"nullable": true
3588+
"nullable": true,
3589+
"properties": {
3590+
"@education:basic": {
3591+
"type": "object",
3592+
"description": "Campo personalizado de educação básica",
3593+
"required": [
3594+
"nivel",
3595+
"periodo",
3596+
"tipo"
3597+
],
3598+
"properties": {
3599+
"nivel": {
3600+
"type": "string",
3601+
"enum": [
3602+
"EI:G0",
3603+
"EI:G1",
3604+
"EI:G2",
3605+
"EI:G3",
3606+
"EI:G4",
3607+
"EI:G5",
3608+
"EF:A1",
3609+
"EF:A2",
3610+
"EF:A3",
3611+
"EF:A4",
3612+
"EF:A5",
3613+
"EF:A6",
3614+
"EF:A7",
3615+
"EF:A8",
3616+
"EF:A9",
3617+
"EM:S1",
3618+
"EM:S2",
3619+
"EM:S3"
3620+
],
3621+
"description": "Identificador da turma",
3622+
"example": "EM:S3"
3623+
},
3624+
"periodo": {
3625+
"description": "Lista de identificadores de períodos relacionados a esse componente",
3626+
"type": "array",
3627+
"items": {
3628+
"type": "string",
3629+
"description": "Identificadores de períodos",
3630+
"example": [
3631+
"manha",
3632+
"tarde"
3633+
]
3634+
}
3635+
},
3636+
"tipo": {
3637+
"type": "string",
3638+
"enum": [
3639+
"regular",
3640+
"idiomas",
3641+
"extracurricular",
3642+
"integral"
3643+
],
3644+
"description": "Tipo de ensino",
3645+
"example": "regular"
3646+
}
3647+
}
3648+
}
3649+
}
35513650
},
35523651
"tags": {
35533652
"type": "array",

‎scripts/data/apis/notification.json

+28-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
}
1212
],
1313
"paths": {
14-
"/notication": {
14+
"/notification": {
1515
"post": {
1616
"tags": [
1717
"Notificações"
@@ -48,21 +48,44 @@
4848
"items": {
4949
"type": "string",
5050
"description": "Id de um usuário"
51-
}
51+
},
52+
"example": [
53+
"61087e1a608106241d30a8aa",
54+
"32123e1a608106241d30a8aa",
55+
"61087e1c123406241d30c9dd"
56+
]
5257
},
5358
"title": {
5459
"type": "string",
5560
"maxLength": 65,
56-
"description": "Título da notificação"
61+
"description": "Título da notificação",
62+
"example": "Título da minha Notificação"
5763
},
5864
"body": {
5965
"type": "string",
6066
"maxLength": 178,
61-
"description": "Texto do corpo da notificação"
67+
"description": "Texto do corpo da notificação",
68+
"example": "Corpo da minha notificação"
69+
},
70+
"data": {
71+
"type": "object",
72+
"properties": {
73+
"location": {
74+
"type": "string",
75+
"description": "Localização do portal na layers",
76+
"example": "/portal/@seuApp"
77+
},
78+
"community": {
79+
"type": "string",
80+
"description": "Comunidade na layers",
81+
"example": "comunidade"
82+
}
83+
}
6284
},
6385
"scheduleDate": {
6486
"type": "string",
65-
"description": "Data em formato ISO8601 com o momento em que deve ser enviada a notificação. Caso o paramêtro não esteja presente, a notificação é enviada instantaneamente."
87+
"description": "Data em formato ISO8601 com o momento em que deve ser enviada a notificação. Caso o paramêtro não esteja presente, a notificação é enviada instantaneamente.",
88+
"example": "2030-09-07T15:50-03:00"
6689
}
6790
}
6891
}

0 commit comments

Comments
 (0)