# ossindex-api-client
This documents the available APIs into [Sonatype OSS Index](https://ossindex.sonatype.org/) - API Version: 1-SNAPSHOT (be72c8343baab38a8c598d28dafc78003dce81db).
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 2024.323
- Package version: 1.0.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/sonatype-nexus-community](https://github.com/sonatype-nexus-community)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/sonatype-nexus-community/ossindex-api-client.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sonatype-nexus-community/ossindex-api-client.git`)
Then import the package:
```python
import ossindex_api_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import ossindex_api_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import ossindex_api_client
from ossindex_api_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://ossindex.sonatype.org
# See configuration.py for a list of all supported configuration parameters.
configuration = ossindex_api_client.Configuration(
host = "https://ossindex.sonatype.org"
)
# 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 HTTP basic authorization: apiToken
configuration = ossindex_api_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure HTTP basic authorization: basicAuth
configuration = ossindex_api_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with ossindex_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ossindex_api_client.ComponentVulnerabilityReportsApi(api_client)
body = ossindex_api_client.ComponentReportRequest() # ComponentReportRequest | (optional)
try:
# Request vulnerability reports for components
api_response = api_instance.post(body=body)
print("The response of ComponentVulnerabilityReportsApi->post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ComponentVulnerabilityReportsApi->post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://ossindex.sonatype.org*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ComponentVulnerabilityReportsApi* | [**post**](docs/ComponentVulnerabilityReportsApi.md#post) | **POST** /api/v3/component-report | Request vulnerability reports for components
*ComponentVulnerabilityReportsApi* | [**post1**](docs/ComponentVulnerabilityReportsApi.md#post1) | **POST** /api/v3/authorized/component-report | Request vulnerability reports for components
*VersionApi* | [**get**](docs/VersionApi.md#get) | **GET** /api/v3/version | Get service version information
## Documentation For Models
- [ComponentReport](docs/ComponentReport.md)
- [ComponentReportRequest](docs/ComponentReportRequest.md)
- [ComponentReportVulnerability](docs/ComponentReportVulnerability.md)
- [Version](docs/Version.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="apiToken"></a>
### apiToken
- **Type**: HTTP basic authentication
<a id="basicAuth"></a>
### basicAuth
- **Type**: HTTP basic authentication
## Author
community@sonatype.com
Raw data
{
"_id": null,
"home_page": "https://github.com/sonatype-nexus-community/ossindex-api-client",
"name": "ossindex_api_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Sonatype OSS Index",
"author": "Sonatype Community Maintainers",
"author_email": "community@sonatype.com",
"download_url": "https://files.pythonhosted.org/packages/a1/6d/174f22ca0e5ec3f894d91819f61730b35fb0378cb2d37932dff8d927ec49/ossindex_api_client-2024.323.1.tar.gz",
"platform": null,
"description": "# ossindex-api-client\nThis documents the available APIs into [Sonatype OSS Index](https://ossindex.sonatype.org/) - API Version: 1-SNAPSHOT (be72c8343baab38a8c598d28dafc78003dce81db).\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2024.323\n- Package version: 1.0.0\n- Generator version: 7.9.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://github.com/sonatype-nexus-community](https://github.com/sonatype-nexus-community)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/sonatype-nexus-community/ossindex-api-client.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sonatype-nexus-community/ossindex-api-client.git`)\n\nThen import the package:\n```python\nimport ossindex_api_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport ossindex_api_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport ossindex_api_client\nfrom ossindex_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://ossindex.sonatype.org\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = ossindex_api_client.Configuration(\n host = \"https://ossindex.sonatype.org\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure HTTP basic authorization: apiToken\nconfiguration = ossindex_api_client.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n# Configure HTTP basic authorization: basicAuth\nconfiguration = ossindex_api_client.Configuration(\n username = os.environ[\"USERNAME\"],\n password = os.environ[\"PASSWORD\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith ossindex_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = ossindex_api_client.ComponentVulnerabilityReportsApi(api_client)\n body = ossindex_api_client.ComponentReportRequest() # ComponentReportRequest | (optional)\n\n try:\n # Request vulnerability reports for components\n api_response = api_instance.post(body=body)\n print(\"The response of ComponentVulnerabilityReportsApi->post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ComponentVulnerabilityReportsApi->post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://ossindex.sonatype.org*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ComponentVulnerabilityReportsApi* | [**post**](docs/ComponentVulnerabilityReportsApi.md#post) | **POST** /api/v3/component-report | Request vulnerability reports for components\n*ComponentVulnerabilityReportsApi* | [**post1**](docs/ComponentVulnerabilityReportsApi.md#post1) | **POST** /api/v3/authorized/component-report | Request vulnerability reports for components\n*VersionApi* | [**get**](docs/VersionApi.md#get) | **GET** /api/v3/version | Get service version information\n\n\n## Documentation For Models\n\n - [ComponentReport](docs/ComponentReport.md)\n - [ComponentReportRequest](docs/ComponentReportRequest.md)\n - [ComponentReportVulnerability](docs/ComponentReportVulnerability.md)\n - [Version](docs/Version.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"apiToken\"></a>\n### apiToken\n\n- **Type**: HTTP basic authentication\n\n<a id=\"basicAuth\"></a>\n### basicAuth\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\ncommunity@sonatype.com\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Sonatype OSS Index",
"version": "2024.323.1",
"project_urls": {
"Homepage": "https://github.com/sonatype-nexus-community/ossindex-api-client",
"Repository": "https://github.com/sonatype-nexus-community/ossindex-api-client"
},
"split_keywords": [
"openapi",
" openapi-generator",
" sonatype oss index"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a54ee5f142b91cbdfa1813f27af6e13dffa275c493a4ef4bb97f2792749991df",
"md5": "a19665776d9b53dd7e3f02ae156f4c72",
"sha256": "cc2ecfd157f778a657ed79582ade06818d69236f487c6176fff42dca10f19495"
},
"downloads": -1,
"filename": "ossindex_api_client-2024.323.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a19665776d9b53dd7e3f02ae156f4c72",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 30617,
"upload_time": "2024-11-18T13:47:45",
"upload_time_iso_8601": "2024-11-18T13:47:45.378539Z",
"url": "https://files.pythonhosted.org/packages/a5/4e/e5f142b91cbdfa1813f27af6e13dffa275c493a4ef4bb97f2792749991df/ossindex_api_client-2024.323.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a16d174f22ca0e5ec3f894d91819f61730b35fb0378cb2d37932dff8d927ec49",
"md5": "25fdbf9ed979f612f795d1172e4859a4",
"sha256": "e45ea5bc7f03492905924fd40ec37bb77afd8ea28bfbb96bed2f5719a73042bf"
},
"downloads": -1,
"filename": "ossindex_api_client-2024.323.1.tar.gz",
"has_sig": false,
"md5_digest": "25fdbf9ed979f612f795d1172e4859a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21413,
"upload_time": "2024-11-18T13:47:47",
"upload_time_iso_8601": "2024-11-18T13:47:47.243015Z",
"url": "https://files.pythonhosted.org/packages/a1/6d/174f22ca0e5ec3f894d91819f61730b35fb0378cb2d37932dff8d927ec49/ossindex_api_client-2024.323.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 13:47:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sonatype-nexus-community",
"github_project": "ossindex-api-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ossindex_api_client"
}
JSON
