node-swagger-aem

node-swagger-aem

NodeSwaggerAem - JavaScript client for node-swagger-aem Swagger AEM is an OpenAPI specification for Adobe Experience Manager (AEM) API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.2.0-pre.0
• Package version: 0.9.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://shinesolutions.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install node-swagger-aem --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your node-swagger-aem from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('node-swagger-aem') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/shinesolutions/swagger-aem then install it via:

    npm install shinesolutions/swagger-aem --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var NodeSwaggerAem = require('node-swagger-aem');

var defaultClient = NodeSwaggerAem.ApiClient.instance;

// Configure HTTP basic authorization: aemAuth
var aemAuth = defaultClient.authentications['aemAuth'];
aemAuth.username = 'YOUR USERNAME'
aemAuth.password = 'YOUR PASSWORD'

var api = new NodeSwaggerAem.ConsoleApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAemProductInfo(callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
NodeSwaggerAem.ConsoleApi	getAemProductInfo	GET /system/console/status-productinfo.json
NodeSwaggerAem.ConsoleApi	getConfigMgr	GET /system/console/configMgr
NodeSwaggerAem.ConsoleApi	postBundle	POST /system/console/bundles/{name}
NodeSwaggerAem.ConsoleApi	postJmxRepository	POST /system/console/jmx/com.adobe.granite:type=Repository/op/{action}
NodeSwaggerAem.ConsoleApi	postSamlConfiguration	POST /system/console/configMgr/com.adobe.granite.auth.saml.SamlAuthenticationHandler
NodeSwaggerAem.CqApi	getLoginPage	GET /libs/granite/core/content/login.html
NodeSwaggerAem.CqApi	postCqActions	POST /.cqactions.html
NodeSwaggerAem.CrxApi	getCrxdeStatus	GET /crx/server/crx.default/jcr:root/.1.json
NodeSwaggerAem.CrxApi	getInstallStatus	GET /crx/packmgr/installstatus.jsp
NodeSwaggerAem.CrxApi	getPackageManagerServlet	GET /crx/packmgr/service/script.html
NodeSwaggerAem.CrxApi	postPackageService	POST /crx/packmgr/service.jsp
NodeSwaggerAem.CrxApi	postPackageServiceJson	POST /crx/packmgr/service/.json/{path}
NodeSwaggerAem.CrxApi	postPackageUpdate	POST /crx/packmgr/update.jsp
NodeSwaggerAem.CrxApi	postSetPassword	POST /crx/explorer/ui/setpassword.jsp
NodeSwaggerAem.CustomApi	getAemHealthCheck	GET /system/health
NodeSwaggerAem.CustomApi	postConfigAemHealthCheckServlet	POST /apps/system/config/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck
NodeSwaggerAem.CustomApi	postConfigAemPasswordReset	POST /apps/system/config/com.shinesolutions.aem.passwordreset.Activator
NodeSwaggerAem.SlingApi	deleteAgent	DELETE /etc/replication/agents.{runmode}/{name}
NodeSwaggerAem.SlingApi	deleteNode	DELETE /{path}/{name}
NodeSwaggerAem.SlingApi	getAgent	GET /etc/replication/agents.{runmode}/{name}
NodeSwaggerAem.SlingApi	getAgents	GET /etc/replication/agents.{runmode}.-1.json
NodeSwaggerAem.SlingApi	getAuthorizableKeystore	GET /{intermediatePath}/{authorizableId}.ks.json
NodeSwaggerAem.SlingApi	getKeystore	GET /{intermediatePath}/{authorizableId}/keystore/store.p12
NodeSwaggerAem.SlingApi	getNode	GET /{path}/{name}
NodeSwaggerAem.SlingApi	getPackage	GET /etc/packages/{group}/{name}-{version}.zip
NodeSwaggerAem.SlingApi	getPackageFilter	GET /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json
NodeSwaggerAem.SlingApi	getQuery	GET /bin/querybuilder.json
NodeSwaggerAem.SlingApi	getTruststore	GET /etc/truststore/truststore.p12
NodeSwaggerAem.SlingApi	getTruststoreInfo	GET /libs/granite/security/truststore.json
NodeSwaggerAem.SlingApi	postAgent	POST /etc/replication/agents.{runmode}/{name}
NodeSwaggerAem.SlingApi	postAuthorizableKeystore	POST /{intermediatePath}/{authorizableId}.ks.html
NodeSwaggerAem.SlingApi	postAuthorizables	POST /libs/granite/security/post/authorizables
NodeSwaggerAem.SlingApi	postConfigAdobeGraniteSamlAuthenticationHandler	POST /apps/system/config/com.adobe.granite.auth.saml.SamlAuthenticationHandler.config
NodeSwaggerAem.SlingApi	postConfigApacheFelixJettyBasedHttpService	POST /apps/system/config/org.apache.felix.http
NodeSwaggerAem.SlingApi	postConfigApacheHttpComponentsProxyConfiguration	POST /apps/system/config/org.apache.http.proxyconfigurator.config
NodeSwaggerAem.SlingApi	postConfigApacheSlingDavExServlet	POST /apps/system/config/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet
NodeSwaggerAem.SlingApi	postConfigApacheSlingGetServlet	POST /apps/system/config/org.apache.sling.servlets.get.DefaultGetServlet
NodeSwaggerAem.SlingApi	postConfigApacheSlingReferrerFilter	POST /apps/system/config/org.apache.sling.security.impl.ReferrerFilter
NodeSwaggerAem.SlingApi	postNode	POST /{path}/{name}
NodeSwaggerAem.SlingApi	postNodeRw	POST /{path}/{name}.rw.html
NodeSwaggerAem.SlingApi	postPath	POST /{path}/
NodeSwaggerAem.SlingApi	postQuery	POST /bin/querybuilder.json
NodeSwaggerAem.SlingApi	postTreeActivation	POST /etc/replication/treeactivation.html
NodeSwaggerAem.SlingApi	postTruststore	POST /libs/granite/security/post/truststore
NodeSwaggerAem.SlingApi	postTruststorePKCS12	POST /etc/truststore

Documentation for Models

• NodeSwaggerAem.InstallStatus
• NodeSwaggerAem.InstallStatusStatus
• NodeSwaggerAem.KeystoreChainItems
• NodeSwaggerAem.KeystoreInfo
• NodeSwaggerAem.KeystoreItems
• NodeSwaggerAem.SamlConfigurationInfo
• NodeSwaggerAem.SamlConfigurationProperties
• NodeSwaggerAem.SamlConfigurationPropertyItemsArray
• NodeSwaggerAem.SamlConfigurationPropertyItemsBoolean
• NodeSwaggerAem.SamlConfigurationPropertyItemsLong
• NodeSwaggerAem.SamlConfigurationPropertyItemsString
• NodeSwaggerAem.TruststoreInfo
• NodeSwaggerAem.TruststoreItems

Documentation for Authorization

aemAuth

• Type: HTTP basic authentication