Upload the reference (b9aae1f4) · Commits · SA5 – Management & Orchestration and Charging / Charging Management APIs

OpenAPI/TS28538_EdgeNrm.yaml

0 → 100644

+477 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP Edge NRM
		version: 19.0.0
		description: >-
		OAS 3.0.1 specification of the Edge NRM
		© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.538; Edge NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.538/
		paths: {}
		components:
		schemas:

		#-------- Definition of types-----------------------------------------------------
		ServingLocation:
		type: object
		properties:
		geographicalLocation:
		$ref: '#/components/schemas/GeoLoc'
		topologicalLocation:
		$ref: '#/components/schemas/TopologicalServiceArea'
		TopologicalServiceArea:
		type: object
		properties:
		cellIdList:
		type: array
		items:
		type: integer
		trackingAreaIdList:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList'
		servingPLMN:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
		GeoLoc:
		type: object
		properties:
		geographicalCoordinates:
		$ref: '#/components/schemas/GeographicalCoordinates'
		civicLocation:
		type: string
		GeographicalCoordinates:
		type: object
		properties:
		latitude:
		type: integer
		longitude:
		type: integer
		EDNConnectionInfo:
		type: object
		properties:
		dNN:
		type: string
		eDNServiceArea:
		$ref: '#/components/schemas/ServingLocation'
		AffinityAntiAffinity:
		type: object
		properties:
		affinityEAS:
		type: array
		items:
		type: string
		antiAffinityEAS:
		type: array
		items:
		type: string
		VirtualResource:
		type: object
		properties:
		virtualMemory:
		type: integer
		virtualDisk:
		type: integer
		virtualCPU:
		type: string
		vnfdId:
		type: string
		SoftwareImageInfo:
		type: object
		properties:
		minimumDisk:
		type: integer
		minimumRAM:
		type: integer
		discFormat:
		type: string
		operatingSystem:
		type: string
		swImageRef:
		type: string
		RegistrationInfo:
		type: object
		properties:
		registrationExpiry:
		type: string
		readOnly: true
		registrationID:
		type: string
		readOnly: true
		secCredential:
		type: string
		Duration:
		type: object
		properties:
		startTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		endTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		EASServicePermission:
		type: string
		description: any of enumerated value
		enum:
		- TRIAL
		- SILVER
		- GOLD
		EASFeature:
		type: string
		EASStatus:
		type: string
		description: any of enumerated value
		enum:
		- ENABLED
		- DISABLED
		ResourceReservationRequirement:
		type: object
		properties:
		computeRequirement:
		type: string
		storageRequirement:
		type: string
		networkingRequirement:
		type: integer

		ResourceReservationStatus:
		type: object
		properties:
		resourceId:
		type: string
		reservationStatus:
		type: string
		description: any of enumrated value
		enum:
		- RESERVED
		- USEd
		RelocationTriggerInfo:
		type: object
		properties:
		triggerType:
		type: string
		description: any of enumrated value
		enum:
		- IMMEDIATE
		- FUTURE
		futuristicTriggerTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		AvailableEDNList:
		type: object
		properties:
		resourceQuota:
		$ref: '#/components/schemas/VirtualResource'
		FederatedECSInfo:
		type: object
		properties:
		federateECSIdentifier:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		federatedECSProfile:
		type: integer
		servedEASList:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		servedEESList:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		#-------- Definition of types for name-containments ------
		SubNetwork-ncO-EdgeNrm:
		type: object
		properties:
		ECSFunction:
		$ref: '#/components/schemas/ECSFunction-Multiple'
		EdgeDataNetwork:
		$ref: '#/components/schemas/EdgeDataNetwork-Multiple'
		EASBundle:
		$ref: '#/components/schemas/EASBundle-Multiple'

		#-------- Definition of concrete IOCs --------------------------------------------

		EdgeDataNetwork-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		ednIdentifier:
		type: string
		eDNConnectionInfo:
		$ref: '#/components/schemas/EDNConnectionInfo'
		- type: object
		properties:
		EASFunction:
		$ref: '#/components/schemas/EASFunction-Multiple'
		EESFunction:
		$ref: '#/components/schemas/EESFunction-Multiple'
		availableEdgeVirtualResources:
		type: string

		EASFunction-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eASIdentifier:
		type: string
		eESAddress:
		type: array
		items:
		type: string
		registrationInfo:
		$ref: '#/components/schemas/RegistrationInfo'
		eASRequirementsRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		eASAddress:
		type: array
		items:
		type: string
		relocationTriggerInfo:
		$ref: '#/components/schemas/RelocationTriggerInfo'
		relocationRejectByASP:
		type: boolean
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		EASProfile-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		aCID:
		type: string
		eASProvider:
		type: string
		eASdescription:
		type: string
		eASSchedule:
		$ref: '#/components/schemas/Duration'
		eASGeographicalServiceArea:
		$ref: '#/components/schemas/GeoLoc'
		eASTopologicalServiceArea:
		$ref: '#/components/schemas/TopologicalServiceArea'
		eASServicePermissionLevel:
		$ref: '#/components/schemas/EASServicePermission'
		eASFeature:
		$ref: '#/components/schemas/EASFeature'
		eASServiceContinuitySupport:
		type: boolean
		eASDNAI:
		type: string
		eASAvailabilityReportingPeriod:
		type: integer
		eASStatus:
		$ref: '#/components/schemas/EASStatus'
		EESFunction-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eESIdentifier:
		type: string
		eESServingLocation:
		type: array
		items:
		$ref: '#/components/schemas/ServingLocation'
		eESAddress:
		type: array
		items:
		type: string
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'
		serviceContinuitySupport:
		type: boolean
		eASFunctionRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		registrationInfo:
		$ref: '#/components/schemas/RegistrationInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

		ECSFunction-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eCSAddress:
		type: string
		providerIdentifier:
		type: string
		edgeDataNetworkRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		eESFuncitonRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'
		sharedECSInfo:
		$ref: '#/components/schemas/FederatedECSInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'

		EASRequirements-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		requiredEASservingLocation:
		$ref: '#/components/schemas/ServingLocation'
		affinityAntiAffinity:
		$ref: '#/components/schemas/AffinityAntiAffinity'
		serviceContinuity:
		type: boolean
		virtualResource:
		$ref: '#/components/schemas/VirtualResource'
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'
		eASSchedule:
		$ref: '#/components/schemas/Duration'
		eASFeature:
		$ref: '#/components/schemas/EASFeature'
		relocationPolicy:
		type: string
		description: any of enumrated value
		enum:
		- YES
		- NO
		- YESwNOTIFY
		federationID:
		type: string
		eASDeploymentMonitor:
		$ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor'
		reservationJobRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		EASResourceReservationJob-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		reservationLocation:
		$ref: '#/components/schemas/ServingLocation'
		resourceReservationRequirement:
		type: array
		items:
		$ref: '#/components/schemas/ResourceReservationRequirement'
		requestedReservationExpiration:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		resourceReservationStatus:
		type: array
		items:
		$ref: '#/components/schemas/ResourceReservationStatus'
		EdgeFederation-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		participatingOPiD:
		type: string
		leadingOPiD:
		type: string
		federatedECSInfo:
		$ref: '#/components/schemas/FederatedECSInfo'

		OperatorEdgeFederation-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		federationID:
		type: string
		FederationExpiry:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		leadingOPiD:
		type: string
		avaibleEDNList:
		$ref: '#/components/schemas/AvailableEDNList'
		acceptedEDN:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		OperatorEdgeDataNetwork-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		availableEASResource:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		edgeDataNetworkRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
		EASBundle-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		bundleIdentifier:
		type: string
		bundledEASIdentifier:
		type: string
		bundleType:
		type: string
		mainEASIdentifier:
		type: string
		coordinatedEASDiscovery:
		type: boolean
		coordinatedACR:
		type: boolean
		eDNAffinity:
		type: string
		description: any of enumrated value
		enum:
		- STRONG
		- WEAK
		- PREFERRED

		#-------- Definition of JSON arrays for name-contained IOCs ----------------------

		EASFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EASFunction-Single'
		ECSFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/ECSFunction-Single'
		EESFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EESFunction-Single'
		EdgeDataNetwork-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EdgeDataNetwork-Single'
		EASProfile-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EASProfile-Single'
		EdgeFederation-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EASProfile-Single'
		OperatorEdgeFederation-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/OperatorEdgeFederation-Single'
		OperatorEdgeDataNetwork-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/OperatorEdgeDataNetwork-Single'
		EASBundle-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EASBundle-Single'
		#--------------------------------- Definition ------------------------------------

		resources-edgeNrm:
		oneOf:
		- $ref: '#/components/schemas/EASFunction-Single'
		- $ref: '#/components/schemas/ECSFunction-Single'
		- $ref: '#/components/schemas/EESFunction-Single'
		- $ref: '#/components/schemas/EdgeDataNetwork-Single'
		- $ref: '#/components/schemas/EASRequirements-Single'
		- $ref: '#/components/schemas/EASProfile-Single'
		- $ref: '#/components/schemas/EdgeFederation-Single'
		- $ref: '#/components/schemas/OperatorEdgeFederation-Single'
		- $ref: '#/components/schemas/OperatorEdgeDataNetwork-Single'
		- $ref: '#/components/schemas/EASResourceReservationJob-Single'
		- $ref: '#/components/schemas/EASBundle-Single'