wso2 / docs-apim

WSO2 API Manager Documentation

---

Contributing to WSO2 API-M documentation

As an open source project, WSO2 API-M welcomes contributions from the community. To start contributing, read these contribution guidelines for information on how you should go about contributing to our project.

1. Accept the Contributor License Agreement (CLA)

   You need to Accept the Contributor License Agreement (CLA) when prompted by a GitHub email notification after sending your first Pull Request (PR). Subsequent PRs will not require CLA acceptance.

   If the CLA gets changed for some (unlikely) reason, you will be presented with the new CLA text after sending your first PR after the change.

2. Fork this repository, make your changes, and send in a pull request (PR). Make sure you are contributing to the correct branch (for example, if your change is relevant to WSO2 API-M 3.2.0 documentation, you should commit your changes to the 3.2.0 branch).

3. Send multiple pull requests to all the relevant branches.

   If your change is relevant to the latest API-M release, please send your change to the respective latest API-M release branch and the master branch, which is the upcoming API-M release documentation branch, as well.

   For example, if the latest API-M release is 3.2.0, and if your change is relevant to API-M 3.2.0, 3.1.0, and 3.0.0, send PRs to the 3.0.0, 3.1.0, 3.2.0, and the master branches.

Check the issue tracker for open issues that interest you. We look forward to receiving your contributions.

Run the project locally

Step 1 - Install Python

MacOS

If you are using MacOS, you probably already have a version of Python installed on your machine. You can verify this by running the following command.

$ python --version
Python 2.7.2

If your version of Python is Python 2.x.x, you also need to install Python3. This is because the PDF plugin only supports Python3. Follow the instructions in this guide to install Python3 properly.

Once you are done, you will have two versions of Python on your machine; a version of python2 and a version of python3.

Ubuntu and other versions of Debian Linux

Python 3 is pre-installed in these versions, which you can verify with python3 -V. Use sudo apt install -y python3-pip to install pip and verify with pip3 -V.

Step 2 - Install Pip

INFO

If pip is not already installed on your machine, download get-pip.py to install pip for the first time. Then run the following command to install it:

$ python get-pip.py

Pip is most likely installed by default. However, you may need to upgrade pip to the latest version:

$ pip install --upgrade pip

Step 3 - Install the pip packages

Follow the steps below to clone the API-M documentation GitHub repository and to run the site on your local server.

1. Fork the GitHub repository: https://github.com/wso2/docs-apim.git

2. Navigate to the place where you want to clone the repo.

   Git clone the forked repository.

   $ git clone https://github.com/[git-username]/docs-apim.git

3. Navigate to the folder containing the repo that you cloned in step 3.2 on a terminal window.

   For example:

   $ cd docs-apim/<Language-folder>/

   $ cd docs-apim/en/

4. Install the required pip packages.

   This will install MkDocs and the required theme, extensions, and plugins.

   • If you are using Python2, use the following command:

     $ pip install -r requirements.txt

   • If you are using Python3, use the following command:

     $ pip3 install -r requirements.txt

Step 4 - Run MkDocs

1. Run the following command to start the server and view the site on your local server.

   $ python3 -m mkdocs serve

   NOTE:

   If you are making changes and want to see them on the fly, run the following command to start the server and view the site on your local server.

   1. Navigate to the mkdocs.yml file.

   2. Change the following configuration to false as shown below.

      #Breaks build if there's a warning
      strict: false
      

   3. Run the following command to start the server and to make the server load only the changed items and display the changes faster.

      python3 -m mkdocs serve --dirtyreload

2. Open the following URL on a new browser window to view the API-M documentation site locally.

   http://localhost:8000/getting-started/overview/

NOTE:

If you were running the mkdocs serve --dirtyreload command to run the MkDocs server, make sure to change the configuration in the mkdocs.yml file as follows before sending a pull request.

strict: true

License

Licenses this source under the Apache License, Version 2.0 (LICENSE), You may not use this file except in compliance with the License.

docs-apim's Issues

Point docs to respective databse configuring pages

Description:
In [1] under "Changing the Carbon Database" section we have provided links to different db configurations. But ones clicked on them it directs to [2]. Can we point them to the respective db config page instead?

[1] https://docs.wso2.com/display/AM2xx/Product+Administration#ProductAdministration-Database
[2] https://docs.wso2.com/display/ADMIN44x/Changing+the+Carbon+Database

Suggested Labels:
docs, apim 2xx

[Doc] APIM 3.0.0 Document search option doesnt prompt the latest Doc versions

Search Functionality in the right upper corner of the APIM 3.0.0 Doc does not prompt the latest doc versions.

Specify how to trace the audit logs in a clustered environment.

