Commit 10d52703 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Added callbacks and links

parent 277682e6
...@@ -37,6 +37,9 @@ ...@@ -37,6 +37,9 @@
}, },
{ {
"name": "appContext" "name": "appContext"
},
{
"name": "callback"
} }
], ],
"paths": { "paths": {
...@@ -109,6 +112,11 @@ ...@@ -109,6 +112,11 @@
"404": { "404": {
"$ref": "#/components/responses/Error.404" "$ref": "#/components/responses/Error.404"
} }
},
"callbacks": {
"referenceURI": {
"$ref": "#/components/callbacks/NotificationEvent"
}
} }
} }
}, },
...@@ -143,6 +151,11 @@ ...@@ -143,6 +151,11 @@
"404": { "404": {
"$ref": "#/components/responses/Error.404" "$ref": "#/components/responses/Error.404"
} }
},
"callbacks": {
"referenceURI": {
"$ref": "#/components/callbacks/NotificationEvent"
}
} }
}, },
"delete": { "delete": {
...@@ -172,6 +185,43 @@ ...@@ -172,6 +185,43 @@
} }
}, },
"components": { "components": {
"callbacks": {
"NotificationEvent": {
"{$request.body#/callbackReference}": {
"post": {
"description": "Used by the UALCMP to inform the UE application of a modification to reference URI of the user application.",
"operationId": "NotificationEvent_POST",
"tags": [
"callback"
],
"requestBody": {
"$ref": "#/components/requestBodies/NotificationEvent"
},
"responses": {
"204": {
"description": "No Content."
}
}
}
}
}
},
"links": {
"PutAppContext": {
"operationId": "AppContextId_PUT",
"description": "The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}`",
"parameters": {
"contextId": "$response.body#/contextId"
}
},
"DelAppContext": {
"operationId": "AppContextId_DEL",
"description": "The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}`",
"parameters": {
"contextId": "$response.body#/contextId"
}
}
},
"parameters": { "parameters": {
"Query.AppName": { "Query.AppName": {
"name": "appName", "name": "appName",
...@@ -255,6 +305,17 @@ ...@@ -255,6 +305,17 @@
} }
}, },
"required": true "required": true
},
"NotificationEvent": {
"description": "Sent by the UALCMP to the UE application.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationEvent"
}
}
},
"required": true
} }
}, },
"responses": { "responses": {
...@@ -266,6 +327,14 @@ ...@@ -266,6 +327,14 @@
"$ref": "#/components/schemas/AppContext" "$ref": "#/components/schemas/AppContext"
} }
} }
},
"links": {
"putAppContext": {
"$ref": "#/components/links/PutAppContext"
},
"delAppContext": {
"$ref": "#/components/links/DelAppContext"
}
} }
}, },
"AppList": { "AppList": {
...@@ -412,6 +481,7 @@ ...@@ -412,6 +481,7 @@
"required": [ "required": [
"contextId", "contextId",
"associateUeAppId", "associateUeAppId",
"callbackReference",
"appInfo" "appInfo"
], ],
"properties": { "properties": {
...@@ -462,11 +532,13 @@ ...@@ -462,11 +532,13 @@
}, },
"ContextId": { "ContextId": {
"description": "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and included in the response. The length of the value shall not exceed 32 characters.", "description": "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and included in the response. The length of the value shall not exceed 32 characters.",
"type": "string" "type": "string",
"readOnly": true
}, },
"AssociateUeAppId": { "AssociateUeAppId": {
"description": "Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.", "description": "Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.",
"type": "string" "type": "string",
"writeOnly": true
}, },
"VendorId": { "VendorId": {
"description": "Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of this vendor specific extension is not defined", "description": "Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of this vendor specific extension is not defined",
...@@ -570,7 +642,7 @@ ...@@ -570,7 +642,7 @@
"format": "uint32" "format": "uint32"
}, },
"Bandwidth": { "Bandwidth": {
"description": "The required connection bandwidth in kbit/s for the use of the mobile edge application instance", "description": "The required connection bandwidth in kbit/s for the use of the MEC application instance",
"type": "integer", "type": "integer",
"format": "uint32" "format": "uint32"
}, },
...@@ -601,12 +673,14 @@ ...@@ -601,12 +673,14 @@
"CallbackReference": { "CallbackReference": {
"description": "URI assigned by the UE application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.", "description": "URI assigned by the UE application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.",
"type": "string", "type": "string",
"format": "uri" "format": "uri",
"writeOnly": true
}, },
"ReferenceURL": { "ReferenceURL": {
"description": "Address of the user application. Used as the reference URL for the application. Assigned by the MEC system and included in the response", "description": "Address of the user application. Used as the reference URL for the application. Assigned by the MEC system and included in the response",
"type": "string", "type": "string",
"format": "uri" "format": "uri",
"readOnly": true
}, },
"AppPackageSource": { "AppPackageSource": {
"description": "URI of the application package. Included in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2", "description": "URI of the application package. Included in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2",
......
...@@ -22,6 +22,7 @@ servers: ...@@ -22,6 +22,7 @@ servers:
tags: tags:
- name: appList - name: appList
- name: appContext - name: appContext
- name: callback
paths: paths:
"/app_list": "/app_list":
get: get:
...@@ -70,6 +71,9 @@ paths: ...@@ -70,6 +71,9 @@ paths:
$ref: '#/components/responses/Error.403' $ref: '#/components/responses/Error.403'
"404": "404":
$ref: '#/components/responses/Error.404' $ref: '#/components/responses/Error.404'
callbacks:
referenceURI:
$ref: '#/components/callbacks/NotificationEvent'
"/app_contexts/{contextId}": "/app_contexts/{contextId}":
parameters: parameters:
- $ref: "#/components/parameters/Path.ContextId" - $ref: "#/components/parameters/Path.ContextId"
...@@ -94,6 +98,9 @@ paths: ...@@ -94,6 +98,9 @@ paths:
$ref: '#/components/responses/Error.403' $ref: '#/components/responses/Error.403'
"404": "404":
$ref: '#/components/responses/Error.404' $ref: '#/components/responses/Error.404'
callbacks:
referenceURI:
$ref: '#/components/callbacks/NotificationEvent'
delete: delete:
description: >- description: >-
The DELETE method is used to delete the resource that represents the The DELETE method is used to delete the resource that represents the
...@@ -113,6 +120,32 @@ paths: ...@@ -113,6 +120,32 @@ paths:
"404": "404":
$ref: '#/components/responses/Error.404' $ref: '#/components/responses/Error.404'
components: components:
callbacks:
NotificationEvent:
'{$request.body#/callbackReference}':
post:
description: >-
Used by the UALCMP to inform the UE application of
a modification to reference URI of the user application.
operationId: NotificationEvent_POST
tags:
- callback
requestBody:
$ref: '#/components/requestBodies/NotificationEvent'
responses:
'204':
description: No Content.
links:
PutAppContext:
operationId: AppContextId_PUT
description: The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}`
parameters:
contextId: '$response.body#/contextId'
DelAppContext:
operationId: AppContextId_DEL
description: The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}`
parameters:
contextId: '$response.body#/contextId'
parameters: parameters:
Query.AppName: Query.AppName:
name: appName name: appName
...@@ -185,6 +218,14 @@ components: ...@@ -185,6 +218,14 @@ components:
schema: schema:
$ref: "#/components/schemas/AppContext" $ref: "#/components/schemas/AppContext"
required: true required: true
NotificationEvent:
description: >-
Sent by the UALCMP to the UE application.
content:
application/json:
schema:
$ref: "#/components/schemas/NotificationEvent"
required: true
responses: responses:
AppContext: AppContext:
description: >- description: >-
...@@ -194,6 +235,11 @@ components: ...@@ -194,6 +235,11 @@ components:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/AppContext" $ref: "#/components/schemas/AppContext"
links:
putAppContext:
$ref: "#/components/links/PutAppContext"
delAppContext:
$ref: "#/components/links/DelAppContext"
AppList: AppList:
description: >- description: >-
The response body contains the ApplicationList resource available The response body contains the ApplicationList resource available
...@@ -308,6 +354,7 @@ components: ...@@ -308,6 +354,7 @@ components:
required: required:
- contextId - contextId
- associateUeAppId - associateUeAppId
- callbackReference
- appInfo - appInfo
properties: properties:
contextId: contextId:
...@@ -347,11 +394,13 @@ components: ...@@ -347,11 +394,13 @@ components:
Assigned by the MEC system and included in the response. The Assigned by the MEC system and included in the response. The
length of the value shall not exceed 32 characters. length of the value shall not exceed 32 characters.
type: string type: string
readOnly: true
AssociateUeAppId: AssociateUeAppId:
description: >- description: >-
Uniquely identifies the UE application. Included in the request. The Uniquely identifies the UE application. Included in the request. The
length of the value shall not exceed 32 characters. length of the value shall not exceed 32 characters.
type: string type: string
writeOnly: true
VendorId: VendorId:
description: >- description: >-
Vendor identifier. The length of the value shall not exceed 32 Vendor identifier. The length of the value shall not exceed 32
...@@ -439,8 +488,8 @@ components: ...@@ -439,8 +488,8 @@ components:
format: uint32 format: uint32
Bandwidth: Bandwidth:
description: >- description: >-
The required connection bandwidth in kbit/s for the use of the mobile The required connection bandwidth in kbit/s for the use of the MEC
edge application instance application instance
type: integer type: integer
format: uint32 format: uint32
ServiceCont: ServiceCont:
...@@ -478,6 +527,7 @@ components: ...@@ -478,6 +527,7 @@ components:
alive for the lifetime of the application context. alive for the lifetime of the application context.
type: string type: string
format: uri format: uri
writeOnly: true
ReferenceURL: ReferenceURL:
description: >- description: >-
Address of the user application. Used as the reference URL for the Address of the user application. Used as the reference URL for the
...@@ -485,6 +535,7 @@ components: ...@@ -485,6 +535,7 @@ components:
response response
type: string type: string
format: uri format: uri
readOnly: true
AppPackageSource: AppPackageSource:
description: >- description: >-
URI of the application package. Included in the request if the URI of the application package. Included in the request if the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment