{"openapi":"3.0.0","externalDocs":{"description":"5GFF MEC Experience management API specification","url":"https://docs.google.com/document/d/1lz5fa_1W6KUELd2DPEvf9_5I219K8k9f2Gd_UwmfbBU/edit"},"info":{"x-logo":{"url":"/swagger/mexdemo/logo.svg","backgroundColor":"#fafafa","version":"1.0"},"version":"0.0.1","title":"5GFF MEC Exposure and Experience Management API Specification","termsOfService":"http://5gff/terms/","license":{"name":"BSD-3-Clause","url":"https://5gff.com/legal"},"contact":{"email":"admin@5gff.com"},"description":"# Introduction\nThe 5G Future Forum (5GFF) was established in January 2020 by América Móvil, KT Corp., \nRogers, Telstra, Verizon, and Vodafone to develop 5G interoperability specifications to \naccelerate the delivery of 5G and MEC solutions around the world.\n\nThe MEC Exposure and Experience Management Application Programming Interface specification is the \nfirst technical product from the collaboration among all member companies. \nThis specification defines a standard, language-agnostic interface to RESTful APIs which \nallows both human and computer software to discover and understand the availability and \ncapabilities of multi-access edge computing resources and services deployed in \ntelecommunications service provider’s networks.\n\nThe APIs are specified as vendor neutral and intended to be consumed by telecommunications service \nproviders, cloud service providers, enterprise application developers, and cloud-native application \ndevelopers to discover, deploy, manage, interoperate, and orchestrate applications and services on \nthe network edges, including networks of 4G LTE, 5G, broadband, and public WiFi. \n\n  ---\n\n# API Scope\nAPIs defined in this version of the specification can be categorized into the following areas:\n* __MEC site discovery__ - discovery of best available MEC resource location(s)\n* __MEC service profile management__ - register, retrieve, update, and delete MEC service/application profiles\n* __MEC edge event notification__ - subscription management for edge event notifications\n\n---\n"},"servers":[{"url":"http://localhost:{port}/v1","description":"Local host API","variables":{"port":{"enum":["3333"],"default":"3333"}}},{"url":"https://edge.5gff.com:{port}/v1","description":"Production API","variables":{"port":{"enum":["443","8443"],"default":"443"}}},{"url":"https://{region}.edge.5gff.com:{port}/v1","description":"Production API for Regions","variables":{"region":{"enum":["west","east","north","south"],"default":"west"},"port":{"enum":["443","8443"],"default":"443"}}}],"paths":{"/discover":{"get":{"operationId":"discovery","parameters":[{"in":"query","name":"density","schema":{"type":"number"},"description":"\nsubscriber density in a region \n"},{"in":"query","name":"serviceProfileID","schema":{"type":"string"},"description":"Workloads deployed at the edge are associated to a type of profile. "},{"in":"query","name":"region","schema":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionType","type":"string","enum":[]},"description":"Edge locations belong to a geographical or logical region"}],"responses":{"200":{"description":"Optimal MEC platforms based on various parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Discover Optimal Edge Platforms","description":"API to discover optimal Edge for workload placement"}},"/discover/subscriber/edges":{"parameters":[],"get":{"summary":"Optimal Edge based on end user Identity","responses":{"200":{"description":"Array of Optimal MEC platforms based on Subscriber Identity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-discover-edges-UEIdentity","description":"Retrieve ordered list of Optimal Edge \"Platforms\" based on subscriber identity","parameters":[{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"UEIdentity","required":true,"description":"Array of User Identifiers with similar type"},{"schema":{"type":"string","example":"192.168.10.1,2001:0db8:85a3:0000:0000:8a2e:0370:7334","enum":["IPAddress","MSISDN","IMEI","MDN","GPSI"]},"in":"query","name":"UEIdentityType","required":true,"description":"Type of user identifier"},{"schema":{"type":"string"},"in":"query","name":"region","description":"Edge locations belonging to a geographical or logical region"}],"tags":["Discovery"]}},"/service/profile/{profileID}":{"parameters":[{"schema":{"type":"string"},"name":"profileID","in":"path","required":true}],"get":{"summary":"Fetch a Service/Application profile","responses":{"200":{"description":"Requested service/application profile is returned based on ProfileID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfile"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-service-profile-id","description":"Retrieve Service/Application profile based on unique ID","tags":["Service"]},"put":{"summary":"Update Service/Application profile","operationId":"put-service-profile-id","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfile"}}}},"responses":{"200":{"description":"Specified service profile is updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"description":"Update Service/Application profile based on unique ID","tags":["Service"]},"delete":{"summary":"Delete a Service/Application profile","operationId":"delete-service-profile-id","responses":{"200":{"description":"Service profile is deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"description":"Delete Service/Application profile based on unique ID","tags":["Service"]}},"/service/profiles":{"get":{"summary":"Fetch all Service/Application profiles","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfile"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-service-profiles","description":"Retrieve all avaialble service profiles","tags":["Service"]}},"/discover/edges/profile/{profileID}":{"parameters":[{"schema":{"type":"string"},"name":"profileID","in":"path","required":true}],"get":{"summary":"Optimal Edges based on service/application profile","responses":{"200":{"description":"Array of MEC platforms based on Application profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-discover-profile-profileID","description":"Retrieve ordered list of Optimal Edge \"Platforms\" based on application profile and user identity","parameters":[{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"UEIdentity","description":"Array of User Identifiers"},{"schema":{"type":"string","example":"192.168.10.1,2001:0db8:85a3:0000:0000:8a2e:0370:7334","enum":["IPAddress","MSISDN","IMEI","MDN","GPSI"]},"in":"query","name":"UEIdentityType","description":"Type of user identifier"}],"tags":["Discovery"]}},"/service/profile":{"post":{"summary":"Create a Service Profile","operationId":"post-service-profile","responses":{"200":{"description":"Service / Application profile ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfileID"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"description":"Create Service/Application profile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfile"}}},"description":"Service / Application profile"},"tags":["Service"]}},"/services/hosted/{servicesID}":{"parameters":[{"schema":{"type":"string"},"name":"servicesID","in":"path","required":true}],"get":{"summary":"Fetch registered Hosted services based on ID","tags":["Service"],"operationId":"get-services-hosted-servicesID","responses":{"200":{"description":"Registered Edge Hosted Services based on services ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedServices"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}}},"put":{"summary":"Update Registered Hosted services based on ID","operationId":"put-services-hosted-servicesID","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedServices"}}}},"responses":{"200":{"description":"Registered Hosted services are updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service"]},"delete":{"summary":"Delete Registered Hosted services based on ID","operationId":"delete-services-hosted-servicesID","responses":{"200":{"description":"Registered Hosted Services are deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service"]}},"/services/hosted":{"post":{"summary":"","operationId":"post-services-hosted","responses":{"200":{"description":"Edge services ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.EdgeServicesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"description":"Create Service/Application profile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.service.EdgeServicesRequest"}}},"description":"Services Hosted on Edge"},"tags":["Service"]}},"/discover/services":{"get":{"operationId":"get-discover-services","parameters":[{"in":"query","name":"density","schema":{"type":"number"},"description":"\nsubscriber density in a region \n"},{"in":"query","name":"region","schema":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionType","type":"string","enum":[]},"description":"Edge locations belong to a geographical or logical region"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"serviceIDs","description":"Array of pre defined services hosted on edge platfomrs"}],"responses":{"200":{"description":"Ordered list of Optimal Edge Service endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedServices"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Discover Optimal Edge Service end points","description":"API to discover optimal Edge service endpoints to connect to"}},"/discover/subscriber/services":{"get":{"operationId":"get-discover-subscriber-services","parameters":[{"in":"query","name":"UEIdentity","schema":{"type":"array","items":{"type":"string"}},"description":"Array of User Identifiers with similar type","required":true},{"in":"query","name":"region","schema":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionType","type":"string","enum":[]},"description":"Edge locations belong to a geographical or logical region"},{"schema":{"type":"array","items":{"type":"string"}},"in":"query","name":"serviceIDs","description":"Array of pre defined services hosted on edge platfomrs","required":true},{"schema":{"type":"string"},"in":"query","name":"UEIdentityType","description":"Edge locations belonging to a geographical or logical region","required":true}],"responses":{"200":{"description":"Ordered list of Optimal Edge Service endpoints based on user Identity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedServices"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Discover Optimal Edge Service end points based on user Identity","description":"API to discover optimal Edge service endpoints to connect to based on User Identity"}},"/regions":{"get":{"summary":"Retrieve list of regions available","responses":{"200":{"description":"List of Regions available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegions"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-regions","description":"Retrieve list of regions available","tags":["Meta"]}},"/events":{"get":{"summary":"Retrieve the names of edge events","responses":{"200":{"description":"List of edge event names","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvents"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-names","description":"Retrieve list of edge event names","tags":["Events"]}},"/events/discover":{"post":{"summary":"Subscribe to notification of changes to specified list of edge events","responses":{"200":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"Edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"operationId":"event-subscription","description":"Subscribe to notification of changes to list of edge events","tags":["Events"]},"parameters":[]},"/events/discover/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true}],"get":{"summary":"Retrieve event notification subscription by subscription ID","responses":{"200":{"description":"Returns a list of events subscribed and the callback URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-subscription","description":"Retrieve event notification subscription by subscription ID","tags":["Events"]},"put":{"summary":"Update event notification subscription by ID","operationId":"update-event-subscription","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]},"delete":{"summary":"Delete event notification subscription by ID","operationId":"delete-event-subscription","responses":{"200":{"description":"Event notification subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]}},"/events/subscriber/edges/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true}],"get":{"summary":"Retrieve event notification subscription by subscription ID","responses":{"200":{"description":"Returns a list of events subscribed and the callback URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.edges"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-subscriber-edges-subscription","description":"Retrieve event notification subscription by subscription ID","tags":["Events"]},"put":{"summary":"Update event notification subscription by ID","operationId":"update-event-subscriber-edges-subscription","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.edges"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]},"delete":{"summary":"Delete event notification subscription by ID","operationId":"delete-event-subscriber-edges-subscription","responses":{"200":{"description":"Event notification subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]}},"/events/discover/edges/profile/{profileID}/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true},{"schema":{"type":"string"},"name":"profileID","in":"path","required":true}],"get":{"summary":"Retrieve event notification subscription by subscription ID","responses":{"200":{"description":"Returns a list of events subscribed and the callback URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.edges.profile"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-discover-edges-profile","description":"Retrieve event notification subscription by subscription ID","tags":["Events"]},"put":{"summary":"Update event notification subscription by ID","operationId":"update-event-discover-edges-profile","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.edges.profile"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]},"delete":{"summary":"Delete event notification subscription by ID","operationId":"delete-event-discover-edges-profile","responses":{"200":{"description":"Event notification subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]}},"/events/discover/services/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true}],"get":{"summary":"Retrieve event notification subscription by subscription ID","responses":{"200":{"description":"Returns a list of events subscribed and the callback URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.services"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-discover-servicess-subscription","description":"Retrieve event notification subscription by subscription ID","tags":["Events"]},"put":{"summary":"Update event notification subscription by ID","operationId":"update-event-discover-servicess-subscription","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.services"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]},"delete":{"summary":"Delete event notification subscription by ID","operationId":"delete-event-discover-servicess-subscription","responses":{"200":{"description":"Event notification subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]}},"/events/discover/subscriber/services/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true}],"get":{"summary":"Retrieve event notification subscription by subscription ID","responses":{"200":{"description":"Returns a list of events subscribed and the callback URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.services"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"operationId":"get-event-discover-subscriber-services-subscription","description":"Retrieve event notification subscription by subscription ID","tags":["Events"]},"put":{"summary":"Update event notification subscription by ID","operationId":"update-event-discover-subscriber-servicess-subscription","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.services"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]},"delete":{"summary":"Delete event notification subscription by ID","operationId":"delete-event-discover-subscriber-servicess-subscription","responses":{"200":{"description":"Event notification subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events"]}},"/events/subscriber/edges":{"post":{"summary":"Subscribe to notification of changes to specified list of edge events","responses":{"200":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.edges"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"Edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"operationId":"post-events-subscriber-edges","description":"Subscribe to notification of changes to list of edge events","tags":["Events"]}},"/events/discover/edges/profile/{profileID}":{"parameters":[{"schema":{"type":"string"},"name":"profileID","in":"path","required":true}],"post":{"summary":"Subscribe to notification of changes to specified list of edge events","responses":{"200":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.edges.profile"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"Edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"operationId":"post-events-discover-edges-profile-profileID","description":"Subscribe to notification of changes to list of edge events","tags":["Events"]}},"/events/discover/services":{"post":{"summary":"Subscribe to notification of changes to specified list of edge events","responses":{"200":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.services"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"Edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"operationId":"post-events-discover-services","description":"Subscribe to notification of changes to list of edge events","tags":["Events"]}},"/events/discover/subscriber/services":{"post":{"summary":"Subscribe to notification of changes to specified list of edge events","responses":{"200":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"5XX":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Subscription.subscriber.services"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"Edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.events.Notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"operationId":"post-events-discover-subscriber-services","description":"Subscribe to notification of changes to list of edge events","tags":["Events"]}}},"components":{"securitySchemes":{"oAuth2":{"type":"oauth2","description":"This API uses OAuth 2 with the implicit, password and client credentials grant flow","flows":{"implicit":{"authorizationUrl":"https://5gff.com/oauth/authorize","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","workloadorchestration:read":"Grant read-only access to Workload Orchestration data","workloadorchestration:write":"Grant write access to Workload Orchestration data"}},"password":{"tokenUrl":"https://5gff.com/oauth/token","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","workloadorchestration:read":"Grant read-only access to Workload Orchestration data","workloadorchestration:write":"Grant write access to Workload Orchestration data"}},"clientCredentials":{"tokenUrl":"https://5gff.com/oauth/token","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","workloadorchestration:read":"Grant read-only access to Workload Orchestration data","workloadorchestration:write":"Grant write access to Workload Orchestration data"}}}}},"schemas":{"edge.5gff.api.errors.Error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]},"edge.5gff.api.common.EdgeServiceMetadata":{"type":"object"},"edge.5gff.api.types.EdgeProperties":{"type":"object","properties":{"type":{"title":"Data type","type":"string"},"data":{"title":"Data value","type":"object"}}},"edge.5gff.api.types.EdgeRegionProperties":{"type":"object","properties":{"type":{"title":"Data type","type":"string"},"data":{"title":"Data value","type":"object"}}},"edge.5gff.api.discovery.EdgeDiscoveryStatus":{"type":"string","default":"found","enum":["Active","Inactive","Unknown"]},"edge.5gff.api.discovery.EdgeHostedService":{"description":"AppPort describes an L4 or L7 public access port/path mapping. This is used to track external to internal mappings for access via a shared load balancer or reverse proxy.","type":"object","properties":{"ern":{"description":"Edge Resource Number","type":"string"},"edgeAppServerId":{"type":"string"},"edgeAppServerEndpoint":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeAppServerEndpoint"},"edgeAppServerProviderId":{"type":"string"},"edgeAppServerDescription":{"type":"string"}}},"edge.5gff.api.discovery.EdgeDiscoveryData":{"type":"object","properties":{"ern":{"title":"Edge Resource Number","type":"string"},"region":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionType"},"status":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryStatus"},"properties":{"title":"Vendor specific data","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeProperties"}},"ttl":{"type":"integer"}},"required":["ern","status"]},"edge.5gff.api.discovery.EdgeDiscoveryResponse":{"type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryData"}},"edge.5gff.api.service.EdgeServiceSubscriberDensity":{"type":"object","properties":{"density":{"type":"number"},"regions":{"type":"array","items":{"type":"string"}}}},"edge.5gff.api.service.EdgeServiceSubscriberLocationChange":{"type":"object","properties":{"subscriberIdentifiers":{"type":"array","items":{"type":"string"}}}},"edge.5gff.api.service.EdgeServiceRequest":{"type":"object","properties":{"edgeHostedService":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedService"},"workloadProfileID":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfileID"}}},"edge.5gff.api.service.EdgeServicesResponse":{"type":"object","properties":{"edgeAppServicesID":{"title":"Edge Resource Number","type":"string"}}},"edge.5gff.api.service.EdgeServiceCreateResponse":{"type":"object","properties":{"ern":{"title":"Edge Resource Number","type":"string"}}},"edge.5gff.api.user.UEIdentity":{"title":"edge.5gff.api.user.UEIdentity","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","example":"192.168.10.1,2001:0db8:85a3:0000:0000:8a2e:0370:7334","enum":["IPAddress","MSISDN","IMEI","MDN","GPSI"]}}},"edge.5gff.api.workload.EdgeWorkloadData":{"title":"edge.5gff.api.workload.EdgeWorkloadData","type":"object","properties":{"ern":{"type":"string"},"region":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionType"},"status":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryStatus"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeProperties"}}}},"edge.5gff.api.workload.EdgeWorkloadResponse":{"type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.workload.EdgeWorkloadData"}},"edge.5gff.api.types.EdgeRegionType":{"type":"string"},"edge.5gff.api.service.WorkloadProfile":{"title":"edge.5gff.api.service.WorkloadProfile","type":"object","properties":{"applicationClientType":{"type":"string","enum":["V2X","ComputerVision","MachineLearning","IoT","Gaming","AR","VR","Analytics","Robotics"],"description":"The category or type of Application Client "},"ecspFilter":{"type":"string","description":"The identity of the preferred Edge Computing Service Provider(s)"},"applicationClientSchedule":{"type":"string","description":"The expected operation schedule of the Application Client (e.g. time windows)"},"applicationClientServiceArea":{"type":"string","description":"The expected location(s) (e.g. route) of the hosting UE during the Application Client's operation schedule. "},"bandwidth":{"type":"integer","description":"Minnimum required connection bandwidth in Kbit/s for the application"},"serviceContinuitySupport":{"type":"boolean","description":"Indicates if service continuity support is required or not for the application."},"requestRate":{"type":"integer","description":"Maximum request rate that the application can handle"},"latency":{"type":"string","description":"Maximum response time or latency that the application can handle\n "},"availability":{"type":"string","description":"Minimum availability required for the server"},"computeResources":{"type":"string","description":"The minimum compute resources required \n"},"gpu":{"type":"string","description":"The minnimum GPU resources required"},"memory":{"type":"string","description":"Minnimum memory required by the application"},"storage":{"type":"string","description":"The maximum storage resource required for Application Clients"},"properties":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeProperties"}},"required":["applicationClientType"]},"edge.5gff.api.service.WorkloadProfileArray":{"type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.service.WorkloadProfile"}},"edge.5gff.api.service.WorkloadProfileID":{"title":"edge.5gff.api.service.WorkloadProfileID","type":"object","properties":{"serviceProfileID":{"type":"string","description":"Service/Application profile ID \n"}}},"edge.5gff.api.discovery.EdgeAppServerEndpoint":{"title":"edge.5gff.api.discovery.EdgeAppServerEndpoint","type":"object","properties":{"uri":{"type":"string","description":"URI of Edge App Server end point if available","format":"uri"},"fqdn":{"type":"string","description":"FQDN of Edge App Server end point if available"},"ipv4Address":{"type":"string","description":"IPv4 Address of Edge App Server end point if available","format":"ipv4"},"ipv6Address":{"type":"string","description":"IPv6 Address of Edge App Server end point if available","format":"ipv6"},"port":{"type":"integer","description":"Port information of Edge App Server end point if IPv4 or IPv6 is mentioned\n"}}},"edge.5gff.api.discovery.EdgeHostedServices":{"title":"edge.5gff.api.discovery.EdgeHostedServices","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeHostedService"}},"edge.5gff.api.service.EdgeServicesRequest":{"title":"edge.5gff.api.service.EdgeServicesRequest","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.service.EdgeServiceRequest"}},"edge.5gff.api.types.EdgeRegion":{"title":"edge.5gff.api.types.EdgeRegion","type":"object","properties":{"id":{"type":"string"},"":{"type":"string"},"properties":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegionProperties"}}},"edge.5gff.api.types.EdgeRegions":{"title":"edge.5gff.api.types.EdgeRegions","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegion"}},"edge.5gff.api.types.EdgeEvent":{"description":"An edge event is a string defined by the service provider to identify the event","type":"string"},"edge.5gff.api.types.EdgeEvents":{"description":"List of edge events","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"edge.5gff.api.events.SubscriptionId":{"description":"Subscription identifier is a string returned by a successful subscription request","type":"string"},"edge.5gff.api.events.Subscription":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications,\nor update an existing subscription. It is also the subscription infomation returned\nfrom querying by subscription identifier\n","type":"object","properties":{"subid":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"},"events":{"description":"Events of interest","type":"array","nullable":false,"items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"callbackUrl":{"description":"Callback URL for sending the subscribed notifications","type":"string","format":"url","nullable":false},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching the filtering criteria","type":"object","nullable":true,"properties":{"regions":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegions"},"density":{"type":"array","items":{"type":"number"}},"serviceProfileId":{"type":"string"}}}}},"edge.5gff.api.events.Subscription.subscriber.edges":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications,\nor update an existing subscription. It is also the subscription infomation returned\nfrom querying by subscription identifier\n","type":"object","properties":{"subid":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"},"events":{"description":"Events of interest","type":"array","nullable":false,"items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"callbackUrl":{"description":"Callback URL for sending the subscribed notifications","type":"string","format":"url","nullable":false},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching the filtering criteria","type":"object","nullable":true,"properties":{"region":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegions"},"UEIdentityType":{"type":"string"},"UEIdentity":{"type":"array","items":{"type":"string"}}}}}},"edge.5gff.api.events.Subscription.edges.profile":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications,\nor update an existing subscription. It is also the subscription infomation returned\nfrom querying by subscription identifier\n","type":"object","properties":{"subid":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"},"events":{"description":"Events of interest","type":"array","nullable":false,"items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"callbackUrl":{"description":"Callback URL for sending the subscribed notifications","type":"string","format":"url","nullable":false},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching the filtering criteria","type":"object","nullable":true,"properties":{"UEIdentityType":{"type":"string"},"UEIdentity":{"type":"array","items":{"type":"string"}}}}},"title":""},"edge.5gff.api.events.Subscription.services":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications,\nor update an existing subscription. It is also the subscription infomation returned\nfrom querying by subscription identifier\n","type":"object","properties":{"subid":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"},"events":{"description":"Events of interest","type":"array","nullable":false,"items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"callbackUrl":{"description":"Callback URL for sending the subscribed notifications","type":"string","format":"url","nullable":false},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching the filtering criteria","type":"object","nullable":true,"properties":{"region":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegions"},"serviceIDs":{"type":"array","items":{"type":"string"}},"density":{"type":"array","items":{"type":"number"}}}}}},"edge.5gff.api.events.Subscription.subscriber.services":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications,\nor update an existing subscription. It is also the subscription infomation returned\nfrom querying by subscription identifier\n","type":"object","properties":{"subid":{"$ref":"#/components/schemas/edge.5gff.api.events.SubscriptionId"},"events":{"description":"Events of interest","type":"array","nullable":false,"items":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"}},"callbackUrl":{"description":"Callback URL for sending the subscribed notifications","type":"string","format":"url","nullable":false},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching the filtering criteria","type":"object","nullable":true,"properties":{"region":{"$ref":"#/components/schemas/edge.5gff.api.types.EdgeRegions"},"UEIdentityType":{"type":"string"},"UEIdentity":{"type":"array","items":{"type":"string"}},"serviceIDs":{"type":"array","items":{"type":"string"}}}}}},"edge.5gff.api.events.Notification":{"description":"Payload data structure of event notofocation","type":"array","items":{"type":"object","properties":{"event":{"description":"The event being notified","$ref":"#/components/schemas/edge.5gff.api.types.EdgeEvent"},"timestamp":{"description":"Timestamp when the event occurred","type":"string","format":"date-time"},"resources":{"description":"The edge resources the event has occurred from","type":"array","items":{"$ref":"#/components/schemas/edge.5gff.api.discovery.EdgeDiscoveryData"}}}}}},"responses":{"BadRequest":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.errors.Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.errors.Error"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.errors.Error"}}}},"Unexpected":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/edge.5gff.api.errors.Error"}}}}}},"security":[{"oAuth2":["edge:discovery:read","edge:serviceprofile:read","edge:serviceprofile:write"]}]}