Description:
Document: Working with Audit Logs
API manager has clustering patterns. Explain in those specific clustered environments how to trace these audit logs.

Suggested Labels:
Type/Docs
Severity/Major
Priority/Normal

Suggested Assignees:
N/A

Affected Product Version:
apim 2.1.0 update 6

Please include some guideline of minimal resources required for multi regional distributed setup.

Description:
It's better if we can have a guild-line in the document what are minimal requirement of resources needed for a multi regional setup.
Number of Traffic managers
Number of analytic nodes.
Number of gateway and keymager

Suggested Labels:
Type/Docs
Type/Improvement
Severity/Critical
Priority/High

[Documentation] Need to include the expected content of sslprofiles.xml in uploading certificates through UI

Description:
In [1], we have not mentioned about that we expect the entry with * for Servers need to be included in sslprofiles.xml file. If customer adds some other entries for that file, this feature will not work.

[1] https://docs.wso2.com/display/AM210/Dynamic+SSL+Certificate+Installation

Suggested Labels:
Bug, docs

Suggested Assignees:
N/A

Affected Product Version: APIM wum updated

OS, DB, other environment details and versions: Ubuntu

Steps to reproduce:
N/A

Related Issues:
N/A

[AM220] [Doc] Update the outdated image under Deploy and Test as a Prototype

Label
AM 2.2.0
Product wso2am-2.1.0-update4

Refer to link [2]. Update the image under step 6 as in [1] to match the current product version.
[1]. api-image.png
[2]. https://docs.wso2.com/display/AM2xx/Deploy+and+Test+as+a+Prototype

Document should be included which explains how the JWT token will be generated using a specific algorithm and that can be validated in the backend

Description:
Document should be included which explains how the JWT token will be generated using a specific algorithm and that can be validated in the backend

Suggested Labels:
JWT

Suggested Assignees:

Affected Product Version:
2.1.0

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:
Refer this blog post [1]

[1] http://xacmlinfo.org/2015/03/19/validate-and-process-jwt-tokens-with-java/

Specify why it has been used 'deny-unless-permit' in XACML policy creation in particular example

Description:
Document: Enabling Role-Based Access Control Using XACML
Section: Enabling role-based access control
Step 7b

Specify why it has been used deny-unless-permit as the Rule Combining algorithm in this example.

Suggested Labels:
Type/Docs
Priority/High
Severity/Major

Suggested Assignees:
N/A

Affected Product Version:
AM2xx docs

Specify what is going to be achieved by creating this specific xacml policy

Description:
Document: Enabling Role-Based Access Control Using XACML
Section: Enabling role-based access control
Step 6

Provide a description what will this policy does and what would be the expected behavior before creating it in order to get a clear idea to the user.

Suggested Labels:
Type/Docs
Severity/Major
Priority/Normal

Suggested Assignees:
N/A

Affected Product Version:
AM2xx docs

Provide hyperlink for "Setting up the Physical Database"

Description:
In [1] under "Changing the default database" section provide a hyperlink to "Setting up the Physical Database" similar to "Changing the Carbon Database" hyperlink which is just below.

[1] https://docs.wso2.com/display/AM2xx/Product+Administration#ProductAdministration-Database

Suggested Labels:
docs, apim 2xx, Improvement

Specify the need of jndi.properties file while maintaining Logins and Passwords.

Description:
Document: Maintaining Logins and Passwords
Section: Changing the super admin credentials

• Explain the use of jndi.properties file in this context.
• It has not been provided if any changes need to be done in that file. If so, please specify.
• Explain what does following lines do.

connectionfactory.TopicConnectionFactory = amqp://admin:admin@clientid/carbon?brokerlist='tcp://localhost:5672'
connectionfactory.QueueConnectionFactory = amqp://admin:admin@clientID/test?brokerlist='tcp://localhost:5672'

Suggested Labels:
Type/Docs
Severity/Major
Priority/Normal

Suggested Assignees:
N/A

Affected Product Version:
apim2xx docs

[Docs] Add a note to "Stopping server" section from Ctrl +c from docs

Description:
In [1] we have provided the option to stop the server in ctrl +c but if we configure apim with analytics and do so we might encounter with [2]. So, it's better to note on the same in an ideal way so that first-time users will have a smooth shutdown flow.

[1] https://docs.wso2.com/display/AM210/Running+the+Product
[2] wso2/product-apim#1891

Suggested Labels:
Bug, Docs, Priority/High

Few hyperlinks are not pointing to the correct "Setting up" database page

Description:
In [1] "Changing the default database" section, the "Setting up the Physical Database" has hyperlinks for various databases. Few of them does not point to the exact page but to the common setting up page. e.g- IBM DB2, MySQL. Please add the correct hyperlink for the respective setting up db pages.

