Components


securitySchemes: 
  oAuth2ClientCredentials: 
    Type: oauth2 
    Flows: 
      clientCredentials: 
        tokenUrl: '{nrfApiRoot}/oauth2/token' 
        scopes: 
          nsmsf-sms: Access to the nsmsf-sms API 
 
schemas: 
  UeSmsContextData: 
    Type: object 
    Required: 
      - supi 
      - amfId 
      - accessType 
    Properties: 
      supi: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi' 
      pei: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei' 
      amfId: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 
      guamis: 
        Type: array 
        Items: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami' 
        minItems: 1 
      accessType: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType' 
      gpsi: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' 
      ueLocation: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' 
      ueTimeZone: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' 
      traceData: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData' 
      backupAmfInfo: 
        Type: array 
        Items: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' 
        minItems: 1 
      udmGroupId: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' 
      routingIndicator: 
        Type: string 
  SmsRecordData: 
    Type: object 
    Required: 
      - smsRecordId 
      - smsPayload 
    Properties: 
      smsRecordId: 
        Reference: '#/components/schemas/RecordId' 
      smsPayload: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' 
      accessType: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/AccessType' 
      gpsi: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' 
      pei: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei' 
      ueLocation: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' 
      ueTimeZone: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' 
  RecordId: 
    Type: string 
  SmsRecordDeliveryData: 
    Type: object 
    Required: 
      - smsRecordId 
      - deliveryStatus 
    Properties: 
      smsRecordId: 
        Reference: '#/components/schemas/RecordId' 
      deliveryStatus: 
        Reference: '#/components/schemas/SmsDeliveryStatus' 
  SmsDeliveryStatus: 
    Type: string 
    enum: 
      - SMS_DELIVERY_PENDING 
      - SMS_DELIVERY_COMPLETED 
      - SMS_DELIVERY_FAILED