Commit 024b5e8f authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

Updates after CT4#130

parent 3514b9fb
Loading
Loading
Loading
Loading
Loading
+140 −2
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.4.0-alpha.2'
  version: '1.4.0-alpha.3'
  title: 'NRF OAuth2'
  description: |
    NRF OAuth2 Authorization.  
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.510 V19.3.0; 5G System; Network Function Repository Services; Stage 3
  description: 3GPP TS 29.510 V19.4.0; 5G System; Network Function Repository Services; Stage 3
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'

servers:
@@ -144,6 +144,101 @@ paths:
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /oauth2/retrieve-key:
    post:
      summary: Retrieve Key Request
      operationId: RetrieveKeyRequest
      tags:
        - Retrieve Key Request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveKeyReq'
        required: true
      responses:
        '200':
          description: Successful Retrieve Key Request
          content:
            application/json: # message without binary body part
              schema:
                $ref: '#/components/schemas/RetrieveKeyRsp'
            multipart/related:  # message with binary body part(s)
              schema:
                type: object
                properties: # Request parts
                  jsonData:
                    $ref: '#/components/schemas/RetrieveKeyRsp'
                  x509Certificate:
                    type: string
                    format: binary
                  certificateChain:
                    type: string
                    format: binary
              encoding:
                jsonData:
                  contentType:  application/json
                x509Certificate:
                  contentType:  application/pkix-cert
                  headers:
                    Content-Id:
                      schema:
                        type: string
                certificateChain:
                  contentType:  application/pkcs7-mime
                  headers:
                    Content-Id:
                      schema:
                        type: string
        '307':
          description: Temporary Redirect
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
          headers:
            Location:
              description: The URI pointing to the resource located on the redirect target NRF
              required: true
              schema:
                type: string
        '308':
          description: Permanent Redirect
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
          headers:
            Location:
              description: The URI pointing to the resource located on the redirect target NRF
              required: true
              schema:
                type: string
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '401':
          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '501':
          $ref: 'TS29571_CommonData.yaml#/components/responses/501'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

components:
  headers:
    cache-control:
@@ -186,6 +281,7 @@ components:
        requesterPlmn:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
        requesterPlmnList:
          deprecated: true
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
@@ -238,6 +334,8 @@ components:
          minItems: 1
        sourceVendorId:
          $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId'
        afId:
          type: string

    AccessTokenRsp:
      description: Contains information related to the access token response
@@ -332,6 +430,13 @@ components:
          minProperties: 1
        iat:
          type: integer
        afId:
          type: string
        interOpIndList:
          type: array
          items:
            $ref: '#/components/schemas/MlModelInterInd'
          minItems: 1

    AccessTokenErr:
      description: Error returned in the access token response message
@@ -367,3 +472,36 @@ components:
      required:
        - analyticsId
        - vendorList

    RetrieveKeyReq:
      description: >
        Contain the information to identify the key used to validate the signature of the OAuth2 
        access token.
      type: object
      properties:
        issuer:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        headerParameters:
          type: object
          additionalProperties:
            type: string
          minProperties: 1
          description: >
            A map (list of key-value pairs) where the name of the header parameters served as keys
        producer:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
      required:
        - issuer
        - headerParameters

    RetrieveKeyRsp:
      description: >
        Contain the key used to validate the signature of the OAuth2 access token.
      type: object
      properties:
        rawPubKey:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
        x509Cert:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        certChain:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
+2 −2
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.3.0-alpha.1'
  version: '1.3.0-alpha.2'
  title: 'NRF Bootstrapping'
  description: |
    NRF Bootstrapping.  
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.510 V19.3.0; 5G System; Network Function Repository Services; Stage 3
  description: 3GPP TS 29.510 V19.4.0; 5G System; Network Function Repository Services; Stage 3
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'

servers:
+12 −4
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.4.0-alpha.4'
  version: '1.4.0-alpha.5'
  title: 'NRF NFDiscovery Service'
  description: |
    NRF NFDiscovery Service.  
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.510 V19.3.0; 5G System; Network Function Repository Services; Stage 3
  description: 3GPP TS 29.510 V19.4.0; 5G System; Network Function Repository Services; Stage 3
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'

servers:
@@ -187,14 +187,14 @@ paths:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
        - name: ipv4-index
          in: query
          description: The IPv4 Index supported by the candidate UPF.
          description: The IPv4 Index supported by the candidate UPF/SMF.
          content:
            application/json:
              schema:
                $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex'
        - name: ipv6-index
          in: query
          description: The IPv6 Index supported by the candidate UPF.
          description: The IPv6 Index supported by the candidate UPF/SMF.
          content:
            application/json:
              schema:
@@ -1345,6 +1345,13 @@ paths:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
        - name: any-ue-ind
          in: query
          description: AnyUE indicator
          schema:
            type: boolean
            enum:
              - true

      responses:
        '200':