[1] https://docs.wso2.com/display/AM2xx/Product+Administration#ProductAdministration-Database

Suggested Labels:
docs, apim 2xx

ExtensionHandlerPosition is read from tenant-conf.json

In [1] it states that the ExtensionHandlerPosition is read from the api-manager.xml but in APIM 2.0.0 this respective config has been moved to tenant-conf.json in <APIM_PRODUCT_HOME>/repository/resources. Please update the document so that the newer config will be reflected.

[1] https://docs.wso2.com/display/AM200/Writing+Custom+Handlers

Document Application Lifecycle in Sync with Application Import-Export

Description:
Application Lifecycle it not documented atm. Need to document this in line with the Application Import-Export feature for 2.2.0.

Suggested Labels:
2.2.0
Type/Task
Type/Docs

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

[APIM300]Provide a doc to create users with specific permissions

Description:
Provide a doc for Managing users and roles with specific permissions.

Affected Product Version:
APIM300

Explain the ability to distinguish between internal, partner and public use of APIs via Audit Logs

Description:
Document: Working with Audit Logs
Please explain the ability to distinguish between internal, partner and public use of APIs via Audit Logs

Suggested Labels:
Type/Docs
Severity/Major
Priority/High

Suggested Assignees:
N/A

Affected Product Version:
apim2xx docs

Need to alter the information on "Distributed Deployment of API Manager" page

Description:
Under ->Step 3.2 - Configure the API Publisher in [1] ->Step 02 describe only the Gateway configuration.
There we have to change the url as well. But in the steps we are not mentioning it. Therefore we could easily missed this step.

[1] https://docs.wso2.com/display/AM210/Distributed+Deployment+of+API+Manager

Suggested Labels:
Type/Bug
Type/Docs
Severity/Major
Priority/Normal
Affected/2.2.0

Mention that we need to enable JIT Provisioning in working with SSO API Store from Social Media

Suggested Labels
APIM 2.2.0
Type/Docs
Priority/High
Severity/Major

Description
Refer to doc [1]. Under the topic Facebook login with identity server we need to mention that JIT Provisioning should be enabled from the IDP side. This is not mentioned in [1]
For example, if we recently added a user, we don't need to manually create the user in the Identity Server. When they log in with single sign-on, their account is automatically created for them, eliminating the time and effort related to creating the account. Just-in-Time provisioning works with the identity provider to pass the correct user information to the Identity Server.

Refer to the article [2]. As mentioned in this article please include this information in the APIM doc [1] as well.
[1]. https://docs.wso2.com/display/AM2xx/Log+in+to+the+API+Store+using+Social+Media
[2]. https://wso2.com/library/articles/2016/02/article-how-to-setup-a-wso2-api-manager-store-login-with-google/

Please remove the unwanted links from remote server url from "Configuring WSO2 Identity Server as a Key Manager" page

Description:

1. Please remove the link of remoteserver attribute from remoteInstance config in [1].
2. Those are redirected to invalid pages.

[1] https://docs.wso2.com/display/AM210/Configuring+WSO2+Identity+Server+as+a+Key+Manager

Suggested Labels:
Type/Docs
Type/Bug
Severity/Major
Priority/Normal
Affected/2.2.0

Please include information related to handing analytics and throttling in geographical regions

Description:
In [1], we can find how we can publish apis in multi regional gateway environments.
Likewise please include what configuration do we need to do in

• analytics for different geographical regions
• traffic manager for different geographical regions.

If it's same as distributed deployment configuration, please mentioned in the document.

[1]https://docs.wso2.com/display/AM2xx/Maintaining+Separate+Production+and+Sandbox+Gateways

Suggested Labels:
Type/Docs
Severity/Critical
Priority/High

Affected Product Version:
WSO2 APIM 2.2.0 Update 8

Document the relevant admin services for api manager

To use api manager functionalities some admin services are needed to be invoked. [1] is an example where the RemoteTenantManager admin service will be used to create tenants. It would be really useful for the developer to know what fields are mandatory and what fields are not. Hence a proper documentation on related admin services will be beneficial for the user.

Please include information on what is being logged for audit logs when using admin console

Currently in [1] the actions which are logged for audit.log when using /admin console is not mentioned. Please include the relevant information as a user will want to know what is being logged for /admin console for auditing purposes.

[1] https://docs.wso2.com/display/AM2xx/Working+with+Audit+Logs

Explain why we need to create jaas.conf file when configuring Kerberos

Description:
Document: Kerberos OAuth2 Grant
Section: Configuring Kerberos Grant with API Manager
Explain why step 4 needs to be done.

Suggested Labels:
Type/Docs
Severity/Major
Priority/Normal

Suggested Assignees:
N/A

Affected Product Version:
apim2xx docs

