Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MI 4.2.0] Update the File Connector Example page #1014

Open
DinithiDiaz opened this issue Oct 9, 2024 · 0 comments
Open

[MI 4.2.0] Update the File Connector Example page #1014

DinithiDiaz opened this issue Oct 9, 2024 · 0 comments

Comments

@DinithiDiaz
Copy link
Member

Description

The document [1] provides an example scenario for testing the file connector. However, there are a few discrepancies between the content and the screenshots and the steps outlined for trying out the connector project.

Specific issues identified:

curl -H "Content-Type: application/xml" --request POST --data @body.json http://10.100.5.136:8290/fileconnector/create

1. Inconsistent content-type in curl command [2]:
The provided curl command specifies a "Content-Type" of application/xml, but the data being sent is from a .json file, which creates a conflict.

2. Incorrect file format reference:
The payload format is XML, yet the first step refers to saving it as a data.json file. This mismatch can cause confusion.

3. Incorrect host in the curl command:
The curl command uses an IP address rather than localhost, which is unexpected for a local testing scenario.

4. Mismatched API context:
According to the API request, the context path should be /fileconnector, but earlier in the documentation [3], it instructs users to create the REST API with the context /fileTest, leading to inconsistencies.

5. Missing URI template configuration:
The curl request references /create as the URI_TEMPLATE, yet the documentation does not include any instructions for specifying the URI_TEMPLATE or URL_MAPPING for the API.

6. Complexity in identifying steps:
Many steps are explained only through screenshots, making it difficult to follow. This forces users to manually type configuration values instead of copy-pasting, making the process less user-friendly.

7. No Downloadable project for reference:
There is no link to download the complete project to try out or verify our implementation.

Request for Improvement:

Kindly request a thorough review and update of the entire document to ensure consistency between the instructions and screenshots. This is especially important as the document is referenced in our training materials. A more structured and user-friendly approach would be highly appreciated.

[1] https://apim.docs.wso2.com/en/4.2.0/reference/connectors/file-connector/file-connector-example/
[2] https://apim.docs.wso2.com/en/4.2.0/reference/connectors/file-connector/file-connector-example/#testing
[3] https://apim.docs.wso2.com/en/4.2.0/reference/connectors/file-connector/file-connector-example/#creating-the-integration-logic

Product: MI 4.2.0

<This issue has been transferred from mi-internal>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants