nomad_cbec_limit_cli

This is the API descriptor for the Nomad CBEC, responsible for CBEC customer queries. Read the documentation online at Nomad API Suite.

• Install for node with npm install nomad_cbec_cli
• Install for python with pip install nomad-cbec-cli

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.1.1
• Package version: 1.1.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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 nomad_cbec_limit_cli

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 nomad_cbec_limit_cli

Getting Started

Please follow the installation procedure and then run the following:

import time
import nomad_cbec_limit_cli
from pprint import pprint
from nomad_cbec_limit_cli.api import health_api
# Defining the host is optional and defaults to https://nomad.samarkand-global.cn/cbec
# See configuration.py for a list of all supported configuration parameters.
configuration = nomad_cbec_limit_cli.Configuration(
    host = "https://nomad.samarkand-global.cn/cbec"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with nomad_cbec_limit_cli.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = health_api.HealthApi(api_client)
    
    try:
        # health
        api_response = api_instance.get_health()
        pprint(api_response)
    except nomad_cbec_limit_cli.ApiException as e:
        print("Exception when calling HealthApi->get_health: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://nomad.samarkand-global.cn/cbec

Documentation For Models

• ApiResponse
• ApiResponseData

Documentation For Authorization

ApiKeyAuth

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

Author

paul@samarkand.global

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in nomad_cbec_limit_cli.apis and nomad_cbec_limit_cli.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from nomad_cbec_limit_cli.api.default_api import DefaultApi
• from nomad_cbec_limit_cli.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import nomad_cbec_limit_cli
from nomad_cbec_limit_cli.apis import *
from nomad_cbec_limit_cli.models import *