Invoking the Endpoint - Kerberos OAuth2 Grant

Description:
Document: Kerberos OAuth2 Grant
Section: Configuring Kerberos Grant with API Manager
Step 8

curl -v -X POST -H "Authorization: Basic :" -k -d "grant_type=kerberos&kerberos_realm=&kerberos_token=&scope=" -H "Content-Type:application/x-www-form-urlencoded" https://localhost:8243/token

Explain how to get these values:

• kerberos-realm
• kerberos-token
• scope

Suggested Labels:
Type/Docs
Severity/Major
Priority/High

Suggested Assignees:
N/A

Affected Product Version:
AM2xx docs

[Doc] [apim-kubernetes] deploying apim kubernetes doc page should be more descriptive for relevant sections as below

Description:
I was trying out apim-kubernetes deployment with pattern-1, with referring [1] and [2]. But as $subject I could not understand clearly for below steps:
Step 3. Copy the Images into Kubernetes/Openshift nodes or to a Registry. Copy the required Docker images over to the Kubernetes Nodes.
What does these steps means? Steps 1&2 explains pulling docker image and build those only, there after step 3 asking me to copy those images to kubernetes nodes.
Sp do I need to have spawned openstack instance and kubernetes cluster prior to do this step?

Suggested Labels:
apim-2.1.0
kubernetes-apim-2.1.0.1
Type/documentation
Type/improvement
Priority/highest

Affected Product Version:
apim-2.1.0
kubernetes-apim-2.1.0.1

OS, DB, other environment details and versions:

