Alert Logic APIs definitions
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()
OrderedDict([('aecontent', ServiceDefinition(aecontent)), ('aefr', ServiceDefinition(aefr)), ('aepublish', ServiceDefinition(aepublish)), ('aerta', ServiceDefinition(aerta)), ('aetag', ServiceDefinition(aetag)), ('aetuner', ServiceDefinition(aetuner)), ('aims', ServiceDefinition(aims)), ('assets_query', ServiceDefinition(assets_query)), ('assets_write', ServiceDefinition(assets_write)), ('connectors', ServiceDefinition(connectors)), ('credentials', ServiceDefinition(credentials)), ('deployments', ServiceDefinition(deployments)), ('herald', ServiceDefinition(herald)), ('ingest', ServiceDefinition(ingest)), ('iris', ServiceDefinition(iris)), ('kalm', ServiceDefinition(kalm)), ('notify', ServiceDefinition(notify)), ('otis', ServiceDefinition(otis)), ('policies', ServiceDefinition(policies)), ('remediations', ServiceDefinition(remediations)), ('responder', ServiceDefinition(responder)), ('search', ServiceDefinition(search)), ('subscriptions', ServiceDefinition(subscriptions)), ('themis', ServiceDefinition(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']
Get normalised service spec of a service(all refs resolved, path parameters moved to the methods, allOfs are merged if possible):
>>> import alsdkdefs
>>> alsdkdefs.load_service_spec("aerta")
Validate service spec:
>>> import alsdkdefs
>>> service_spec = alsdkdefs.load_service_spec("aerta")
>>> alsdkdefs.validate(service_spec)
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/definitions/directory>
If no directory is specified, by default doc/openapi/ directory will be used, if such behaviour is desired, use following line instead:
curl -s https://raw.githubusercontent.com/alertlogic/alertlogic-sdk-definitions/master/scripts/validate_my_definition.sh | bash
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
1 maintainer
Metadata
1 maintainer
Release files for alertlogic-sdk-definitions 0.1.168
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| alertlogic_sdk_definitions-0.1.168.tar.gz | 1.6 MB | Without provenance | Details for alertlogic_sdk_definitions-0.1.168.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alertlogic_sdk_definitions-0.1.168-py3-none-any.whl | Python 3 | none | any | Details for alertlogic_sdk_definitions-0.1.168-py3-none-any.whl |
Total release size: 3.2 MB
Release files / alertlogic_sdk_definitions-0.1.168.tar.gz
| Download URL | alertlogic_sdk_definitions-0.1.168.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9cdd222c2eb5ff36fc7c81ee6d7e28589b987fcb525964ab7849196aa2dd8feb
|
|
BLAKE2b-256 checksum How to use checksums |
093f4d8cf7fb6296d2417e81bb96784c2923bf20cdaf731d3b54447cbade6a42
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.15.0
|
Release files / alertlogic_sdk_definitions-0.1.168-py3-none-any.whl
| Download URL | alertlogic_sdk_definitions-0.1.168-py3-none-any.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce86b29db040835f6bf39281fe8a135c69c8367e3ad1fffb8cbabfc0e692f250
|
|
BLAKE2b-256 checksum How to use checksums |
133497dfc95ebfa771771e9852852289f10658f48d40a6d5c03e4c32c2fd3449
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.15.0
|
Security for alertlogic-sdk-definitions 0.1.168
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
