CT#108

openapi: 3.0.0

info:

  title: 3gpp-retrieve-uav-flight

  version: 1.0.0-alpha.2

  description: |

    API for UE Address service.

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  

    All rights reserved.

externalDocs:

  description: 3GPP TS 29.522 V19.2.0; 5G System; Network Exposure Function Northbound APIs.

  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'

security:

  - {}

  - oAuth2ClientCredentials: []

servers:

  - url: '{apiRoot}/3gpp-retrieve-uav-flight/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths:

  /{afId}/retrieve:

    parameters:

      - name: afId

        in: path

        description: Represents the identifier of the AF.

        required: true

        schema:

          type: string

    post:

      summary: Request to retrieve UAV flight information.

      operationId: RetrieveUAVFlightInfo

      tags:

        - Retrieve

      requestBody:

        required: true

        content:

          application/json:

            schema:

              $ref: '#/components/schemas/RetrieveUAVFlightReq'

      responses:

        '200':

          description: >

            OK. The UAV Flight information retrieval request is successfully processed, and the

            the requested UAV Flight information is returned in the response body.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/RetrievedUAVFlightInfo'

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

          $ref: 'TS29122_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29122_CommonData.yaml#/components/responses/401'

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

          $ref: 'TS29122_CommonData.yaml#/components/responses/404'

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

          $ref: 'TS29122_CommonData.yaml#/components/responses/413'

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

components:

  securitySchemes:

    oAuth2ClientCredentials:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes: {}

  schemas: 

    RetrieveUAVFlightReq:

      description: Represents the parameters to request UAV Flight information.

      type: object

      properties:

        gpsi:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'

        retrievePurpose:

          $ref: '#/components/schemas/RetrievePurpose'

        targetUssList:

          type: array

          items:

            type: string

          minItems: 1

        canFltPathInfos:

          type: array

          items:

            $ref: '#/components/schemas/CandidateFlightPathInfo'

          minItems: 1

        suppFeat:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

      required:

        - gpsi

        - retrievePurpose

    CandidateFlightPathInfo:

      description: Represents the candidate flight path information.

      type: object

      properties:

        canFlightPath:

          $ref: 'TS29522_UAVFlightAssistance.yaml#/components/schemas/FlightPath'

    RetrievedUAVFlightInfo:

      description: Represents the UAV Flight information.

      type: object

      properties:

        retrievedResults:

          type: array

          items:

            $ref: 'TS29522_UAVFlightAssistance.yaml#/components/schemas/UAVFlightAssistNotif'

          minItems: 1

        suppFeat:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

      required:

        - retrievedResults

#

# SIMPLE DATA TYPES

#

#

# ENUMERATIONS

#

    RetrievePurpose:

      anyOf:

      - type: string

        enum:

          - USS_CHANGEOVER

          - PRE_FLIGHT_PLANNING

      - type: string

        description: >

          This string provides forward-compatibility with future extensions to the enumeration and

          is not used to encode content defined in the present version of this API.

      description: |

        Represents the purpose of the retrieved UAV flight information.  

        Possible values are:

          - USS_CHANGEOVER: Indicates that the purpose of retrieved UAV Flight information is USS

            changeover.

          - PRE_FLIGHT_PLANNING: Indicates that the purpose of retrieved UAV Flight information is

            pre-flight planning.