Steps to reproduce:
[1] [https://docs.wso2.com/display/AM210/Deploying+API+Manager+with+Kubernetes+or+OpenShift+Resources]
[2] [https://github.com/wso2/kubernetes-apim/blob/master/README.md]

[Doc] [2.1.0] Add all possible values that can be used in the RESTful API

Saneth reported as follows:
It is useful for the users if we can include all possible values that can be used in the RESTful API for WSO2 API Manager 210[1]

As an example;
In "Add a Blocking condition" scenario [2], we have an example of blacklisting an IP address[3],
but we are missing here what are there other possible values(types) we can use for "conditionType".
If we can include the other supportive "conditionType"s it will increase the usability of this doc.
We need to consider this in all the APIs in this DOC

[1] https://docs.wso2.com/display/AM210/apidocs/admin/index.html
[2] https://docs.wso2.com/display/AM210/apidocs/admin/index.html#!/operations#BlacklistCollection#throttlingBlacklistPost
[3]

POST https://127.0.0.1:9443/api/am/admin/v0.11/throttling/blacklist
Authorization: Bearer a1e3951b-a15c-3d79-a15b-99f1d612843e
Content-Type: application/json

{
"conditionType": "IP",
"conditionValue": "10.100.7.77"
}

Need Information on how we sync information on APIM product which deployed different data centers

Description:
Please include information on how we can sync the throttling policies and deployment data in two different data centers or multi regions.

Suggested Labels:
Type/Docs
Type/Improvement
Severity/Critical
Priority/High

Better to have a sample on Geographical Distributed wide API Management

Description:
Geographical Distributed wide API Management is widely used use case.
It's better if we have a sample on this area.

Suggested Labels:
Type/Docs
Type/Improvement
Priority/Normal
Affected/2.2.0
Affected Product Version:
WSO2 API Manager 2.2.0

[Doc] Registry mount config given as sample in relevant doc page needs to be corrected with "cacheId"

Description:
For $subject observed the doc space[1] doesn't mentioned "cacheId" in registry mount config. Note that it has caused for an issue in[2] as well. So it is needed to correct.

Suggested Labels:
Type/bug
Priority/Highest
Sevirity/High

Affected Product Version:
apim-2.1.0

OS, DB, other environment details and versions:

Steps to reproduce:
I simply followed doc[1] to do SSO using IS and got error[2]. I could get rid of this after corrected registry mount
Existing in doc:
<remoteInstance url="https://localhost"> <id>gov</id> <dbConfig>govregistry</dbConfig> <readOnly>false</readOnly> <enableCache>true</enableCache> <registryRoot>/</registryRoot> </remoteInstance>
Correct one:
<remoteInstance url="https://localhost"> <id>gov</id> <dbConfig>govregistry</dbConfig> <cacheId>root@jdbc:mysql://localhost:3306/regdb</cacheId> <readOnly>false</readOnly> <enableCache>true</enableCache> <registryRoot>/</registryRoot> </remoteInstance>

[1] [https://docs.wso2.com/display/AM210/Configuring+External+IDP+through+Identity+Server+for+SSO#ConfiguringExternalIDPthroughIdentityServerforSSO-Sharingtheregistryspace]
[2]
[2018-02-27 14:54:47,893] ERROR {org.wso2.carbon.registry.core.internal.RegistryCoreServiceComponent} - Unable to create fixed remote mounts. org.wso2.carbon.registry.core.exceptions.RegistryException: An exception occurred while executing handler chain. null at org.wso2.carbon.registry.core.jdbc.handlers.HandlerManager.delete(HandlerManager.java:2649) at org.wso2.carbon.registry.core.jdbc.handlers.UserDefinedHandlerManager.delete(UserDefinedHandlerManager.java:215) at org.wso2.carbon.registry.core.jdbc.handlers.HandlerLifecycleManager.delete(HandlerLifecycleManager.java:443) at org.wso2.carbon.registry.core.jdbc.EmbeddedRegistry.delete(EmbeddedRegistry.java:851) at org.wso2.carbon.registry.core.caching.CacheBackedRegistry.delete(CacheBackedRegistry.java:595) at org.wso2.carbon.registry.core.session.UserRegistry.deleteInternal(UserRegistry.java:867) at org.wso2.carbon.registry.core.session.UserRegistry.access$1100(UserRegistry.java:61) at org.wso2.carbon.registry.core.session.UserRegistry$12.run(UserRegistry.java:842) at org.wso2.carbon.registry.core.session.UserRegistry$12.run(UserRegistry.java:839) at java.security.AccessController.doPrivileged(Native Method) at org.wso2.carbon.registry.core.session.UserRegistry.delete(UserRegistry.java:839) at org.wso2.carbon.registry.core.internal.RegistryCoreServiceComponent.setupMounts(RegistryCoreServiceComponent.java:301) at org.wso2.carbon.registry.core.utils.RegistryUtils.initializeTenant(RegistryUtils.java:1162) at org.wso2.carbon.identity.application.mgt.ApplicationMgtUtil.storePermissions(ApplicationMgtUtil.java:244) at org.wso2.carbon.identity.application.mgt.ApplicationManagementServiceImpl.createApplication(ApplicationManagementServiceImpl.java:140) at org.wso2.carbon.identity.application.mgt.ApplicationManagementAdminService.createApplication(ApplicationManagementAdminService.java:55) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) at org.apache.axis2.rpc.receivers.RPCUtil.invokeServiceClass(RPCUtil.java:212) at org.apache.axis2.rpc.receivers.RPCMessageReceiver.invokeBusinessLogic(RPCMessageReceiver.java:117) at org.apache.axis2.receivers.AbstractInOutMessageReceiver.invokeBusinessLogic(AbstractInOutMessageReceiver.java:40) at org.apache.axis2.receivers.AbstractMessageReceiver.receive(AbstractMessageReceiver.java:110) at org.apache.axis2.engine.AxisEngine.receive(AxisEngine.java:180) at org.apache.axis2.transport.local.LocalTransportReceiver.processMessage(LocalTransportReceiver.java:169) at org.apache.axis2.transport.local.LocalTransportReceiver.processMessage(LocalTransportReceiver.java:82) at org.wso2.carbon.core.transports.local.CarbonLocalTransportSender.finalizeSendWithToAddress(CarbonLocalTransportSender.java:45) at org.apache.axis2.transport.local.LocalTransportSender.invoke(LocalTransportSender.java:77) at org.apache.axis2.engine.AxisEngine.send(AxisEngine.java:442) at org.apache.axis2.description.OutInAxisOperationClient.send(OutInAxisOperation.java:430) at org.apache.axis2.description.OutInAxisOperationClient.executeImpl(OutInAxisOperation.java:225) at org.apache.axis2.client.OperationClient.execute(OperationClient.java:149) at org.wso2.carbon.identity.application.mgt.stub.IdentityApplicationManagementServiceStub.createApplication(IdentityApplicationManagementServiceStub.java:608) at org.wso2.carbon.identity.application.mgt.ui.client.ApplicationManagementServiceClient.createApplication(ApplicationManagementServiceClient.java:88) at org.apache.jsp.application.add_002dservice_002dprovider_002dfinish_002dajaxprocessor_jsp._jspService(add_002dservice_002dprovider_002dfinish_002dajaxprocessor_jsp.java:143) at org.apache.jasper.runtime.HttpJspBase.service(HttpJspBase.java:70) at javax.servlet.http.HttpServlet.service(HttpServlet.java:731) at org.apache.jasper.servlet.JspServletWrapper.service(JspServletWrapper.java:439) at org.apache.jasper.servlet.JspServlet.serviceJspFile(JspServlet.java:395) at org.apache.jasper.servlet.JspServlet.service(JspServlet.java:339) at javax.servlet.http.HttpServlet.service(HttpServlet.java:731) at org.wso2.carbon.ui.JspServlet.service(JspServlet.java:155) at org.wso2.carbon.ui.TilesJspServlet.service(TilesJspServlet.java:80) at javax.servlet.http.HttpServlet.service(HttpServlet.java:731) at org.eclipse.equinox.http.helper.ContextPathServletAdaptor.service(ContextPathServletAdaptor.java:37) at org.eclipse.equinox.http.servlet.internal.ServletRegistration.service(ServletRegistration.java:61) at org.eclipse.equinox.http.servlet.internal.ProxyServlet.processAlias(ProxyServlet.java:128) at org.eclipse.equinox.http.servlet.internal.ProxyServlet.service(ProxyServlet.java:68) at javax.servlet.http.HttpServlet.service(HttpServlet.java:731) at org.wso2.carbon.tomcat.ext.servlet.DelegationServlet.service(DelegationServlet.java:68) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:303) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208) at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208) at org.apache.catalina.filters.HttpHeaderSecurityFilter.doFilter(HttpHeaderSecurityFilter.java:124) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208) at org.wso2.carbon.tomcat.ext.filter.CharacterSetFilter.doFilter(CharacterSetFilter.java:61) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208) at org.apache.catalina.filters.HttpHeaderSecurityFilter.doFilter(HttpHeaderSecurityFilter.java:124) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208) at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:219) at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:110) at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:506) at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:169) at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:103) at org.wso2.carbon.identity.context.rewrite.valve.TenantContextRewriteValve.invoke(TenantContextRewriteValve.java:80) at org.wso2.carbon.identity.authz.valve.AuthorizationValve.invoke(AuthorizationValve.java:91) at org.wso2.carbon.identity.auth.valve.AuthenticationValve.invoke(AuthenticationValve.java:60) at org.wso2.carbon.tomcat.ext.valves.CompositeValve.continueInvocation(CompositeValve.java:99) at org.wso2.carbon.tomcat.ext.valves.CarbonTomcatValve$1.invoke(CarbonTomcatValve.java:47) at org.wso2.carbon.webapp.mgt.TenantLazyLoaderValve.invoke(TenantLazyLoaderValve.java:57) at org.wso2.carbon.tomcat.ext.valves.TomcatValveContainer.invokeValves(TomcatValveContainer.java:47) at org.wso2.carbon.tomcat.ext.valves.CompositeValve.invoke(CompositeValve.java:62) at org.wso2.carbon.tomcat.ext.valves.CarbonStuckThreadDetectionValve.invoke(CarbonStuckThreadDetectionValve.java:159) at org.apache.catalina.valves.AccessLogValve.invoke(AccessLogValve.java:962) at org.wso2.carbon.tomcat.ext.valves.CarbonContextCreatorValve.invoke(CarbonContextCreatorValve.java:57) at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:116) at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:445) at org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1115) at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:637) at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1775) at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.run(NioEndpoint.java:1734) at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149) at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624) at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) at java.lang.Thread.run(Thread.java:748) Caused by: java.lang.NullPointerException at org.wso2.carbon.registry.core.jdbc.handlers.builtin.MountHandler.delete(MountHandler.java:490) at org.wso2.carbon.registry.core.jdbc.handlers.HandlerManager.delete(HandlerManager.java:2627) ... 90 more