@@ -2144,6 +2151,7 @@ components:
          type: array
          items:
            $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription'
          minItems: 1
        lmfInfo:
          $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LmfInfo'
        gmlcInfo:
+69 −5
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.4.0-alpha.4'
  version: '1.4.0-alpha.5'
  title: 'NRF NFManagement Service'
  description: |
    NRF NFManagement Service.  
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.510 V19.3.0; 5G System; Network Function Repository Services; Stage 3
  description: 3GPP TS 29.510 V19.4.0; 5G System; Network Function Repository Services; Stage 3
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'

servers:
@@ -1735,6 +1735,7 @@ components:
          type: array
          items:
            $ref: '#/components/schemas/DefaultNotificationSubscription'
          minItems: 1
        lmfInfo:
          $ref: '#/components/schemas/LmfInfo'
        gmlcInfo:
@@ -2450,6 +2451,7 @@ components:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
          minItems: 1

    NetworkSliceCond:
      description: Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support
@@ -2461,10 +2463,12 @@ components:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
          minItems: 1
        nsiList:
          type: array
          items:
            type: string
          minItems: 1

    NfGroupCond:
      description: Subscription to a set of NFs based on their Group Id
@@ -2565,6 +2569,9 @@ components:
          items:
            $ref: '#/components/schemas/SharedDataIdRange'
          minItems: 1
        anyUeInd:
          type: boolean
          default: false

    SharedDataIdRange:
      description: A range of SharedDataIds based on regular-expression matching
@@ -2692,6 +2699,9 @@ components:
          items:
            $ref: '#/components/schemas/SuciInfo'
          minItems: 1
        anyUeUdmSingleInstance:
          type: boolean
          default: false

    AusfInfo:
      description: Information of an AUSF NF Instance
@@ -2876,6 +2886,16 @@ components:
          items:
            $ref: '#/components/schemas/PlmnRange'
          minItems: 1
        ipv4IndexList:
          type: array
          items:
            $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex'
          minItems: 1
        ipv6IndexList:
          type: array
          items:
            $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex'
          minItems: 1

    UpfInfo:
      description: Information of an UPF NF Instance
@@ -3750,7 +3770,6 @@ components:
            - nnef-traffic-influence-data
            - nnef-ecs-addr-cfg-info
            - nnef-ueid
            - nnef-vflnfdiscovery
            - 3gpp-cp-parameter-provisioning
            - 3gpp-device-triggering
            - 3gpp-bdt
@@ -3802,10 +3821,16 @@ components:
            - 3gpp-pfd-management
            - 3gpp-network-parameter-configuration
            - 3gpp-addr-pp
            - 3gpp-uav-flight-assistance
            - 3gpp-uav-fa
            - 3gpp-caginfo-pp
            - 3gpp-retrieve-uav-flight
            - 3gpp-ims-session-management
            - 3gpp-ims-sm
            - 3gpp-ims-ee
            - 3gpp-ims-pp
            - 3gpp-vfl-training
            - 3gpp-vfl-inference
            - 3gpp-vfl-nf-discovery
            - 3gpp-aiot
            - npcf-am-policy-control
            - npcf-smpolicycontrol
            - npcf-policyauthorization
@@ -3892,6 +3917,10 @@ components:
            - nupf-gueip
            - naf-prose
            - naf-eventexposure
            - naf-vfltraining
            - naf-vflinference
            - naf-training
            - naf-inference
            - nmf-mrm
            - nimsas-sec
            - nimsas-mc
@@ -4517,6 +4546,13 @@ components:
          items:
            $ref: '#/components/schemas/TaiRange'
          minItems: 1
        taiWeightList:
          description: >
            List of TAI(s) and/or TAI range(s), each with its associated weight.
          type: array
          items:
            $ref: '#/components/schemas/TaiWeightInfo'
          minItems: 1
        nwdafCapability:
          $ref: '#/components/schemas/NwdafCapability'
        analyticsDelay:
@@ -4537,6 +4573,32 @@ components:
            $ref: '#/components/schemas/MlAnalyticsInfo'
          minItems: 1

    TaiWeightInfo:
      description: >
        Weight assigned to TAI List(s) and/or TAI range List(s).
        A higher value indicates a higher priority.
      type: object
      properties:
        taiList:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
          minItems: 1
        taiRangeList:
          type: array
          items:
            $ref: '#/components/schemas/TaiRange'
          minItems: 1
        weight:
          type: integer
          minimum: 1
          maximum: 1024
      required:
        - weight
      anyOf:
        - required: [ taiList ]
        - required: [ taiRangeList ]

    LmfInfo:
      description: Information of an LMF NF Instance
      type: object
@@ -6360,6 +6422,8 @@ components:
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
          minItems: 1
        devIdRegEx:
          type: string
        afIdList:
          type: array
          items: