Latest Generated OAS for MEC document (ccfa902d) · Commits · MEC - Multi-access Edge Computing / Bandwidth Management API

Auto_Generated_OAS_Outputs/gs_mec015v020201p_BWM_API.yaml

+38 −81

Original line number	Diff line number	Diff line
		@@ -14,7 +14,7 @@ paths:
		get:
		summary: Retrieve information about a specific bandwidthAllocation.
		description: "This method retrieves information about a bandwidthAllocation resource. This method is typically used in \"Get configured bandwidth allocation from Bandwidth Management Service\" procedure as described in clause\_6.2.5."
		operationId: bwallocationsByIdGET
		operationId: BwallocationsGETAllocationid
		tags:
		- bwm
		responses:
		@@ -33,10 +33,17 @@ paths:
		$ref: '#/components/responses/404'
		'403':
		$ref: '#/components/responses/403'
		parameters:
		- name: allocationId
		in: path
		required: true
		description: The unique identifier of the allocationId.
		schema:
		type: string
		put:
		summary: Update the information about a specific bandwidthAllocation.
		description: "This method updates the information about a bandwidthAllocation resource. As specified in ETSI GS\_MEC\_009\_[6], the PUT HTTP method has \"replace\" semantics."
		operationId: bwallocationsByIdPUT
		operationId: BwallocationsPUTAllocationid
		tags:
		- bwm
		requestBody:
		@@ -67,10 +74,17 @@ paths:
		$ref: '#/components/responses/403'
		'412':
		$ref: '#/components/responses/412'
		parameters:
		- name: allocationId
		in: path
		required: true
		description: The unique identifier of the allocationId.
		schema:
		type: string
		patch:
		summary: Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure.
		description: 'This method updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes ("deltas") in the request body. '
		operationId: bwallocationsByIdPATCH
		operationId: BwallocationsPATCHAllocationid
		tags:
		- bwm
		requestBody:
		@@ -101,10 +115,17 @@ paths:
		$ref: '#/components/responses/403'
		'412':
		$ref: '#/components/responses/412'
		parameters:
		- name: allocationId
		in: path
		required: true
		description: The unique identifier of the allocationId.
		schema:
		type: string
		delete:
		summary: Remove a specific bandwidthAllocation.
		description: DELETE method is typically used in "Unregister from Bandwidth Management Service" procedure as described in clause 6.2.3.
		operationId: bwallocationsByIdDELETE
		operationId: BwallocationsDELETEAllocationid
		tags:
		- bwm
		responses:
		@@ -114,11 +135,18 @@ paths:
		$ref: '#/components/responses/404'
		'403':
		$ref: '#/components/responses/403'
		parameters:
		- name: allocationId
		in: path
		required: true
		description: The unique identifier of the allocationId.
		schema:
		type: string
		/bw_allocations:
		get:
		summary: Retrieve information about a list of bandwidthAllocation resources.
		description: This method retrieves information about a list of bandwidthAllocation resources. This method is typically used in "Get configured bandwidth allocation from Bandwidth Management Service" procedure as described in clause 6.2.5.
		operationId: bwallocationsGET
		operationId: BwallocationsGET
		tags:
		- bwm
		parameters:
		@@ -131,9 +159,6 @@ paths:
		content:
		application/json:
		schema:
		type: object
		properties:
		BwInfo:
		type: array
		items:
		$ref: '#/components/schemas/BwInfo'
		@@ -146,7 +171,7 @@ paths:
		post:
		summary: Create a bandwidthAllocation resource.
		description: This method is used to create a bandwidthAllocation resource. This method is typically used in "Register to Bandwidth Management Service" procedure as described in clause 6.2.1.
		operationId: bwallocationsPOST
		operationId: BwallocationsPOST
		tags:
		- bwm
		requestBody:
		@@ -175,6 +200,7 @@ paths:
		$ref: '#/components/responses/404'
		'403':
		$ref: '#/components/responses/403'
		parameters: []
		components:
		schemas:
		ProblemDetails:
		@@ -184,50 +210,34 @@ components:
		type: string
		format: uri
		description: A URI reference according to IETF RFC 3986 that identifies the problem type
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: URI
		title:
		type: string
		description: A short, human-readable summary of the problem type
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: String
		status:
		type: integer
		format: uint32
		description: The HTTP status code for this occurrence of the problem
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Uint32
		detail:
		type: string
		description: A human-readable explanation specific to this occurrence of the problem
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: String
		instance:
		type: string
		format: uri
		description: A URI reference that identifies the specific occurrence of the problem
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: URI
		BwInfo:
		x-etsi-ref: 7.2.2
		type: object
		properties:
		allocationId:
		description: Bandwidth allocation instance identifier
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		timeStamp:
		$ref: '#/components/schemas/TimeStamp'
		appInsId:
		description: Application instance identifier
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		appName:
		description: Name of the application
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		requestType:
		type: integer
		@@ -238,8 +248,6 @@ components:
		1 = SESSION_SPECIFIC_BW_ALLOCATION'
		enum:
		- SEE_DESCRIPTION
		x-etsi-mec-origin-type: Enum_inlined
		x-etsi-mec-cardinality: '1'
		sessionFilter:
		type: array
		items:
		@@ -249,12 +257,8 @@ components:
		description: Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
		enum:
		- SEE_DESCRIPTION
		x-etsi-mec-origin-type: Enum
		x-etsi-mec-cardinality: 0..1
		fixedAllocation:
		description: Size of requested fixed BW allocation in [bps]
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		allocationDirection:
		description: 'The direction of the requested BW allocation:
		@@ -264,8 +268,6 @@ components:
		01 = Uplink (towards the application/session)

		10 = Symmetrical'
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		required:
		- appInsId
		@@ -278,13 +280,9 @@ components:
		properties:
		allocationId:
		description: Bandwidth allocation instance identifier
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		appInsId:
		description: Application instance identifier
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: '1'
		type: string
		requestType:
		type: integer
		@@ -295,8 +293,6 @@ components:
		1 = SESSION_SPECIFIC_BW_ALLOCATION'
		enum:
		- SEE_DESCRIPTION
		x-etsi-mec-origin-type: Enum_inlined
		x-etsi-mec-cardinality: '1'
		sessionFilter:
		type: array
		items:
		@@ -306,12 +302,8 @@ components:
		description: Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document
		enum:
		- SEE_DESCRIPTION
		x-etsi-mec-origin-type: Enum_inlined
		x-etsi-mec-cardinality: 0..1
		fixedAllocation:
		description: Size of requested fixed BW allocation in [bps]
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		allocationDirection:
		description: 'The direction of the requested BW allocation:
		@@ -321,8 +313,6 @@ components:
		01 = Uplink (towards the application/session)

		10 = Symmetrical'
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		required:
		- allocationId
		@@ -330,20 +320,14 @@ components:
		- requestType
		TimeStamp:
		description: Time stamp to indicate when the corresponding information elements are sent
		x-etsi-mec-origin-type: Structure (inlined)
		x-etsi-mec-cardinality: 0..1
		type: object
		properties:
		seconds:
		description: The seconds part of the Time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC
		x-etsi-mec-origin-type: Uint32
		x-etsi-mec-cardinality: '1'
		type: integer
		format: uint32
		nanoSeconds:
		description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
		x-etsi-mec-origin-type: Uint32
		x-etsi-mec-cardinality: '1'
		type: integer
		format: uint32
		required:
		@@ -351,67 +335,43 @@ components:
		- nanoSeconds
		SessionFilter:
		description: Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter, the request shall be rejected
		x-etsi-mec-origin-type: Structure (inlined)
		x-etsi-mec-cardinality: 0..N
		type: object
		minItems: 0
		properties:
		sourceIp:
		description: "Source address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC\_1166\_[10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC\_5952\_[11], with in CIDR notation [12] used to provide the routing prefix"
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		sourcePort:
		description: Source port identity of session
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		dstAddress:
		description: "Destination address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC\_1166\_[10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF RFC\_5952\_[11], with in CIDR notation [12] used to provide the routing prefix"
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		dstPort:
		description: Destination port identity of session
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		protocol:
		description: Protocol number
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		SessionFilter1:
		description: Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter, the request shall be rejected
		x-etsi-mec-origin-type: Structure (inlined)
		x-etsi-mec-cardinality: 0..N
		type: object
		minItems: 0
		properties:
		sourceIp:
		description: "Source address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC\_1166\_[10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF\_RFC\_5952\_[11], with in CIDR notation [12] used to provide the routing prefix"
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		sourcePort:
		description: 'Source port identity of session '
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		dstAddress:
		description: "Destination address identity of session. The string for an IPv4 address shall be formatted in the \"dotted decimal\" notation as defined in IETF RFC\_1166\_[10]. The string for an IPv6 address shall be formatted according to clause 4 of IETF\_RFC\_5952\_[11], with in CIDR notation [12] used to provide the routing prefix"
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		dstPort:
		description: Destination port identity of session
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		protocol:
		description: Protocol number
		x-etsi-mec-origin-type: String
		x-etsi-mec-cardinality: 0..1
		type: string
		responses:
		'200':
		@@ -448,7 +408,6 @@ components:

		See note.'
		name: app_instance_id
		cardinality: 0..N
		in: query
		required: false
		x-exportParamName: Query.App_instance_id
		@@ -461,7 +420,6 @@ components:

		See note.'
		name: app_name
		cardinality: 0..N
		in: query
		required: false
		x-exportParamName: Query.App_name
		@@ -474,7 +432,6 @@ components:

		See note.'
		name: session_id
		cardinality: 0..N
		in: query
		required: false
		x-exportParamName: Query.Session_id