Access contol: Please include samples with two apis configured as All and Restricted By Roles separately

In [1] it just includes a half way sample of the an explanation to the above fields. Please provide a walk through with 2 apis that have these permissions and how they would behave for two users with separate roles.

[1] https://docs.wso2.com/display/AM2xx/Enabling+Access+Control+Support+for+API+Publisher

Please remove the url format from remoteInstance attribute in registry mounting config.

Description:
Please remove the link in the value of remoteInstance Url in [1] under registry mounting
configuration.

[1] https://docs.wso2.com/display/AM210/Distributed+Deployment+of+API+Manager

Suggested Labels:
Type/Docs
Type/Bug
Severity/Minor
Priority/Normal
Affected/2.2.0

Specify how the cron job should be run for the first time

Description:
Document: https://docs.wso2.com/display/CLUSTER44x/Configuring+rsync+for+Deployment+Synchronization
Step 3

Provide information about how the cron job should be started to run.

Suggested Labels:
Improvement

OS, DB, other environment details and versions:
Ubuntu 14.04

Include a doc section in the APIM side mentioning important steps that need to follow when enabling email as a username

Suggested Labels
APIM 2.2.0
Type/Docs
Type/Improvement
Priority/High
Severity/Major

Description
Refer to the link [1]. Under the section configuring service providers to the publisher and store with the Facebook identity provider there is a hyperlink as Email Authentication which will direct the users to a IS Doc. This explains about how to enable Email as a username for IS. But as this particular scenario needs to enable email as a Username in the APIM side as well it will be better if we can add a document section by mentioning the important steps in enabling email as a username in the APIM side. Here in the configs that we do in APIM> user-mgt.xml if we give username as [email protected] by following the IS doc backend will throw a error message therefore to resolve this we need to give username as admin@[email protected] in the APIM side. Please add this detail as well in the APIM side doc section.
eg :- AdminUser
UserName- admin@[email protected]
Password-admin

