Skip to content

Latest commit

 

History

History
221 lines (179 loc) · 11.8 KB

README.md

File metadata and controls

221 lines (179 loc) · 11.8 KB
Raw

openapi-client

Future Vuls Public API

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

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 openapi_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 openapi_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import openapi_client
from pprint import pprint
from openapi_client.api import cve_api
from openapi_client.model.cve_get_cve_detail_response_body import CveGetCveDetailResponseBody
from openapi_client.model.cve_get_cve_list_response_body import CveGetCveListResponseBody
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cve_api.CveApi(api_client)
    cve_id = "cveID_example" # str | Cve ID
    authorization = "Authorization_example" # str | api key auth (optional)

    try:
        # getCveDetail cve
        api_response = api_instance.cve_get_cve_detail(cve_id, authorization=authorization)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling CveApi->cve_get_cve_detail: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://https://rest.vuls.biz

Class Method HTTP request Description
CveApi cve_get_cve_detail GET /v1/cve/{cveID} getCveDetail cve
CveApi cve_get_cve_list GET /v1/cves getCveList cve
HealthApi health_health GET /health health health
LockfileApi lockfile_add_lockfile POST /v1/lockfile addLockfile lockfile
LockfileApi lockfile_delete_lockfile DELETE /v1/lockfile/{lockfileID} deleteLockfile lockfile
LockfileApi lockfile_get_lockfile_detail GET /v1/lockfile/{lockfileID} getLockfileDetail lockfile
LockfileApi lockfile_get_lockfile_list GET /v1/lockfiles getLockfileList lockfile
LockfileApi lockfile_update_lockfile PUT /v1/lockfile/{lockfileID} updateLockfile lockfile
PkgCpeApi pkg_cpe_add_cpe POST /v1/pkgCpe/cpe addCpe pkgCpe
PkgCpeApi pkg_cpe_delete_cpe DELETE /v1/pkgCpe/cpe/{cpeID} deleteCpe pkgCpe
PkgCpeApi pkg_cpe_delete_cpe_deprecated DELETE /v1/pkgCpe/cpe deleteCpe_deprecated pkgCpe
PkgCpeApi pkg_cpe_get_cpe_detail GET /v1/pkgCpe/cpe/{cpeID} getCpeDetail pkgCpe
PkgCpeApi pkg_cpe_get_pkg_cpe_list GET /v1/pkgCpes getPkgCpeList pkgCpe
PkgCpeApi pkg_cpe_get_pkg_detail GET /v1/pkgCpe/pkg/{pkgID} getPkgDetail pkgCpe
RoleApi role_delete_role DELETE /v1/role/{roleID} deleteRole role
RoleApi role_get_role_detail GET /v1/role/{roleID} getRoleDetail role
RoleApi role_get_role_list GET /v1/roles getRoleList role
RoleApi role_update_role PUT /v1/role/{roleID} updateRole role
ServerApi server_create_pkg_paste_server POST /v1/server/paste createPkgPasteServer server
ServerApi server_delete_server DELETE /v1/server/{serverID} deleteServer server
ServerApi server_get_server_detail GET /v1/server/{serverID} getServerDetail server
ServerApi server_get_server_detail_by_uuid GET /v1/server/uuid/{serverUuid} getServerDetailByUUID server
ServerApi server_get_server_list GET /v1/servers getServerList server
ServerApi server_update_pkg_paste_server PUT /v1/server/paste/{serverID} updatePkgPasteServer server
ServerApi server_update_server PUT /v1/server/{serverID} updateServer server
TaskApi task_add_task_comment POST /v1/task/{taskID}/comment addTaskComment task
TaskApi task_get_task_detail GET /v1/task/{taskID} getTaskDetail task
TaskApi task_get_task_list GET /v1/tasks getTaskList task
TaskApi task_update_task PUT /v1/task/{taskID} updateTask task
TaskApi task_update_task_ignore PUT /v1/task/{taskID}/ignore updateTaskIgnore task

Documentation For Models

Documentation For Authorization

api_key_header_Authorization

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

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in openapi_client.apis and openapi_client.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 openapi_client.api.default_api import DefaultApi
  • from openapi_client.model.pet import Pet

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

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