DOCSEARCHbyAlgolia
Submit Docs

3GPP 5G Network Function (NF) APIs

repository·Rel-18·Indexed 20 days ago

https://github.com/jdegre/5gc_apis

OpenAPI descriptions for 3GPP 5G Network Function (NF) APIs, specifically targeting Release 18, with frozen versions available for Rel-15, Rel-16, and Rel-17. This repository provides machine-readable references for 5G core network components, including APIs for NRF, LMF, AMF, SMF, UDM, UDR, PCF, and other network functions. It includes web-based tools for API parsing, validation, linting, and data type searching, with integration for Swagger Editor (v3.6.23).

Tokens
5.7K
Snippets
0
Records
45
Agent score
21%

What's inside 5gc_apis

  2. Access 5G Media Streaming (5GMS) APIs

    Rel-18

    The 5GMS APIs (based on TS 26.512) are exposed by the 5GMS Application Function (AF) at reference points M1 and M5.

    Provisioning (M1)

    Used for setting up streaming environments, including:

    • Provisioning Sessions
    • Server Certificates Provisioning
    • Content Preparation Templates Provisioning
    • Content Protocols Discovery
    • Content Hosting Provisioning
    • Consumption/Metrics Reporting Provisioning
    • Policy Templates Provisioning
    • Edge Resources Provisioning
    • Event Data Processing Provisioning

    Media Session Handling (M5)

    Used for active session management, including:

    • Service Access Information
    • Consumption Reporting
    • Metrics Reporting
    • Dynamic Policies
    • Network Assistance

    Data Reporting & Event Exposure

    • Data Reporting: APIs for 5GMS Client (R2) and 5GMS AS (R4).
    • Event Exposure: Data Collection AF (R5, R6).

  3. Use 5G API Analysis and Visualization Tools

    Rel-18

    The repository provides several web-based tools to interact with and analyze the OpenAPI YAML files:

    • API Parser/Validator and Linter: Validate and lint OpenAPI definitions.
    • Data Type Finder: Search and identify specific data types across the API definitions.
    • API Versions Overview: View an overview of different API versions.

    Additionally, most API links in the documentation use a loader that automatically opens the Swagger Editor (v3.6.23) with the corresponding Network Function (NF) YAML file pre-loaded for inspection and testing.

  4. Access UAS Application Enabler (UAE) Server APIs

    Rel-18

    The UAE Server provides management capabilities for Unmanned Aircraft Systems (UAS). Key APIs include:

    • C2 Operation Mode Management: Managing Command and Control (C2) operation modes.
    • Real-time UAV Status: Accessing real-time status of Unmanned Aerial Vehicles (UAVs).
    • USS Change Management: Managing Unmanned Aircraft System Service Provider (USS) changes.
    • DAA Support: Providing Detect and Avoid (DAA) support.

  5. Access Enabling Edge Applications (EDGEAPP) APIs

    Rel-18

    EDGEAPP APIs facilitate the management and discovery of edge computing resources and applications. Key capabilities include:

    • Registration & Discovery: EAS Registration, EES Registration, EEC Registration, and EAS Discovery.
    • UE Information: Accessing UE Location, UE Identifier, and Application Client Information.
    • Session & Context Management: Managing Sessions with QoS, EEC Context Relocation, and EES App Context Relocation.
    • ACR (Application Continuity Resource) Management: Managing ACR Status Updates, ACR Management Events, and EEL Managed ACR.
    • Service Provisioning: ECS Service Provisioning and Target EES Discovery.
    • Announcement: EES Common EAS Announcement.

  6. Access Service Enabler Architecture Layer (SEAL) APIs

    Rel-18

    The SEAL layer provides services for network resource adaptation, monitoring, and management. Key APIs include:

    • Network Resource Management: Includes Network Resource Adaptation, Monitoring, and Network Slice Adaptation.
    • User and Key Management: Includes User Profile Retrieval and Key Information Retrieval.
    • Location Services: Includes Location Reporting and Location Area Information Retrieval.
    • Group and Event Management: Includes Group Management and Event exposure.
    • VAL Services: Includes VAL Service Data Retrieval, VAL Service Area Configuration, and VAL Service Parameter Provisioning.
    • SEALDD (Data Transmission/Storage): Includes Data Transmission, Data Storage, Context Relocation, Transmission Quality Measurement, and Policy Configuration.
    • Policy Management: NSCE Server Policy Management.

  7. Access V2X Application Enabler (VAE) APIs

    Rel-18

    The V2X Application Enabler (VAE) provides several APIs for vehicle-to-everything (V2X) services. Key capabilities include:

    • V2X Message Delivery: Handling the delivery of V2X messages.
    • File Distribution: Managing the distribution of files within the V2X context.
    • Application Requirements: Defining requirements for V2X applications.
    • Dynamic Group Management: Managing dynamic groups for V2X communication.
    • Service Continuity: Ensuring service continuity for V2X applications.
    • HD Map Dynamic Information: Providing dynamic information for High-Definition (HD) maps.
    • Session Oriented Service: Managing session-oriented V2X services.
    • V2V/V2P Requirements: Managing configuration requirements for Vehicle-to-Vehicle (V2V) and Vehicle-to-Pedestrian (V2P) communications.
    • PC5 Provisioning: Managing PC5 interface provisioning requirements.
    • Service and QoS Control: Managing service and Quality of Service (QoS) control information.
    • VRU Zone Management: Managing Vulnerable Road User (VRU) zones.

  8. Access Management Services (MnS) OpenAPI Definitions

    Rel-18

    The repository provides OpenAPI definitions for various Management Services (MnS) based on 3GPP SA5 models:

    • Provisioning MnS (TS 28.532)
    • Fault Supervision MnS (TS 28.532)
    • Performance Measurement Job Control MnS (TS 28.550)
    • File Data Reporting MnS (TS 28.532)
    • Performance Threshold Monitoring MnS (TS 28.532)
    • Heartbeat Notifications (TS 28.532)
    • Streaming Data Reporting MnS (TS 28.532)

  9. Access 3GPP SA5 Network Resource Models (NRM)

    Rel-18

    The repository contains OpenAPI definitions for various 3GPP SA5 Network Resource Models (NRM), including:

    • Generic NRM (TS 28.623): Includes Common NRM definitions and Trace Control.
    • 5G/NR Specific NRM (TS 28.541): Covers NR NRM, 5GC NRM, and Slice NRM.
    • Specialized NRMs:
      • Communication Service Assurance (TS 28.536)
      • MDA NRM (TS 28.104) and MDA Report NRM
      • AI/ML NRM (TS 28.105)
      • Intent NRM (TS 28.312) and Intent Expectations
      • Edge NRM (TS 28.538)
      • Self-configuration of RAN entities (TS 28.317)

  11. Access PKMF (ProSe Key Management Service) APIs

    Rel-18

    PKMF APIs manage security keys for Proximity Services (ProSe). Available services include:

    • KeyRequest Service: Request security keys.
    • Resolve Remote User Id: Resolve identities for remote users.
    • Discovery: Discover ProSe-capable users.

  12. Access TSCTSF (Time Sensitive Communication and Time Synchronization Function) APIs

    Rel-18

    TSCTSF APIs provide services for time-sensitive communications. Available services include:

    • Time Synchronization: Synchronize time across network elements.
    • QoS and TSC Assistance: Provide Quality of Service and Time Sensitive Communication assistance.
    • ASTI: Access to Time Sensitive Information.