api-documentation.md

layout	permalink	title
page	/api-documentation/	API Documentation

<style> .api-col-right.no-icon:after{ display:none;} </style>

< API Documentation

Select API {% for api_nav in site.data.api_documentation %} {{ api_nav.title }} {% endfor %}

API Documentation

HTTP Rest

{% for api_nav in site.data.api_documentation %}
• {{ api_nav.title }}
{% endfor %}

GRPC

• Edge Lifecycle Management API
• Edge Virtualization Infrastructure API

<script src="/swagger-ui-open/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script> <script src="/swagger-ui-open/swagger-ui-bundle.js"></script> <script src="/swagger-ui-open/swagger-ui-standalone-preset.js"></script> <script type="text/javascript"> var swag_url = "", api_description = ""; swag_url_second = ""; var apiUrl = new URL(window.location.href); apiUrl = apiUrl.searchParams.get("api"); if(apiUrl != null){ //Selected Box $("#program").val(apiUrl); //Switch switch(apiUrl) { case 'eaa': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/eaa/eaa.swagger.json'; api_description = "

Edge Application API

"; api_description += "

Edge Application APIs enable developers to build edge compute services capable of taking advantage of tactile applications that respond to the changing user, network or resource scenarios. In addition, these APIs can also be used to port existing public/private cloud applications to the edge based on Intel® Smart Edge Open.

"; break; case 'controller': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/controller/api.swagger.json'; api_description = "

Controller API

"; api_description += "

Controller APIs enable centralized management of Intel® Smart Edge Open edge nodes, and can be called by a UI frontend or by external orchestrators. The API provides an abstraction layer for an operations admin, enabling them to maintain a list of Intel® Smart Edge Open edge nodes, configure apps, manage policies and DNS, and more.

"; break; case 'auth': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/auth/auth.swagger.json'; api_description = "

Edge Application Authentication API

"; api_description += "

Edge Application Authentication APIs enable authentication of apps that intend to call Edge Application APIs, by validating the identity of the requesting application and issuing it a valid TLS certificate.

"; break; case 'cups': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/cups/cups.swagger.json'; api_description = "

Core Network Configuration API

"; api_description += "

Core Network Configuration APIs enable network configuration operations to be performed, such as configuring the traffic policy for the core network to steer traffic towards the edge nodes.

"; break; case 'af': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/af/af.openapi.yaml'; swag_url_second = 'https://raw.githubusercontent.com/open-ness/specs/master/schema/af/af_pfd.openapi.yaml'; api_description = "

5G APPLICATION FUNCTION (AF)

"; break; case 'nef': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/nef/nef_traffic_influence_openapi.yaml'; swag_url_second = 'https://raw.githubusercontent.com/open-ness/specs/master/schema/nef/nef_pfd_management_openapi.yaml'; api_description = "

5G NETWORK EXPOSURE FUNCTION (NEF)

"; break; case '5goam': swag_url = 'https://raw.githubusercontent.com/smart-edge-open/specs/master/schema/5goam/5goam.swagger.yaml'; api_description = "

5G OAM

"; break; case 'emco': //swag_url = 'https://raw.githubusercontent.com/smart-edge-open/EMCO/main/docs/emco_apis.yaml'; swag_url = 'https://raw.githubusercontent.com/smart-edge-open/EMCO/main/docs/swagger-specs-for-APIs/emco_apis.yaml'; api_description = "

EMCO

"; break; } //Load Description $(".api-description").html(api_description); $(".contentAreaAPI").show(); //Swagger Call if(swag_url != ''){ window.swaggerUi = SwaggerUIBundle({ url: swag_url, dom_id: '#swagger-ui', deepLinking: true, validatorUrl: null, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], layout: "StandaloneLayout" }); } if(swag_url_second != ''){ window.swaggerUi = SwaggerUIBundle({ url: swag_url_second, dom_id: '#swagger-ui-second', deepLinking: true, validatorUrl: null, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], layout: "StandaloneLayout" }); } } $(function(){ $('#program').on('change', function(e){ var program = $(this).val(); program = $.trim(program); if(program != ''){ window.location.href = $('option:selected', this).attr('data-ref'); } }); }); </script>