[1]. https://docs.wso2.com/display/AM2xx/Log+in+to+the+API+Store+using+Social+Media

Specify the permissions needs to be given to worker and manager nodes - rsync

Description:
Document: https://docs.wso2.com/display/AM210/Using+Puppet+Modules+to+Set+up+WSO2+API-M+with+Pattern+6
Step 5 - Update the clustering related configurations
step 4

Through the puppet script, wso2user is created. In order to do the rsync correctly, specify which permissions need to be given to which users, to which directories.

Suggested Labels:
AM2xx
Priority/High
Bug

Affected Product Version:
AM2xx

OS, DB, other environment details and versions:
Ubuntu 14.04

How to send large size streamed data through the gateway

Description:
Could not find any information of the $subject or the possible timeout error in the docs.

Following is an answer suggested to a customer.

You have an option to send large size streamed data through the gateway.
Please follow the following steps.

1. Navigate to <APIM_HOME>/repository/conf/axis2/axis2.xml file.
2. In the Message Builders section uncomment –

<messageBuilder contentType="multipart/form-data"
class="org.wso2.carbon.relay.BinaryRelayBuilder"/>

3. In the Message Formatter section uncomment –

<messageFormatter contentType="multipart/form-data"
class="org.wso2.carbon.relay.ExpandingMessageFormatter"/>

After doing the above configurations, if you got the timeout error, please do the following configurations to increase the API Manager timeouts.

Increasing global timeout.
Navigate to <APIM_HOME>/repository/conf/synapse.properties file and increase the synapse.global_timeout_interval.

Affected Product Version:
APIM

[Doc] [2.1.0] Need Publisher sub theme documentation

Godwin reported as follows:
We have documentation[1] how to apply sub theme for Store. But we don't have same for Publisher.

Harsha Mentioned as follows:
It is possible do the theming for publisher in the same way as well. The Section Uploading through the Admin Portal is not there for publisher theme change.

[1] https://docs.wso2.com/display/AM210/Adding+a+New+API+Store+Theme

"Test the System" Step 8 needs to be peformed prior

Description:
IMO the the step 8 - "Create a new billing plan" should be positioned much earlier. The user is confused whether the apim store user is creating the billing plan when it is placed at this stage. AFAIK this should be done from the publishers login details and configured prior the apim store users logs in.

[1] https://docs.wso2.com/display/AM2xx/Enabling+Monetization+of+APIs

Suggested Labels:
Type/Bug, Doc ,2.x,x update 7, Priority/Highest, Severity/Critical

"Install additional cApp" if this is additional can we mention the use of deploying this sample

Description:
In [1] under "Install additional cApp" we have mentioned "You can use this additional cApp to generate additional summary data used to feed the billing engine.". Can we mention what type of additional data can the user benefit from enabling this capp.

e.g - If I am a fresh user who needs to try out the API monetization feature what advantages will I get from adding this capp? How will the billing engine differ when the capp is not deployed is also not clear.

[1] https://docs.wso2.com/display/AM2xx/Enabling+Monetization+of+APIs#EnablingMonetizationofAPIs-InstalladditionalcApp

Suggested Labels:
Type/Bug, Doc ,2.x,x update 7, Priority/High, Severity/Critical

Please remove the halfway linked url from the configuration on clustering doc.

Description:
Please remove the halfway linked urls in the configuration [1]
[1] https://docs.wso2.com/display/AM210/Distributed+Deployment+of+API+Manager
Suggested Labels:
Type/Bug
Type/Docs
Severity/Minor
Priority/Normal
Affected/2.2.0

[Doc] No documentation on adding name to a custom grant type in API Store.

Description:
When a custom grant type is added to APIM, and once the indentity.xml is updated, in the API Store UI, it shows without a name.

To set a name, We need to do the following:

• Open <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes/wso2/js/applications.js
• Add a new entry under the "config" of the "GrantType" object (first variable) with "urn:ietf:params:oauth:grant-type:jwt-bearer" as the key and "JWT" (Or any desired name) as the value. See below:

var GrantTypes = function (available) {
    this.config = {
        ...
        ...
        "urn:ietf:params:oauth:grant-type:jwt-bearer":"JWT"
    }
    ...
    ...
};

These information are missing in the APIM docs.

Suggested Labels:
Documentation, Docs

Affected Product Version:
APIM 2.1.0

