-
Notifications
You must be signed in to change notification settings - Fork 2
/
apnf-man-platform-openapi.yaml
8666 lines (8415 loc) · 330 KB
/
apnf-man-platform-openapi.yaml
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: APNF MAN Platform - Platform API Reference
version: 1.7.0
description: |
# Introduction
Welcome to the APNF MAN platform API reference.
The APIs listed in this reference provide all functionalities available to service providers, including:
- create and manage the STI certificates to be used for signing their SIP telephone calls per the STIR SHAKEN
protocol
- crate and manage along with functionalities to manage access to the MAN platform.
- crate and manage users who shall be given access to the platform
Each provider registered with the APNF may request an access to the MAN platform and therefore these APIs.
## Authentication
All APIs listed in this document require the API client to be authenticated.
The authentication process relies on OAuth 2.0 protocol, where an access token needs
to be passed to the API request as a JSON Web TOKEN using the Bearer `Authorization` header.
```
Authorization: Bearer <JWT>
```
Refer to the *MAN Platform Authorization API Reference* on how to generate access tokens. Note that in order to
request an access token, you will first need to create an **API credential** as described in this reference.
## Requests & Headers
- A Bearer `Authorization` header is required, where the Bearer token shall be set with the access token generated by the MAN platform authorization API.
- A `X-Request-Id` header can be provided with an uuid. If provided, this header will be returned in the
`X-Response-Id` response header.
## Responses & Headers
Unless explicitly specified, all responses will use JSON for the response body format.
The `Content-Type` header will be included in all responses to make the type explicit.
Following headers are also included in responses:
- `Content-Type`: format of the response, if a body is included in the response.
- `Content-Length`: size in bytes of the response body, if a body is included in the response.
- `X-Response-Id`: uniquely identifies the response sent to the client. It corresponds to the `X-Request-Id`
request header if provided. Otherwise, a new value is generated,
- `X-Correlation-Id`: ID generated by the API gateway to track the request between the different services. This
value can be different from the `X-Response-Id` header.
## Dates
Unless specified, all dates exposed in this API comply with the ISO-8601 date format using UTC as the timezone.
## Common Error Codes
The following error codes can be returned:
| Error code | Description |
|:----------:|-------------------------------------------------------------------------|
| **400** | The request is malformed. |
| **401** | The authentication failed. |
| **403** | User is not allowed to access to the resource. |
| **404** | The resource does not exist. |
| **405** | The method is not allowed for the resource. |
| **406** | The format in the `Accept` header is not supported. |
| **409** | There is a conflict between the object status and the action requested |
| **415** | The format in the `Content-Type` header is not supported. |
| **429** | Too many requests have been sent by the client (see Rate Limiting). |
| **500** | An unexpected error occurred while processing the request. |
| **503** | The service is unavailable. |
## Rate Limiting
To ensure availability to all clients, concurrent accesses to this API are restricted per
below rate limiting logic:
- Each IP address is allowed to perform up to 600 calls during a period of 1 minute.
- The `GET /bpco/certificates` API method has an additional restriction, limiting calls to 1 per minute.
- Any additional call will be rejected by the API using a 429 "TOO_MANY_REQUESTS" error code
# References
Additional API references are also available, covering other functionalities:
- **MAN Platform Authentication API Reference**, providing the APIs to create access tokens require to authenticate against the APIs listed in this document.
- **MAN Platform GCO API Reference**, listing the MAN platform GCO (Gestionnaires des Certificats Opérateurs) module APIs, to manage service provider data in the MAN platform, including STI certificates.
- **MAN Platform BPCO API Reference**, listing APIs published as part of the BPCO (Base Publique des Certificats Opérateurs), the MAN platform public access service used to access STI certificates.
# History
**1.7.0** - 2024/09/09
- First release
servers:
- url: https://api.man-plateforme.fr/
description: Production platform
- url: https://api.pprod.man-plateforme.fr/
description: Preproduction platform
- url: https://api.vabf.man-plateforme.fr/
description: VABF platform
tags:
- name: Call Traces
description: |
Call traces are provided by service providers to identity calls
that seem legitimate to be broken due to invalid STIR SHAKEN implementation.
These traces are accessible only to the service providers identified
in the trace as being playing a role in the call transmission (signatory, transit, termination, etc...)
- name: Monitored SIP Interconnections
description: |
Creation and management APIs for SIP Interconnections between service providers.
- name: MAN Weather Reports
description: |
MAN platform weather reports can be generated by the platform itself or a service
provider to respectively identify issues on the platform with a potential impact
on normal operations, and issues on the service provider side leading to disengage
the STIR-SHAKEN signature process of their calls.
- name: Providers
description: |
Service provider registration, authorization and data management APIs.
While most of these APIs can only be accessed by the MAN platform administrators
to create and authorize service providers, these latter have access to a subset
for updating their organization settings and reviewing their authorization status & history.
- name: History
description: |
Platform activity logs access and search APIs.
These APIs give service providers a way to have access and review actions performed by their users
within the platform.
- name: Users
description: |
User creation and management APIs.
- name: Tickets
description: |
Tickets are created by a service provider to another provider to let
the latter know of a potential issue of their STIR-SHAKEN implementation
that needs to be investigated as soon as possible.
Tickets are therefore the official communication way between service providers
to discuss and resolve STIR-SHAKEN issues.
- name: API Credentials
description: |
API credentials creation and management APIs.
API credentials are required in the API authentication process for requesting access tokens.
Refer to the *MAN Platform Authentication API Reference* on how these credentials are used.
- name: STI Certificates
description: |
STI certificates creation and management APIs.
These APIs provide to service providers a full control of their STI certificates, with
support of functionalities like certificate renewal, revocation and delegation.
- name: STI Certificates (Archived)
description: |
STI certificates access APIs.
3 months after their expiration, STI certificates are automatically archived by the platform
and removed from the list of certificates. For tracking and forensics purposes, they however remain
available for 3 years in a dedicated list, after which they are deleted
once for all from the platform.
These APIs just provide read-only access; no updates are allowed on certificates once archived.
- name: BPCO
description: |
APIs related to BPCO (Base Publique des Certificats Opérateurs), the MAN platform public access
service to STI certificates.
These APIs provide access to metadata and download facilities to objects
published in the BPCO, like STI certificates and CRLs.
paths:
/calltraces:
get:
summary: Retrieve a paginated list of records with support of sorting & filtering
description: |
The API applies any sort and filter preferences passed to the API request and returns a
paginated list of corresponding results.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any trace attached to their
provider (as `author_provider`, `optv`, `opts`,`egress_provider`, `terminating_provider`,
`signatory_provider` or `ingress_provider`).
operationId: SearchTraces
tags:
- Call Traces
parameters:
- in: query
name: query
description: |
Filter on a property following the format `operator:value`.
If the operator is `eq`, it can be ignored.
For string, number, date-time or enum property:
* `eq` and `ne` = (not) equal.
For string property only:
* `match` and `not_match` = (not) match the wildcard pattern (`*` for zero or more
characters and `?` for a single character) contains in `value`.
For number or date-time property:
* `gt` and `gte` = greater than (or equal).
* `lt` and `lte` = less than (or equal).
In any case, `value` must be percent encoded.
The parameter name is one of the following values:
- `author_provider`
- `author_provider_role`
- `provider`
- `searched_provider` (only for *MAN_ADMINISTRATOR* and *APNF* users)
- `searched_provider_role`
- `optv`
- `opts`
- `egress_provider`
- `terminating_provider`
- `signatory_provider`
- `ingress_provider`
- `displayed_number_type`
- `called_number_type`
- `start_call_timestamp`
- `broken_call`
- `identity_header`
- `sip_reject_code`
- `sip_reject_subcode`
- `attestation`
- `emergency_call`
- `displayed_number`
- `pai`
- `called_number`
If the `searched_provider` is used (only for *MAN_ADMINISTRATOR* and *APNF* users), the
request will return any traces where the `searched_provider` is the `author_provider`,
the `optv`, the `opts`, the `egress_provider`, the `terminating_provider`, the `signatory_provider`
or the `ingress_provider` until the `searched_provider_role` is used.
If `searched_provider_role` is used, the request will return any traces where the
`searched_provider` has the role present into `searched_provider_role`
(`author_provider`, `optv`, `opts`, `egress_provider`, `terminating_provider`,
`signatory_provider` or `ingress_provider`).
schema:
additionalProperties:
type: string
pattern: ^((eq|ne|(not_)?match|[lg]te?):)?.+$
example:
author_provider: OPC000
start_call_timestamp: gte:2022-01-01T00:00:00Z
type: object
- $ref: '#/components/parameters/PaginationLimit'
- $ref: '#/components/parameters/PaginationOffset'
- name: sort
in: query
description: |
Sort preference using the format `property_name:order`, where:
- `property_name` is one of the following values:
- `author_provider`
- `provider`
- `signatory_provider`
- `start_call_timestamp`
- `broken_call`
- `identity_header`
- `sip_reject_code`
- `attestation`
- `emergency_call`
- `order` may be set to `asc` or `desc`.
schema:
example: start_call_timestamp:asc
pattern: ^((author_|signatory_|)provider|start_call_timestamp|broken_call|identity_header|sip_reject_code|attestation|emergency_call)(:(([Aa]|[Dd][Ee])[Ss][Cc]))?$
type: string
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return a paginated list of records
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
content:
application/json:
schema:
properties:
metadata:
$ref: '#/components/schemas/PaginationMetaData'
traces:
items:
$ref: '#/components/schemas/TraceSummaryView'
type: array
type: object
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/calltraces/{trace_id}:
get:
summary: Return traces details
description: |
Return a JSON object with trace details.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any trace attached to their provider.
operationId: GetTrace
tags:
- Call Traces
parameters:
- in: path
name: trace_id
description: ID of the trace.
required: true
schema:
$ref: '#/components/schemas/TraceId'
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return the JSON object with trace properties.
content:
application/json:
schema:
$ref: '#/components/schemas/Trace'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/ism:
get:
summary: Retrieve a paginated list of records with support of sorting & filtering
description: |
The API applies any sort and filter preferences passed to the API request and returns a paginated list of
corresponding results.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnections attached to their provider.
operationId: SearchIsm
tags:
- Monitored SIP Interconnections
parameters:
- name: query
in: query
description: |
Filter on a property following the format `operator:value`.
If the operator is `eq`, it can be ignored.
For string, number or date-time property:
* `eq` and `ne` = (not) equal.
In any case, `value` must be percent encoded.
The parameter name is one of the following values:
- `provider_emitter_code`
- `provider_emitter_status`
- `provider_receiver_code`
- `provider_receiver_status`
schema:
type: object
additionalProperties:
type: string
pattern: ^(((eq|ne|(not_)?match|[lg]te?):)?.+|(in|not_in):\[.+(,.+)*\])$
example:
provider_emitter_code: OPC000
provider_emitter_status: eq:MAN
- $ref: '#/components/parameters/PaginationLimit'
- $ref: '#/components/parameters/PaginationOffset'
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return a paginated list of records
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
content:
application/json:
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/PaginationMetaData'
interconnections:
type: array
items:
$ref: '#/components/schemas/ISMSummaryView'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
post:
summary: Initiate the creation of a monitored SIP interconnection
description: |
Initiate the creation of a new monitored SIP interconnection. Shall always be called by the provider emitter of the interconnection.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
operationId: CreateIsm
tags:
- Monitored SIP Interconnections
parameters:
- $ref: '#/components/parameters/X-Request-Id'
requestBody:
description: ISM details
required: true
content:
application/json:
schema:
type: object
required:
- provider_emitter_status
- provider_receiver_code
- provider_receiver_status
properties:
provider_emitter_status:
type: string
description: |
The status of the provider emitter
example: FULL MAN
provider_receiver_code:
type: string
description: |
The code of the provider receiver
pattern: ^([0-9A-Z]{6})$
example: SPB000
provider_receiver_status:
type: string
description: |
Default value = "NOT MAN"
- Can be set if the status of the emitting provider is different from "NOT MAN"
example: FULL MAN
interconnection_description:
type: string
description: |
Change the description of the interconnection
example: Une nouvelle description
responses:
'201':
description: Confirms the creation of the new monitored SIP interconnection properties and contents.
content:
application/json:
schema:
$ref: '#/components/schemas/ISMSummaryView'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/ism/export:
get:
summary: Return monitored SIP interconnections list in CSV format
description: |
Allows you to return, in CSV format, the list of monitored interconnections
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnection attached to their provider.
operationId: ExportIsm
tags:
- Monitored SIP Interconnections
parameters:
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return monitored SIP interconnections list in csv format
content:
text/csv:
example: |
ID;provider_emitter_code;provider_emitter_status;date_last_update_emitter;provider_receiver_code;provider_receiver_status;date_last_update_receiver;creation_date;interconnection_description
2f211b73-4a09-9830-b6e4-064f39399c36;GAMMA0;PARTIAL_MAN;2023-05-24T09:39:44;GAMMA1;NOT_MAN;2023-05-24T09:39:44;2023-05-24T09:39:44;Description
schema:
type: string
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/ism/{ism_id}:
delete:
summary: Delete monitored SIP interconnection
description: |
*Warning*: the action cannot be undone.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can delete any monitored SIP interconnection attached to their provider and by a provider emitter.
operationId: DeleteIsm
tags:
- Monitored SIP Interconnections
parameters:
- name: ism_id
in: path
description: ID of the interconnection.
required: true
schema:
$ref: '#/components/schemas/UUID'
- $ref: '#/components/parameters/X-Request-Id'
responses:
'204':
description: Confirms successful processing
headers:
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
get:
summary: Return monitored SIP interconnection details
description: |
Return a JSON object with monitored SIP interconnection details and contents.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnection attached to their provider.
operationId: GetIsm
tags:
- Monitored SIP Interconnections
parameters:
- name: ism_id
in: path
description: ID of the interconnection.
required: true
schema:
$ref: '#/components/schemas/UUID'
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return the JSON object with monitored SIP interconnection properties and contents.
content:
application/json:
schema:
$ref: '#/components/schemas/ISMSummaryView'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
patch:
summary: Update interconnection properties
description: |
Update interconnection properties. Only a subset of the interconnection properties can be updated and depending on the status of the provider's interconnection.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR* users can update any interconnection created by/for their provider.
operationId: UpdateIsm
tags:
- Monitored SIP Interconnections
parameters:
- name: ism_id
in: path
description: ID of the interconnection.
required: true
schema:
$ref: '#/components/schemas/UUID'
- $ref: '#/components/parameters/X-Request-Id'
requestBody:
required: true
description: |
A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
that must be updated (with the new value) or deleted (with null as value).
content:
application/merge-patch+json:
schema:
type: object
properties:
provider_emitter_status:
type: string
description: |
Change the status of the provider emitter
- Can only be changed by the provider emitter
example: FULL MAN
provider_receiver_status:
type: string
description: |
Change the status of the provider receiver
- Can only be changed by the provider receiver if the status of the emitting provider is different from "Non MAN"
example: FULL MAN
interconnection_description:
type: string
description: |
Change the description of the interconnection
example: Une nouvelle description
responses:
'200':
description: Return the JSON object with monitored SIP interconnection properties and contents.
content:
application/json:
schema:
$ref: '#/components/schemas/ISMSummaryView'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'404':
$ref: '#/components/responses/ErrorNotFound'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/meteo:
get:
summary: Return a list of meteo events matching the filters
description: |
The API applies any sort and filter preferences passed to the API request and returns a paginated list of
corresponding results.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- Anyone with access to the interface can read the events
operationId: ListMeteos
tags:
- MAN Weather Reports
parameters:
- $ref: '#/components/parameters/PaginationLimit'
- $ref: '#/components/parameters/PaginationOffset'
- name: query
in: query
description: |
Filter on a property following the format `operator:value`.
If the operator is `eq`, it can be ignored.
For string, number or date-time property:
* `eq` and `ne` = (not) equal.
* `in` and `not_in` = (not) in a list. `value` contains an array such as `[val1,val2,val3]`.
For string property only:
* `match` and `not_match` = (not) match the wildcard pattern (`*` for zero or more characters and `?` for a
single character) contains in `value`.
For number or date-time property:
* `gt` and `gte` = greater than (or equal).
* `lt` and `lte` = less than (or equal).
* `gtn` and `gten` = null or greater than (or equal).
* `ltn` and `lten` = null or less than (or equal).
For multi-valued strings:
* `has` = has at least the specified `value` in the multi-valued field
In any case, `value` must be percent encoded.
The parameter name is one of the following values:
- `criticality`
- `tags`
- `start_date`
- `end_date`
- `provider_author_apnf_code`
schema:
type: object
additionalProperties:
type: string
pattern: ^(((eq|ne|(not_)?match|[lg]te?n?|has):)?.+|(in|not_in):\[.+(,.+)*\])$
example:
status: ENABLED
authorization_date: gte:2022-01-01T00:00:00Z
- name: sort
in: query
description: |
Sort preference using the format `property_name:order`, where:
* `property_name` is one of the following values:
- `criticality`
- `start_date`
- `end_date`
- `provider_author_apnf_code`
* `order` may be set to `asc` or `desc`.
schema:
type: string
pattern: ^(criticality|(start|end)_date|provider_author_apnf_code):(([Aa]|[Dd][Ee])[Ss][Cc])$
example: start_date:asc
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return a paginated list of records
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
content:
application/json:
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/PaginationMetaData'
meteos:
type: array
items:
$ref: '#/components/schemas/Meteo'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
post:
summary: Create a new meteo event
description: |
Create a new event.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- Any user can create new events.
operationId: CreateMeteo
tags:
- MAN Weather Reports
parameters:
- $ref: '#/components/parameters/X-Request-Id'
requestBody:
description: Meteo event details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MeteoForCreation'
responses:
'201':
description: |
Confirms the creation of the new event and returns its details in the response
content:
application/json:
schema:
$ref: '#/components/schemas/Meteo'
examples:
ticket:
$ref: '#/components/examples/MeteoCreation'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/meteo/{meteo_id}:
get:
summary: Return details of a meteo event
description: |
Return a JSON object with meteo event details
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- Any user can read the events
operationId: GetMeteo
tags:
- MAN Weather Reports
parameters:
- name: meteo_id
in: path
description: reference id to the meteo (integer).
required: true
schema:
type: integer
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return the JSON object with ticket details.
content:
application/json:
schema:
$ref: '#/components/schemas/Meteo'
examples:
ticket:
$ref: '#/components/examples/Meteo'
ticket_disengagement:
$ref: '#/components/examples/MeteoDisengagement'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
patch:
summary: Update a meteo event
description: |
Update a meteo event, for example to add an end date
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
- *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR* can modify events created by their provider
operationId: UpdateMeteo
tags:
- MAN Weather Reports
parameters:
- name: meteo_id
in: path
description: reference id to the meteo (integer).
required: true
schema:
type: integer
- $ref: '#/components/parameters/X-Request-Id'
requestBody:
required: true
description: |
A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
that must be updated (with the new value) or deleted (with null as value).
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/MeteoPatch'
examples:
UpdateMeteo:
$ref: '#/components/examples/MeteoPatch'
responses:
'200':
description: Confirms successful processing and returns updated event in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/Meteo'
examples:
Meteo:
$ref: '#/components/examples/Meteo'
headers:
Content-Length:
$ref: '#/components/headers/Content-Length'
X-Correlation-Id:
$ref: '#/components/headers/X-Correlation-Id'
X-Response-Id:
$ref: '#/components/headers/X-Response-Id'
'400':
$ref: '#/components/responses/ErrorValidation'
'401':
$ref: '#/components/responses/ErrorNotAuthenticated'
'403':
$ref: '#/components/responses/ErrorNoPermission'
'406':
$ref: '#/components/responses/ErrorInvalidAcceptHeader'
'415':
$ref: '#/components/responses/ErrorInvalidContentType'
'429':
$ref: '#/components/responses/ErrorRateLimiting'
'500':
$ref: '#/components/responses/ErrorInternal'
'503':
$ref: '#/components/responses/ServiceUnavailable'
/providers/code_name:
get:
summary: Return a dictionnary of provider names by provider code.
description: |
Dictionary of provider names by provider code that are not deleted.
**Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
operationId: GetProvidersCodeName
tags:
- Providers
parameters:
- $ref: '#/components/parameters/X-Request-Id'
responses:
'200':
description: Return a dictionnary of provider names by provider code