forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
TS29504_Nudr_GroupIDmap.yaml
94 lines (78 loc) · 2.29 KB
/
TS29504_Nudr_GroupIDmap.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
openapi: 3.0.0
info:
version: 1.0.0
title: 'Nudr_GroupIDmap'
description: |
Unified Data Repository Service for NF-Group ID retrieval.
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.504 V16.4.0; 5G System; Unified Data Repository Services; Stage 3
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.504/'
servers:
- description: API root
url: '{apiRoot}/nudr-group-id-map/v1'
variables:
apiRoot:
default: https://example.com
security:
- {}
- oAuth2ClientCredentials:
- nudr-group-id-map
paths:
/nf-group-ids:
get:
summary: Retrieves NF-Group IDs for provided Subscriber and NF types
operationId: GetNfGroupIDs
tags:
- NF Group IDs (Document)
parameters:
- name: nf-type
in: query
description: Type of NF
required: true
style: form
explode: false
schema:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
minItems: 1
- name: subscriberId
in: query
description: Identifier of the subscriber
required: true
schema:
$ref: '#/components/schemas/SubscriberId'
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/NfGroupIdMapResult'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nudr-group-id-map: Access to the Nudr_GroupIDmap API
schemas:
# COMPLEX TYPES:
NfGroupIdMapResult:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
minProperties: 1
# SIMPLE TYPES:
SubscriberId:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$'
# ENUMS: