openapi: 3.0.0
info:
  version: '1.0.0.alpha-2'
  title: 'NhssUEAU'
  description: |
    HSS UE Authentication Service.
    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.563 Home Subscriber Server (HSS)Services for Interworking With UDM, version 16.0.0
  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.563/'

servers:
  - url: '{apiRoot}/nhss-ueau/v1'
    variables:
      apiRoot:
        default: https://example.com
        description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.

security:
  - oAuth2ClientCredentials:
    - nhss-ueau
  - {}

paths:
  /generate-av:
    post:
      summary: Generate authentication vector for the UE
      operationId: GenerateAV
      tags:
        - Generate Auth Vector
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvGenerationRequest'
        required: true
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvGenerationResponse'
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '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:
          description: Unexpected error


components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows: 
        clientCredentials: 
          tokenUrl: '{nrfApiRoot}/oauth2/token'
          scopes:
            nhss-ueau: Access to the nhss-ueau API


  schemas:

# COMPLEX TYPES:

    AvGenerationRequest:
      type: object
      required:
        - imsi
        - authType
        - servingNetworkName
      properties:
        imsi:
          type: string
          pattern: '^[0-9]{5,15}$'
        authType:
          $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthType'
        servingNetworkName:
          $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName'
        resynchronizationInfo:
          $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo'

    AvGenerationResponse:
      type: object
      oneOf:
        - required:
          - avEapAkaPrime
        - required:
          - av5GHeAka
      properties:
        avEapAkaPrime:
          $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AvEapAkaPrime'
        av5GHeAka:
          $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Av5GHeAka'


# SIMPLE TYPES:


# ENUMS: