[MI 4.5.0] Update documentation and resources for custom inbound endpoint development #1840
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AmilaSamith
requested review from
anupama-pathirage,
chanikag and
rosensilva
as code owners
| </table> | ||
| 3. Add any required parameters by clicking the **Add Parameter** button. Depending on the type of inbound endpoint (e.g., Kafka, HTTP), you may need to add additional parameters specific to the protocol or technology you are integrating with. | ||
| 4. Click **Create** to add the custom inbound endpoint to the project. | ||
| You can use the sample custom inbound endpoint projects as a template to develop your custom inbound endpoint. Kindly focus on the relevant method descriptions in implementation. |
Member
There was a problem hiding this comment.
Suggested change
| You can use the sample custom inbound endpoint projects as a template to develop your custom inbound endpoint. Kindly focus on the relevant method descriptions in implementation. | |
| To develop your custom inbound endpoint, you can start by using the provided samples as a template. Ensure you thoroughly read the Javadoc for the methods provided in the template before proceeding with concrete implementation. |
|
|
||
| *What to modify:* | ||
|
|
||
| - `component name`: Give a preferred name to your inbound endpoint |
Member
There was a problem hiding this comment.
Let's add periods add the end of the all the sentences.
|
|
||
| *What to modify:* | ||
|
|
||
| - Usually no changes needed unless you have additional resources |
Member
There was a problem hiding this comment.
Let's move this sentence to the purpose section.
Comment on lines
+215
to
+216
| You need to build the developed custom inbound endpoint using Maven to generate the inbound zip file. | ||
| The following command builds the project and creates the zip file in the `/target` folder. |
Member
There was a problem hiding this comment.
Suggested change
| You need to build the developed custom inbound endpoint using Maven to generate the inbound zip file. | |
| The following command builds the project and creates the zip file in the `/target` folder. | |
| Build your custom inbound endpoint using **Maven** to create the required inbound zip file. Run the following command from the project's root directory. It will build and place the resulting zip file in the project's `/target` folder. |
|
|
||
| **4. uischema.json** | ||
|
|
||
| *Purpose:* Defines the UI schema for the Integration Studio graphical editor. |
Member
There was a problem hiding this comment.
Let's rename this as Micro Integration VS Code extension
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds comprehensive documentation and resources for creating custom inbound endpoints in WSO2 Integrator: MI, covering all three types (Listening, Polling, and Event-Based) with step-by-step instructions for development, configuration, and integration.
The documentation includes detailed guidance for modifying essential files (connector.xml, descriptor.yml, filter.properties, uischema.json, and zip-assembly.xml), Maven build commands, and steps to integrate custom endpoints into integration projects using VS Code extension, making it easier for developers to extend WSO2 MI with custom protocol support and vendor-specific integrations.
Sample templates for development can be found under "custom-artifacts/inbound-endpoint/" directory.
Goals