Nnrf_NFDiscovery

The Network Repository Function authorizes an NF client to perform the discovery operation using the Nnrf_NFDiscovery service to detect an NF.

OpenAPI

OpenAPI Version: 3.0.0

Info


Version: '1.0.0' 

Title: 'NRF NFDiscovery Service' 
Description: 'NRF NFDiscovery  Service'

Servers


  URL: '{apiRoot}/nnrf-disc/v1' 
  Variables: 
    API Root: 
      Default: https://example.com 
      Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501

Security


- {} 
- oAuth2ClientCredentials: 
    - nnrf-disc

Components


securitySchemes: 
  oAuth2ClientCredentials: 
    Type: oauth2 
    Flows: 
      clientCredentials: 
        tokenUrl: '/oauth2/token' 
        scopes: 
          nnrf-disc: Access to the Nnrf_NFDiscovery API 




























 
schemas: 
  SearchResult: 

    Type: object 
    Required: 
      - nfInstances 
    Properties: 
      validityPeriod: 
        Type: integer 
      nfInstances: 
        Type: array 
        Items: 
          Reference: '#/components/schemas/NFProfile' 



















  NFProfile: 
    Type: object 
    Required: 
      - nfInstanceId 
      - nfType 
      - nfStatus 
    Properties: 
      nfInstanceId: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' 


      nfType: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' 
      nfStatus: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFStatus' 
      plmnList: 
        Type: array 
        Items: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' 
        minItems: 1 
      sNssais: 
        Type: array 
        Items: 


        minItems: 1 
      nsiList: 
        Type: array 
        Items: 
          Type: string 
        minItems: 1 
      fqdn: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn' 
      ipv4Addresses: 
        Type: array 
        Items: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' 
        minItems: 1 
      ipv6Addresses: 
        Type: array 
        Items: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' 
        minItems: 1 
      capacity: 
        Type: integer 
        Minimum: 0 
        Maximum: 65535 
      load: 
        Type: integer 
        Minimum: 0 
        Maximum: 100 
      locality: 
        Type: string 
      priority: 
        Type: integer 
        Minimum: 0 
        Maximum: 65535 
      udrInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' 





      udmInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' 





      ausfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' 





      amfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' 





      smfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' 





      upfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' 





      pcfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' 





      bsfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/bsfInfo' 





      chfInfo: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' 


























      customInfo: 
        Type: object 
      recoveryTime: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime' 
      nfServicePersistence: 
        Type: boolean 
        Default: false 
      nfServices: 

        Type: array 
        Items: 
          Reference: '#/components/schemas/NFService' 
        minItems: 1 











        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/lmfInfo' 

        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/gmlcInfo' 






































  NFService: 

    Type: object 
    Required: 
      - serviceInstanceId 
      - serviceName 
      - versions 
      - scheme 
      - nfServiceStatus 
    Properties: 
      serviceInstanceId: 
        Type: string 
      serviceName: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' 
      versions: 
        Type: array 
        Items: 
          Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceVersion' 
        minItems: 1 
      scheme: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' 
      nfServiceStatus: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceStatus' 
      fqdn: 
        Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Fqdn' 
      ipEndPoints: 
        Type: array 
        Items: 
          Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' 
        minItems: 1 
      apiPrefix: 
        Type: string 
      defaultNotificationSubscriptions: 
        Type: array 
        Items: 
          Reference: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' 
        minItems: 1 
      capacity: 
        Type: integer 
        Minimum: 0 
        Maximum: 65535 
      load: 
        Type: integer 
        Minimum: 0 
        Maximum: 100 


      priority: 
        Type: integer 
        Minimum: 0 
        Maximum: 65535 
      recoveryTime: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime' 


      supportedFeatures: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

External Docs


Description: 3GPP TS 29.510 V15.2.0; 5G System; Network Function Repository Services; Stage 3 
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'