Skip to main content

The Alert Logic API definitions.

Project description

alertlogic-sdk-definitions

Alert Logic APIs definitions

Build Status PyPI version

Repository contains static definitions of Alert Logic APIs, used for documentation generation, SDK and CLI.

Usage

Install

pip install alertlogic-sdk-definitions

For the one who doesn't require python code, GitHub releases are produced containing an archive with OpenAPI definitions only, see here

Test

python -m unittest

Use

List available service definitions:

>>> import alsdkdefs
>>> alsdkdefs.list_services()
['aefr', 'aerta', 'aetag', 'aetuner', 'aims', 'assets_query', 'credentials', 'deployments', 'ingest', 'iris', 'policies', 'search', 'themis']

Get path to a service definitions paths:

>>> import alsdkdefs
>>> alsdkdefs.get_service_defs("aerta")
['/usr/local/lib/python3.8/site-packages/alsdkdefs/apis/aerta/aerta.v1.yaml']

Quick validation of a definition

While YAML definition is developed apart from the current package and current repo, it is required to validate it prior to push, please add this to your Makefile in order to achieve quick validation:

curl -s https://raw.githubusercontent.com/alertlogic/alertlogic-sdk-definitions/master/scripts/validate_my_definition.sh | bash -s <path/to/definition/yaml>

It is recommended to invoke it via curl, since validation of the definitions might be extended with time. Script requires python3 to be available in the system.

Validation checks:

  • YAML of a definition is valid
  • Definition passes OpenAPI 3 schema validation

Development

Please submit a PR. Please note that API definitions are updated automatically and any changes to it will be overwritten, see: automatic update process

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for alertlogic-sdk-definitions, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size alertlogic_sdk_definitions-0.0.11-py3-none-any.whl (50.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size alertlogic-sdk-definitions-0.0.11.tar.gz (85.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page