kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/comDefs.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: Common Type Definitions
   4   version: 16.6.0
   5   description: >-
   6     OAS 3.0.1 specification of common type definitions in the Generic NRM
   7     © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
   8     All rights reserved.
   9 externalDocs:
  10   description: 3GPP TS 28.623; Generic NRM; Common type definitions
  11   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
  12 paths: {}
  13 components:
  14   schemas:
  15
  16     Float:
  17       type: number
  18       format: float
  19     DateTime:
  20       type: string
  21       format: date-Time
  22
  23     Dn:
  24       type: string
  25     DnList:
  26       type: array
  27       items:
  28         $ref: '#/components/schemas/Dn'
  29
  30     Mcc:
  31       type: string
  32       pattern: '^[0-9]{3}$'
  33     Mnc:
  34       type: string
  35       pattern: '^[0-9]{2,3}$'
  36     PlmnId:
  37       type: object
  38       properties:
  39         mcc:
  40           $ref: '#/components/schemas/Mcc'
  41         mnc:
  42           $ref: '#/components/schemas/Mnc'
  43       required:
  44         - mcc
  45         - mnc
  46
  47     Fqdn:
  48       type: string
  49     Uri:
  50       type: string
  51
  52     Ipv4Addr:
  53       type: string
  54       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])$'
  55       example: '198.51.100.1'
  56     Ipv6Addr:
  57       type: string
  58       allOf:
  59         - 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})))$'
  60         - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
  61       example: '2001:db8:85a3::8a2e:370:7334'
  62     Ipv6Prefix:
  63       type: string
  64       allOf:
  65         - 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])))$'
  66         - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
  67       example: '2001:db8:abcd:12::0/64'
  68
  69     AdministrativeState:
  70       type: string
  71       enum:
  72         - LOCKED
  73         - UNLOCKED
  74     OperationalState:
  75       type: string
  76       enum:
  77         - ENABLED
  78         - DISABLED
  79     UsageState:
  80       type: string
  81       enum:
  82         - IDEL
  83         - ACTIVE
  84         - BUSY
  85
  86     AttributeNameValuePairSet:
  87       description: >-
  88         The key of this map is the attribute name, and the value the attribute value.
  89       type: object
  90       minProperties: 1
  91       additionalProperties:
  92         nullable: true
  93     AttributeValueChangeSet:
  94       description: >-
  95         The first array item contains the attribute name value pairs with the new values,
  96         and the second array item the attribute name value pairs with the optional old values.
  97       type: array
  98       items:
  99         $ref: '#/components/schemas/AttributeNameValuePairSet'
 100         minItems: 1
 101         maxItems: 2
 102
 103     Filter:
 104       type: string
 105     SystemDN:
 106       type: string
 107
 108     NotificationId:
 109       type: integer
 110     NotificationType:
 111       oneOf:
 112         - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes'
 113         - $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes'
 114         - $ref: 'perfMnS.yaml#/components/schemas/PerfNotificationTypes'
 115         - $ref: 'heartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes'
 116         # The enum below will be replaced by a reference once notification
 117         # types are defined in "FileDataReportingMnS.yaml"
 118         - type: string
 119           enum:
 120             - notifyFileReady
 121             - notifyFilePreparationError
 122     NotificationHeader:
 123       type: object
 124       properties:
 125         href:
 126           $ref: '#/components/schemas/Uri'
 127         notificationId:
 128           $ref: '#/components/schemas/NotificationId'
 129         notificationType:
 130           $ref: '#/components/schemas/NotificationType'
 131         eventTime:
 132           $ref: '#/components/schemas/DateTime'
 133         systemDN:
 134           $ref: '#/components/schemas/SystemDN'
 135       required:
 136         - href
 137         - notificationId
 138         - notificationType
 139         - eventTime
 140         - systemDN
 141
 142     ErrorResponse:
 143       description: >-
 144         Default schema for the response message body in case the request
 145         is not successful.
 146       type: object
 147       properties:
 148         error:
 149           type: object
 150           properties:
 151             errorInfo:
 152               type: string