%global _empty_manifest_terminate_build 0 Name: python-alertlogic-sdk-definitions Version: 0.1.114 Release: 1 Summary: The Alert Logic API definitions. License: MIT license URL: https://github.com/alertlogic/alertlogic-sdk-definitions Source0: https://mirrors.nju.edu.cn/pypi/web/packages/16/02/050933978dd9247aea812131bb2cd12acd78f62137b18de69c5487784b2b/alertlogic-sdk-definitions-0.1.114.tar.gz BuildArch: noarch Requires: python3-jsonschema[format_nongpl] Requires: python3-pyyaml Requires: python3-requests Requires: python3-jsonmerge Requires: python3-pytest Requires: python3-mock Requires: python3-httpretty Requires: python3-pycodestyle Requires: python3-jsonmerge %description # Alert Logic APIs definitions [![Build Status](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions.svg?branch=master)](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions) [![PyPI version](https://badge.fury.io/py/alertlogic-sdk-definitions.svg)](https://badge.fury.io/py/alertlogic-sdk-definitions) Repository contains static definitions of Alert Logic APIs, used for documentation generation, [SDK](https://github.com/alertlogic/alertlogic-sdk-python) and [CLI](https://github.com/alertlogic/alcli). ### 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](https://github.com/alertlogic/alertlogic-sdk-definitions/releases) #### 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 ` 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](doc/automatic_releases.md) %package -n python3-alertlogic-sdk-definitions Summary: The Alert Logic API definitions. Provides: python-alertlogic-sdk-definitions BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-alertlogic-sdk-definitions # Alert Logic APIs definitions [![Build Status](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions.svg?branch=master)](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions) [![PyPI version](https://badge.fury.io/py/alertlogic-sdk-definitions.svg)](https://badge.fury.io/py/alertlogic-sdk-definitions) Repository contains static definitions of Alert Logic APIs, used for documentation generation, [SDK](https://github.com/alertlogic/alertlogic-sdk-python) and [CLI](https://github.com/alertlogic/alcli). ### 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](https://github.com/alertlogic/alertlogic-sdk-definitions/releases) #### 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 ` 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](doc/automatic_releases.md) %package help Summary: Development documents and examples for alertlogic-sdk-definitions Provides: python3-alertlogic-sdk-definitions-doc %description help # Alert Logic APIs definitions [![Build Status](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions.svg?branch=master)](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions) [![PyPI version](https://badge.fury.io/py/alertlogic-sdk-definitions.svg)](https://badge.fury.io/py/alertlogic-sdk-definitions) Repository contains static definitions of Alert Logic APIs, used for documentation generation, [SDK](https://github.com/alertlogic/alertlogic-sdk-python) and [CLI](https://github.com/alertlogic/alcli). ### 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](https://github.com/alertlogic/alertlogic-sdk-definitions/releases) #### 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 ` 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](doc/automatic_releases.md) %prep %autosetup -n alertlogic-sdk-definitions-0.1.114 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-alertlogic-sdk-definitions -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Sun Apr 23 2023 Python_Bot - 0.1.114-1 - Package Spec generated