[DOC] [AM220] Add information for which throttling will reflect where both a 'subscription tier' and an 'advanced throttle-apply to API' enabled

Description:
If the user enabled a subscription tier - Subscription-level throttling (API publisher)
(e.g. Gold) and added a Advance throttling - Apply to API as well (see attached), user needs to know how the throttling works. Whether subscription tier level throttling or API level throttling will reflect to subscribers for accessing particular API.

Suggested Labels:
APIM-2.2.0
Document

Suggested Assignees:

Affected Product Version:
2.2.0

OS, DB, other environment details and versions:

Steps to reproduce:

[https://docs.wso2.com/display/AM2xx/Introducing+Throttling+Use-Cases#IntroducingThrottlingUse-Cases-ImplicationsontheAPIsintheGateway]
[https://docs.wso2.com/display/AM2xx/Setting+Throttling+Limits#SettingThrottlingLimits-Subscription-levelthrottling(APIpublisher)]

Providing information for the way to get rid of ssl warnings for MySQL5.7 users.

Description:
Documents should provide information for the way to get rid of ssl warnings which appeared on the server console for MySQL5.7 users who don't want to use ssl. By setting useSSL=false to the jdbc url, this can be disappeared.

jdbc:mysql://localhost:3306/apimdb?autoReconnect=true&useSSL=false

Affected Product Version:
APIM2xx
OS, DB, other environment details and versions:
MySQL5.7

[Clustering] Hazelcast Community Edition link redirects to a dead page.

Description:
Document: Introduction to clustering
Section: Introduction to clustering
Hazelcast Community Edition link redirects to a broken/dead page.
https://hazelcast.com/products/hazelcast-core/

[Doc] The quick start guide needs to have information on running the end to end flow

Currently [1] contains only accessing the publisher and store. But ideally the quick start guide should be a walk through where it takes a user from creating, publishing and api to invocation. The current structure needs to be changed. Please update.

[1] https://docs.wso2.com/display/AM300/Quick+Start+Guide#QuickStartGuide-AccessingtheAPIPublisher

[APIM] Document how to achieve high SLA for the APIs

Description:
The APIM document does not contain any information on how wso2 APIM support higher SLAs (support higher availability, fault tolerance) for the mission-critical APIs.

It is important to document the following key points looking at the customer' point of view

1. As an API provider, how can I provide 99.9% SLA to the customer's who uses APIs
2. What is the possible implementation to achieve more 9s in SLA?
3. Suggest the backup and recovery approaches to maintain the SLA over time
4. How to monitor the SLA of a particular API?
5. Is to possible to define an SLA for an API, and notify when the SLA is breached and get notified if there is any possibility of SLA breach in future considering the current statistics

Affected Product Version:
APIM Doc 2xx

Specify where should the workers-list.txt file be created

Description:
Document: https://docs.wso2.com/display/AM210/Using+Puppet+Modules+to+Set+up+WSO2+API-M+with+Pattern+6
Step 5 - Update the clustering related configurations
step 4

When consiering gateway manager and gateway worker, specify where should the workers-list.txt file be located.

Suggested Labels:
AM2xx docs

Affected Product Version:
Am2xx

OS, DB, other environment details and versions:
Ubuntu 14.04

Please include some reference on how we can do database replication in multi regional environment.

Description:
When we deploy APIM product in Multi regional environment, It's required to have database replication.
Please include these information into our official document.

Suggested Labels:
Type/Docs
Type/Improvement
Severity/Critical
Priority/High

Specify what is apim and apim_worker mentioned in the workers-list.txt

Description:
Document: Configuring rsync for Deployment Synchronization

Specify what is the location mentioned as apim/apim_worker in the workers-list.txt

Suggested Labels:
Am2xx docs

Affected Product Version:
AM2xx

OS, DB, other environment details and versions:
Ubuntu 14.04

[Doc] [apim-kubernetes] Include the doc link of "wso2 products on kubernetes" which have more information on relevant topic

Description:
As $subject include link[1] somewhere needed into the doc page[2], so it will more help to understand more on this architecture.

Suggested Labels:
apim-2.1.0
apim-kubernetes-v2.1.0.1
Type/doc
Priority/Highest
Type/bug

Affected Product Version:
apim-2.1.0
apim-kubernetes-v2.1.0.1

OS, DB, other environment details and versions:

Steps to reproduce:
[1] [https://docs.wso2.com/display/KA100/Clustered+Deployment+of+WSO2+Products+on+Kubernetes]
[2] [https://docs.wso2.com/display/AM210/Deploying+API+Manager+with+Kubernetes+or+OpenShift+Resources#DeployingAPIManagerwithKubernetesorOpenShiftResources-DeployapatternonKubernetes]