swaggeraem
Swagger AEM is an OpenAPI specification for Adobe Experience Manager (AEM) API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 4.0.0
- Package version: 4.0.0
- Generator version: 7.24.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/shinesolutions
Requirements.
Python 3.10+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/shinesolutions/swagger-aem.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/shinesolutions/swagger-aem.git)
Then import the package:
import swaggeraem
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 swaggeraem
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import swaggeraem
from swaggeraem.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = swaggeraem.Configuration(
host = "http://localhost"
)
# 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: aemAuth
configuration = swaggeraem.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with swaggeraem.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = swaggeraem.ConsoleApi(api_client)
try:
api_response = api_instance.get_aem_product_info()
print("The response of ConsoleApi->get_aem_product_info:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ConsoleApi->get_aem_product_info: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ConsoleApi | get_aem_product_info | GET /system/console/status-productinfo.json | |
| ConsoleApi | get_bundle_info | GET /system/console/bundles/{name}.json | |
| ConsoleApi | get_config_mgr | GET /system/console/configMgr | |
| ConsoleApi | post_bundle | POST /system/console/bundles/{name} | |
| ConsoleApi | post_jmx_repository | POST /system/console/jmx/com.adobe.granite:type=Repository/op/{action} | |
| ConsoleApi | post_saml_configuration | POST /system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler | |
| CqApi | get_login_page | GET /libs/granite/core/content/login.html | |
| CqApi | post_cq_actions | POST /.cqactions.html | |
| CrxApi | get_crxde_status | GET /crx/server/crx.default/jcr:root/.1.json | |
| CrxApi | get_install_status | GET /crx/packmgr/installstatus.jsp | |
| CrxApi | get_package_manager_servlet | GET /crx/packmgr/service/script.html | |
| CrxApi | post_package_service | POST /crx/packmgr/service.jsp | |
| CrxApi | post_package_service_json | POST /crx/packmgr/service/.json/{path} | |
| CrxApi | post_package_update | POST /crx/packmgr/update.jsp | |
| CrxApi | post_set_password | POST /crx/explorer/ui/setpassword.jsp | |
| CustomApi | get_aem_health_check | GET /system/health | |
| CustomApi | post_config_aem_health_check_servlet | POST /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck | |
| CustomApi | post_config_aem_password_reset | POST /apps/system/config/com.shinesolutions.aem.passwordreset.Activator | |
| GraniteApi | ssl_setup | POST /libs/granite/security/post/sslSetup.html | |
| SlingApi | delete_agent | DELETE /etc/replication/agents.{runmode}/{name} | |
| SlingApi | delete_node | DELETE /{path}/{name} | |
| SlingApi | get_agent | GET /etc/replication/agents.{runmode}/{name} | |
| SlingApi | get_agents | GET /etc/replication/agents.{runmode}.-1.json | |
| SlingApi | get_authorizable_keystore | GET /{intermediatePath}/{authorizableId}.ks.json | |
| SlingApi | get_keystore | GET /{intermediatePath}/{authorizableId}/keystore/store.p12 | |
| SlingApi | get_node | GET /{path}/{name} | |
| SlingApi | get_package | GET /etc/packages/{group}/{name}-{version}.zip | |
| SlingApi | get_package_filter | GET /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json | |
| SlingApi | get_query | GET /bin/querybuilder.json | |
| SlingApi | get_truststore | GET /etc/truststore/truststore.p12 | |
| SlingApi | get_truststore_info | GET /libs/granite/security/truststore.json | |
| SlingApi | post_agent | POST /etc/replication/agents.{runmode}/{name} | |
| SlingApi | post_authorizable_keystore | POST /{intermediatePath}/{authorizableId}.ks.html | |
| SlingApi | post_authorizables | POST /libs/granite/security/post/authorizables | |
| SlingApi | post_config_adobe_granite_saml_authentication_handler | POST /apps/system/config/com.adobe.granite.auth.saml.SamlAuthenticationHandler.config | |
| SlingApi | post_config_apache_felix_jetty_based_http_service | POST /apps/system/config/org.apache.felix.http | |
| SlingApi | post_config_apache_http_components_proxy_configuration | POST /apps/system/config/org.apache.http.proxyconfigurator.config | |
| SlingApi | post_config_apache_sling_dav_ex_servlet | POST /apps/system/config/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet | |
| SlingApi | post_config_apache_sling_get_servlet | POST /apps/system/config/org.apache.sling.servlets.get.DefaultGetServlet | |
| SlingApi | post_config_apache_sling_referrer_filter | POST /apps/system/config/org.apache.sling.security.impl.ReferrerFilter | |
| SlingApi | post_config_property | POST /apps/system/config/{configNodeName} | |
| SlingApi | post_node | POST /{path}/{name} | |
| SlingApi | post_node_rw | POST /{path}/{name}.rw.html | |
| SlingApi | post_path | POST /{path}/ | |
| SlingApi | post_query | POST /bin/querybuilder.json | |
| SlingApi | post_tree_activation | POST /libs/replication/treeactivation.html | |
| SlingApi | post_truststore | POST /libs/granite/security/post/truststore | |
| SlingApi | post_truststore_pkcs12 | POST /etc/truststore |
Documentation For Models
- BundleData
- BundleDataProp
- BundleInfo
- InstallStatus
- InstallStatusStatus
- KeystoreChainItems
- KeystoreInfo
- KeystoreItems
- SamlConfigurationInfo
- SamlConfigurationProperties
- SamlConfigurationPropertyItemsArray
- SamlConfigurationPropertyItemsBoolean
- SamlConfigurationPropertyItemsLong
- SamlConfigurationPropertyItemsString
- TruststoreInfo
- TruststoreItems
Documentation For Authorization
Authentication schemes defined for the API:
aemAuth
- Type: HTTP basic authentication
Author
Metadata
Release files for swaggeraem 4.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| swaggeraem-4.0.0.tar.gz | 59.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| swaggeraem-4.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 140.4 kB
Release files / swaggeraem-4.0.0.tar.gz
| Download URL | swaggeraem-4.0.0.tar.gz |
|---|---|
| Size | 59.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4901fb2c27629fa4be6f64bdd611544317de94377c0f267e2fc11951b2af83ec
|
|
BLAKE2b-256 checksum How to use checksums |
cfef0cb89981d81644175c1449143676065a02c8712e3502639cae6a6aef7029
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Release files / swaggeraem-4.0.0-py3-none-any.whl
| Download URL | swaggeraem-4.0.0-py3-none-any.whl |
|---|---|
| Size | 80.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36dbc69fcd8b3c140b4ff0b0ca616687898c4986a8a33f2d870eb51ec161691e
|
|
BLAKE2b-256 checksum How to use checksums |
f36a864129a2479957dc3ae02962efec01aba8a0f202a7f91511b23e38d0ae2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|