diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml index eb40832285954072e002507652e690464f299b14..543c2be3dae5453a6501e5fca11f970f0e78811a 100644 --- a/OpenAPI/5gcNrm.yaml +++ b/OpenAPI/5gcNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: 3GPP 5GC NRM - version: 16.6.0 + version: 16.9.0 description: >- OAS 3.0.1 specification of the 5GC NRM © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.541 V16.6.0; 5G NRM, 5GC NRM + description: 3GPP TS 28.541; 5G NRM, 5GC NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ paths: {} components: @@ -41,11 +41,11 @@ components: type: object properties: ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' ipv6Prefix: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' + $ref: 'comDefs.yaml#/components/schemas/Ipv6Prefix' transport: $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' port: @@ -71,9 +71,9 @@ components: sNssais: $ref: 'nrNrm.yaml#/components/schemas/Snssai' fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' nfServices: type: array items: @@ -91,9 +91,9 @@ components: schema: type: string fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' ipEndPoints: type: array items: @@ -183,7 +183,7 @@ components: authzInfo: type: string hostAddr: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + $ref: 'comDefs.yaml#/components/schemas/HostAddr' locality: type: string nFInfo: @@ -992,7 +992,7 @@ components: sEPPId: type: integer fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -1031,7 +1031,7 @@ components: supportedFuncList: $ref: '#/components/schemas/SupportedFuncList' address: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + $ref: 'comDefs.yaml#/components/schemas/HostAddr' - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' NefFunction-Single: allOf: @@ -1110,7 +1110,7 @@ components: sEPPId: type: integer fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' + $ref: 'comDefs.yaml#/components/schemas/Fqdn' EP_N2-Single: @@ -1441,7 +1441,7 @@ components: remotePlmnId: $ref: 'nrNrm.yaml#/components/schemas/PlmnId' remoteSeppAddress: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' + $ref: 'comDefs.yaml#/components/schemas/HostAddr' remoteSeppId: type: integer n32cParas: diff --git a/OpenAPI/FileDataReportingMnS.yaml b/OpenAPI/FileDataReportingMnS.yaml deleted file mode 100644 index 2d1a4fb16d930f5853b52691c4d31416ac8dd124..0000000000000000000000000000000000000000 --- a/OpenAPI/FileDataReportingMnS.yaml +++ /dev/null @@ -1,283 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 File data reporting Service - version: 16.6.0 - description: >- - OAS 3.0.1 specification of the File data reporting Management Service © 2020, - 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All - rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.5.0; Generic management services - url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' -servers: - - url: '{MnSRoot}/FileDataReportingMnS/{MnSversion}' - variables: - MnSRoot: - description: See subclause 4.4 of TS 32.158 - default: http://example.com/3GPPManagement - version: - description: Indicates the current version of the specification - default: 16.5.0 -paths: - /Files: - get: - summary: Read resources of information of available files - description: With HTTP GET, resources of information of available files are read. The resources to be read are identified with the path component (base resource) and the query component (fileaType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned. - parameters: - - name: fileType - in: query - description: This parameter identifies the type of management data that the file contains to select the resources from the collection resources identified with the path component of the URI. - required: true - schema: - $ref: '#/components/schemas/fileType-Type' - - name: beginTime - in: query - description: This parameter identifies the time stamp no later than which the file became available to select the resources from the collection resources identified with the path component of the URI. - required: true - schema: - $ref: '#/components/schemas/dateTime-Type' - - name: endTime - in: query - description: This parameter identifies the time stamp no earlier than which the file became available to select the resources from the collection resources identified with the path component of the URI. - required: true - schema: - $ref: '#/components/schemas/dateTime-Type' - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/fileInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - /subscriptions: - post: - summary: Create a subscription - description: To create a subscription the representation of the subscription is POSTed on the /subscriptions collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/subscription-RequestType' - responses: - '201': - description: Success case ("201 Created"). The representation of the newly created subscription resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/subscription-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - callbacks: - notifyFileReady: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyFileReady-NotifType' - responses: - '204': - description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyFilePreparationError: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyFilePreparationError-NotifType' - responses: - '204': - description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Delete all subscriptions made with a specific consumerReferenceId - description: The subscriptions are deleted by deleting the corresponding subscription resources. The resources to be deleted are identified with the path component of the URI pointing to the /subscription collection resource and filtering on the consumerReferenceId provided in the query part. - parameters: - - name: consumerReferenceId - in: query - description: Identifies the subscriptions to be deleted. - required: true - schema: - $ref: '#/components/schemas/consumerReferenceId-QueryType' - responses: - '204': - description: Success case ("204 No Content"). The subscription resources have been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/subscriptions/{subscriptionId}': - delete: - summary: Delete a single subscription - description: The subscription is deleted by deleting the corresponding subscription resource. The resource to be deleted is identified with the path component of the URI. - parameters: - - name: subscriptionId - in: path - description: Identifies the subscription to be deleted. - required: true - schema: - $ref: '#/components/schemas/subscriptionId-PathType' - responses: - '204': - description: Success case ("204 No Content"). The subscription resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - long-Type: - type: string - format: long - additionalText-Type: - type: string - reason-Type: - type: string - fileInfoRetrieval-ResponseType: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - fileInfo-Type: - type: object - properties: - fileLocation: - $ref: '#/components/schemas/uri-Type' - fileSize: - $ref: '#/components/schemas/long-Type' - fileReadyTime: - $ref: '#/components/schemas/dateTime-Type' - fileExpirationTime: - $ref: '#/components/schemas/dateTime-Type' - fileCompression: - type: string - fileFormat: - type: string - fileType: - $ref: '#/components/schemas/fileType-Type' - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - fileType-Type: - type: string - enum: - - PERFORMANCE - - TRACE - - ANALYTICS - - PROPRIETARY - header-Type: - description: Header used in notifications as notification header - type: object - properties: - uri: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - subscriptionId-PathType: - type: string - filter-Type: - type: string - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyFileReady - - notifyFilePreparationError - subscription-ResourceType: - type: object - properties: - consumerReference: - $ref: '#/components/schemas/uri-Type' - timeTick: - $ref: '#/components/schemas/long-Type' - filter: - $ref: '#/components/schemas/filter-Type' - subscription-RequestType: - type: object - properties: - data: - $ref: '#/components/schemas/subscription-ResourceType' - subscription-ResponseType: - type: object - properties: - data: - $ref: '#/components/schemas/subscription-ResourceType' - consumerReferenceId-QueryType: - $ref: '#/components/schemas/uri-Type' - notifyFileReady-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - fileInfoList: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - notifyFilePreparationError-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - fileInfoList: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - reason: - $ref: '#/components/schemas/reason-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/README.md b/OpenAPI/README.md index 5e2f09862890b1b53397c55a709c5faa7659cc72..9601c8caf8a208f94b8cfad96eb8617da86b19c4 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -54,8 +54,8 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml)) * File Data Reporting MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/FileDataReportMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/FileDataReportMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/fileDataReportingMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/fileDataReportingMnS.yaml)) ## Tools diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml index fb6d7f4db91f065ab002c027489e539c60f3ae65..f9d90b78f978114be161bab1ee876523db0e3ee5 100644 --- a/OpenAPI/comDefs.yaml +++ b/OpenAPI/comDefs.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Common Type Definitions - version: 16.6.0 + version: 16.8.0 description: >- OAS 3.0.1 specification of common type definitions in the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: 3GPP TS 28.623; Generic NRM; Common type definitions @@ -18,7 +18,17 @@ components: format: float DateTime: type: string - format: date-Time + format: date-time + Latitude: + type: number + format: float + minimum: -90 + maximum: 90 + Longitude: + type: number + format: float + minimum: -180 + maximum: 180 Dn: type: string @@ -33,6 +43,9 @@ components: Mnc: type: string pattern: '^[0-9]{2,3}$' + Nid: + type: string + pattern: '^[A-Fa-f0-9]{11}$' PlmnId: type: object properties: @@ -40,15 +53,18 @@ components: $ref: '#/components/schemas/Mcc' mnc: $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - - Fqdn: + Tac: type: string - Uri: + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + EutraCellId: type: string + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + Fqdn: + type: string Ipv4Addr: type: string pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' @@ -65,6 +81,23 @@ components: - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' example: '2001:db8:abcd:12::0/64' + IpAddr: + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + HostAddr: + # This definition will be deprecated, when all occurances of HostAddr + # are replaced by Host. + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + - $ref: '#/components/schemas/Fqdn' + Host: + oneOf: + - $ref: '#/components/schemas/IpAddr' + - $ref: '#/components/schemas/Fqdn' + Uri: + type: string AdministrativeState: type: string @@ -101,6 +134,8 @@ components: maxItems: 2 Filter: + description: >- + The filter format shall be compliant to XPath 1.0. type: string SystemDN: type: string @@ -113,12 +148,7 @@ components: - $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - $ref: 'perfMnS.yaml#/components/schemas/PerfNotificationTypes' - $ref: 'heartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes' - # The enum below will be replaced by a reference once notification - # types are defined in "FileDataReportingMnS.yaml" - - type: string - enum: - - notifyFileReady - - notifyFilePreparationError + - $ref: 'fileDataReportingMnS.yaml#/components/schemas/FileNotificationTypes' NotificationHeader: type: object properties: diff --git a/OpenAPI/fileDataReportingMnS.yaml b/OpenAPI/fileDataReportingMnS.yaml new file mode 100644 index 0000000000000000000000000000000000000000..66bf53764acef60c0a5aa796d3a4e60b70dd4b4b --- /dev/null +++ b/OpenAPI/fileDataReportingMnS.yaml @@ -0,0 +1,229 @@ +openapi: 3.0.1 +info: + title: File Data Reporting MnS + version: 16.8.0 + description: >- + OAS 3.0.1 definition of the File Data Reporting MnS + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{MnSRoot}/fileDataReportingMnS/{MnSVersion}' + variables: + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /files: + get: + summary: Read information about available files + description: >- + Information about available files is read with HTTP GET. The files for + which information shall be returned are identified with the path + component (base resource) and the query component (fileDataType, beginTime, + endTime) of the URI. + parameters: + - name: fileDataType + in: query + description: >- + This parameter selects files based on the file data type. + required: true + schema: + $ref: '#/components/schemas/FileDataType' + - name: beginTime + in: query + description: >- + This parameter selects files based on the earliest time they + became available + required: false + schema: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + - name: endTime + in: query + description: >- + This parameter selects files based on the latest time they + became available + required: false + schema: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + responses: + '200': + description: >- + 'Success case ("200 OK"). + The resources identified in the request for retrieval are returned + in the response message body.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FileInfo' + default: + description: Error case. + content: + application/json: + schema: + $ref: 'comDefs.yaml#/components/schemas/ErrorResponse' + /subscriptions: + post: + summary: Create a subscription + description: >- + To create a subscription the representation of the subscription is + POSTed on the /subscriptions collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: 'faultMnS.yaml#/components/schemas/Subscription' + responses: + '201': + description: >- + Success case ("201 Created"). + The representation of the newly created subscription resource shall + be returned. + content: + application/json: + schema: + $ref: 'faultMnS.yaml#/components/schemas/Subscription' + headers: + Location: + description: URI of the newly created subscription resource + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: 'comDefs.yaml#/components/schemas/ErrorResponse' + callbacks: + notifyFileReady: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyFileReady' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'comDefs.yaml#/components/schemas/ErrorResponse' + notifyFilePreparationError: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyFilePreparationError' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'comDefs.yaml#/components/schemas/ErrorResponse' + /subscriptions/{subscriptionId}: + delete: + summary: Delete a subscription + description: >- + The subscription is deleted by deleting the corresponding subscription + resource. The resource to be deleted is identified with the path + component of the URI. + parameters: + - name: subscriptionId + in: path + description: Identifies the subscription to be deleted. + required: true + schema: + type: string + responses: + '204': + description: >- + Success case ("204 No Content"). + The subscription resource has been deleted. The response message body + is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'comDefs.yaml#/components/schemas/ErrorResponse' +components: + schemas: + FileDataType: + type: string + enum: + - Performance + - Trace + - Anatytics + - Proprietary + FileNotificationTypes: + type: string + enum: + - notifyFileReady + - notifyFilePreparationError + FileInfo: + type: object + properties: + fileLocation: + $ref: 'comDefs.yaml#/components/schemas/Uri' + fileSize: + type: integer + fileReadyTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + fileExpirationTime: + $ref: 'comDefs.yaml#/components/schemas/DateTime' + fileCompression: + type: string + fileFormat: + type: string + fileDataType: + $ref: '#/components/schemas/FileDataType' + NotifyFileReady: + allOf: + - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + fileInfoList: + type: array + items: + $ref: '#/components/schemas/FileInfo' + additionalText: + type: string + NotifyFilePreparationError: + allOf: + - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + fileInfoList: + type: array + items: + $ref: '#/components/schemas/FileInfo' + reason: + type: string + additionalText: + type: string \ No newline at end of file diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml index aedf3c4fb858678d3cc381bf779f3f2b868f96a0..c45aad4b2766ba84100f464fd371bdbbfa7cfae6 100644 --- a/OpenAPI/genericNrm.yaml +++ b/OpenAPI/genericNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: Generic NRM - version: 16.6.0 + version: 16.8.0 description: >- OAS 3.0.1 definition of the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.623 V16.5.0; Generic NRM + description: 3GPP TS 28.623; Generic NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ paths: {} components: @@ -31,16 +31,6 @@ components: type: string autoScalable: type: boolean - SiteLatitude: - type: number - format: float - minimum: -90 - maximum: 90 - SiteLongitude: - type: number - format: float - minimum: -180 - maximum: 180 PeeParameter: type: object properties: @@ -49,9 +39,9 @@ components: siteDescription: type: string siteLatitude: - $ref: '#/components/schemas/SiteLatitude' + $ref: 'comDefs.yaml#/components/schemas/Latitude' siteLongitude: - $ref: '#/components/schemas/SiteLongitude' + $ref: 'comDefs.yaml#/components/schemas/Longitude' equipmentType: type: string environmentType: @@ -110,8 +100,6 @@ components: - AF - UDSF - DN - Fqdn: - type: string OperationSemantics: type: string enum: @@ -121,7 +109,7 @@ components: type: object properties: host: - $ref: '#/components/schemas/HostAddr' + $ref: 'comDefs.yaml#/components/schemas/HostAddr' port: type: integer NFServiceType: @@ -134,27 +122,6 @@ components: - Nsmf_PDUSession - Nsmf_EventExposure - Others - HostAddr: - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Fqdn' - Ipv4Addr: - type: string - pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$' - example: '198.51.100.1' - Ipv6Addr: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - Ipv6Prefix: - type: string - allOf: - - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' - example: '2001:db8:abcd:12::0/64' TransportProtocol: anyOf: - type: string @@ -214,6 +181,71 @@ components: - BASE_SUBTREE scopeLevel: type: integer + AreaScope: + oneOf: + - type: array + items: + $ref: '#/components/schemas/EutraCellId' + - type: array + items: + $ref: '#/components/schemas/NrCellId' + - type: array + items: + $ref: '#/components/schemas/Tac' + - type: array + items: + $ref: '#/components/schemas/Tai' + Tai: + type: object + properties: + mcc: + $ref: 'comDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'comDefs.yaml#/components/schemas/Mnc' + tac: + $ref: '#/components/schemas/Tac' + AreaConfig: + type: object + properties: + freqInfo: + $ref: '#/components/schemas/FreqInfo' + pciList: + type: array + items: + type: integer + FreqInfo: + description: specifies the carrier frequency and bands used in a cell. + type: object + properties: + arfcn: + type: integer + freqBands: + type: array + items: + type: integer + MbsfnArea: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 1 + earfcn: + type: integer + minimum: 1 + Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + EutraCellId: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + IpAddr: + oneOf: + - $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' + #-------- Definition of types used in Trace control NRM fragment------------------ @@ -577,6 +609,12 @@ components: - GNB_CU_CP - GNB_CU_UP - GNB_DU + - AMF + - PCF + - SMF + - UPF + - AUSF + - SMSF tjPLMNTaget-Type: type: object @@ -590,17 +628,6 @@ components: - mcc - mnc - tjStreamingTraceConsumerURI-Type: - type: string - description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details. - format: uri - - tjTraceCollectionEntityAddress-Type: - description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - tjTraceDepth-Type: description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. type: string @@ -621,7 +648,7 @@ components: mnc: $ref: 'comDefs.yaml#/components/schemas/Mnc' traceId: - type: integer + type: string required: - mcc - mnc @@ -677,6 +704,12 @@ components: - SMF - PCF - UPF + - AUSF + - NEF + - NRF + - NSSF + - SMSF + - UDM EventBitmap: type: integer required: @@ -690,25 +723,39 @@ components: - NO_IDENTITY - TAC_OF_IMEI - tjMDTAreaConfigurationForNeighCell-Type: - description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26. - type: array - items: - type: object - properties: - frequency: - type: string - cell: - type: string - - tjMDTAreaScope-Type: - description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2. - allOf: - - $ref: 'comDefs.yaml#/components/schemas/DnList' - tjMDTCollectionPeriodRrmLte-Type: description: See details in 3GPP TS 32.422 clause 5.10.20. type: string + enum: + - 100ms + - 1000ms + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10000ms + - 10240ms + - 60000ms + + tjMDTCollectionPeriodM6Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.32. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + + tjMDTCollectionPeriodM7Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.33. + type: integer + minimum: 1 + maximum: 60 + + tjMDTCollectionPeriodRrmUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.21. + type: string enum: - 250ms - 500ms @@ -725,29 +772,41 @@ components: - 28000ms - 32000ms - 64000ms - - tjMDTCollectionPeriodRrmUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.21. + + tjMDTCollectionPeriodRrmNR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.30. type: string enum: - 1024ms - - 1280ms - 2048ms - - 2560ms - 5120ms - 10240ms - - 1min - - tjMDTCollectionPeriodRrmNR-Type: - description: See details in 3GPP TS 32.422 clause 5.10.30. + - 60000ms + + tjMDTCollectionPeriodM6NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.34. type: string enum: + - 120ms + - 240ms + - 480ms + - 640ms - 1024ms - - 1280ms - 2048ms - 5120ms - 10240ms - - 60000ms + - 20480ms + - 40960ms + - 1min + - 6min + - 12min + - 30min + + tjMDTCollectionPeriodM7NR-Type: + description: See details in 3GPP TS 32.422 clause 5.10.35. + type: integer + minimum: 1 + maximum: 60 tjMDTEventListForTriggeredMeasurement-Type: description: See details in 3GPP TS 32.422 clause 5.10.28. @@ -761,13 +820,21 @@ components: type: object properties: EventThresholdRSRP: - type: integer - minimum: 0 - maximum: 97 + oneOf: + - type: integer + minimum: 0 + maximum: 97 + - type: integer + minimum: 0 + maximum: 127 EventThresholdRSRQ: - type: integer - minimum: 0 - maximum: 34 + oneOf: + - type: integer + minimum: 0 + maximum: 34 + - type: integer + minimum: 0 + maximum: 127 EventThreshold1F: type: object properties: @@ -833,6 +900,7 @@ components: - M5 - M6 - M7 + - M1_EVENT_TRIGGERED - M8 - M9 @@ -849,32 +917,50 @@ components: tjMDTLoggingInterval-Type: description: See details in 3GPP TS 32.422 clause 5.10.8. - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - - tjMDTMBSFNAreaList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.25. - type: array - items: - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 1 - earfcn: - type: integer - minimum: 1 - required: - - mbsfnAreaId - - earfcn + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + LTE: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + NR: + type: array + items: + type: string + enum: + - 0.32s + - 0.64s + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + - INFINITY tjMDTMeasurementPeriodLTE-Type: description: See details in 3GPP TS 32.422 clause 5.10.23. @@ -958,45 +1044,73 @@ components: type: string enum: - PERIODICAL - - A2_FOR_LTE + - A2_FOR_LTE_NR - 1F_FOR_UMTS - 1I_FOR_UMTS_MCPS_TDD - - A2_TRIGGERED_PERIODIC_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_LTE + - A2_TRIGGERED_PERIODIC_FOR_LTE_NR + - ALL_CONFIGURED_RRM_FOR_LTE_NR - ALL_CONFIGURED_RRM_FOR_UMTS tjMDTReportInterval-Type: description: See details in 3GPP TS 32.422 clause 5.10.5. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - 3600000ms + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + LTE: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms + NR: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms tjMDTReportType-Type: description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. @@ -1033,8 +1147,8 @@ components: - mnc tceAddress: oneOf: - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' + - $ref: '#/components/schemas/IpAddr' + - $ref: 'comDefs.yaml#/components/schemas/Uri' required: - tceID - tcePLMN @@ -1117,6 +1231,8 @@ components: properties: ManagementNode: $ref: '#/components/schemas/ManagementNode-Multiple' + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' MeContext: $ref: '#/components/schemas/MeContext-Multiple' PerfMetricJob: @@ -1132,6 +1248,8 @@ components: ManagedElement-ncO: type: object properties: + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' PerfMetricJob: $ref: '#/components/schemas/PerfMetricJob-Multiple' ThresholdMonitor: @@ -1188,14 +1306,16 @@ components: $ref: '#/components/schemas/tjListOfNeTypes-Type' tjPLMNTarget: $ref: '#/components/schemas/tjPLMNTaget-Type' - tjTraceConsumer: - oneOf: - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' + tjStreamingTraceConsumerURI: + $ref: 'comDefs.yaml#/components/schemas/Uri' + tjTraceCollectionEntityAddress: + $ref: '#/components/schemas/IpAddr' tjTraceDepth: $ref: '#/components/schemas/tjTraceDepth-Type' tjTraceReference: $ref: '#/components/schemas/tjTraceReference-Type' + tjTraceRecordSessionReference: + type: string tjTraceReportingFormat: $ref: '#/components/schemas/tjTraceReportingFormat-Type' tjTraceTarget: @@ -1205,15 +1325,25 @@ components: tjMDTAnonymizationOfData: $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' tjMDTAreaConfigurationForNeighCell: - $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' + $ref: '#/components/schemas/AreaConfig' tjMDTAreaScope: - $ref: '#/components/schemas/tjMDTAreaScope-Type' + type: array + items: + $ref: '#/components/schemas/AreaScope' tjMDTCollectionPeriodRrmLte: $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' + tjMDTCollectionPeriodM6Lte: + $ref: '#/components/schemas/tjMDTCollectionPeriodM6Lte-Type' + tjMDTCollectionPeriodM7Lte: + $ref: '#/components/schemas/tjMDTCollectionPeriodM7Lte-Type' tjMDTCollectionPeriodRrmUmts: $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' tjMDTCollectionPeriodRrmNR: $ref: '#/components/schemas/tjMDTCollectionPeriodRrmNR-Type' + tjMDTCollectionPeriodM6NR: + $ref: '#/components/schemas/tjMDTCollectionPeriodM6NR-Type' + tjMDTCollectionPeriodM7NR: + $ref: '#/components/schemas/tjMDTCollectionPeriodM7NR-Type' tjMDTEventListForTriggeredMeasurement: $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' tjMDTEventThreshold: @@ -1225,7 +1355,9 @@ components: tjMDTLoggingInterval: $ref: '#/components/schemas/tjMDTLoggingInterval-Type' tjMDTMBSFNAreaList: - $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' + type: array + items: + $ref: '#/components/schemas/MbsfnArea' tjMDTMeasurementPeriodLTE: $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' tjMDTMeasurementPeriodUMTS: @@ -1248,12 +1380,6 @@ components: $ref: '#/components/schemas/tjMDTSensorInformation-Type' tjMDTTraceCollectionEntityID: $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' - required: - - tjJobType - - tjTraceReference - - tjTraceConsumer - - tjTraceReportingFormat - - tjTraceTarget ManagedFunction-ncO: type: object @@ -1331,6 +1457,18 @@ components: type: string swVersion: type: string + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + MnsAgent-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + systemDN: + $ref: 'comDefs.yaml#/components/schemas/Dn' MeContext-Single: allOf: - $ref: '#/components/schemas/Top' @@ -1473,6 +1611,10 @@ components: type: array items: $ref: '#/components/schemas/ManagementNode-Single' + MnsAgent-Multiple: + type: array + items: + $ref: '#/components/schemas/MnsAgent-Single' MeContext-Multiple: type: array items: @@ -1502,6 +1644,7 @@ components: - $ref: '#/components/schemas/VsDataContainer-Single' - $ref: '#/components/schemas/ManagementNode-Single' + - $ref: '#/components/schemas/MnsAgent-Single' - $ref: '#/components/schemas/MeContext-Single' - $ref: '#/components/schemas/ManagedNFService-Single' diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/nrNrm.yaml index 3de2c63a6c7db79edfac3aac6f73fa191d953fb4..ada95116b7ab41b7c81223fd1fa43e7190cfbe3b 100644 --- a/OpenAPI/nrNrm.yaml +++ b/OpenAPI/nrNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: NR NRM - version: 16.6.0 + version: 16.9.0 description: >- OAS 3.0.1 specification of the NR NRM © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.541 V16.6.0; 5G NRM, NR NRM + description: 3GPP TS 28.541; 5G NRM, NR NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ paths: {} components: @@ -272,9 +272,9 @@ components: type: object properties: ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' vlanId: type: integer minimum: 0 @@ -292,9 +292,9 @@ components: type: object properties: ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' CellIndividualOffset: type: object @@ -556,8 +556,8 @@ components: properties: TceIPAddress: oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + - $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' TceID: type: integer PlmnTarget: @@ -1337,6 +1337,20 @@ components: properties: cesSwitch: type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" energySavingControl: type: string enum: diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml index 1fa8d70ff3068eef6e42bd9c66f83f941791fded..81a86cc0f66cd22b44fa80d8f19176c84a4072b2 100644 --- a/OpenAPI/sliceNrm.yaml +++ b/OpenAPI/sliceNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: Slice NRM - version: 16.8.0 + version: 16.9.0 description: >- OAS 3.0.1 specification of the Slice NRM @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.541 V16.4.0; 5G NRM, Slice NRM + description: 3GPP TS 28.541; 5G NRM, Slice NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ paths: {} components: @@ -290,8 +290,8 @@ components: IpAddress: oneOf: - - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + - $ref: 'comDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'comDefs.yaml#/components/schemas/Ipv6Addr' ServiceProfileList: type: array items: @@ -331,7 +331,6 @@ components: properties: attributes: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - type: object properties: networkSliceSubnetRef: @@ -350,7 +349,6 @@ components: properties: attributes: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - type: object properties: managedFunctionRefList: