swagger-client

You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConnectionApi(swagger_client.ApiClient(configuration))
connection_id = 789 # int | ID of the connection that needs to be deleted

try:
    # Delete connection order by ID
    api_instance.delete_connection(connection_id)
except ApiException as e:
    print("Exception when calling ConnectionApi->delete_connection: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.ConnectionApi(swagger_client.ApiClient(configuration))
connection_id = 789 # int | ID of connection that needs to be fetched

try:
    # Find connection by ID
    api_response = api_instance.getconnection_by_id(connection_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectionApi->getconnection_by_id: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.ConnectionApi(swagger_client.ApiClient(configuration))
body = swagger_client.Connection() # Connection | order placed for creating a connection

try:
    # Place an connection request from the SDX-Controller
    api_response = api_instance.place_connection(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectionApi->place_connection: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/SDX-Controller/1.0.0

Class	Method	HTTP request	Description
ConnectionApi	delete_connection	DELETE /connection/{connectionId}	Delete connection order by ID
ConnectionApi	getconnection_by_id	GET /connection/{connectionId}	Find connection by ID
ConnectionApi	place_connection	POST /conection	Place an connection request from the SDX-Controller
LinkApi	get_link	GET /link	get an existing link
NodeApi	get_node	GET /node	get an existing node
TopologyApi	get_topology	GET /topology	get an existing topology
TopologyApi	get_topologyby_version	GET /topology/{version}	Find topology by version
TopologyApi	topology_version	GET /topology/version	Finds topology version
UserApi	create_user	POST /user	Create user
UserApi	create_users_with_array_input	POST /user/createWithArray	Creates list of users with given input array
UserApi	create_users_with_list_input	POST /user/createWithList	Creates list of users with given input array
UserApi	delete_user	DELETE /user/{username}	Delete user
UserApi	get_user_by_name	GET /user/{username}	Get user by user name
UserApi	login_user	GET /user/login	Logs user into the system
UserApi	logout_user	GET /user/logout	Logs out current logged in user session
UserApi	update_user	PUT /user/{username}	Updated user

Documentation For Models

• ApiResponse
• Connection
• Link
• Location
• Node
• Port
• Topology
• User

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

topology_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://0.0.0.0:8080/oauth/dialog
• Scopes:
• write:topology: modify topology in your account
• read:topology: read your topology

Author

[email protected]