wso2 / wso2/docs-apim

Code example creates error

Open
#3,313 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-4.0.0 Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:

In EI documentation in Building a connector
https://ei.docs.wso2.com/en/latest/micro-integrator/references/connectors/develop-connectors/#utilities

Step 2: Adding the new connector resources¶
4. Edit the connector.xml file in the src/main/resources directory and replace the contents with the following dependency:
following code is provided

<?xml version="1.0" encoding="UTF-8"?>
<connector>
    <component name="sample" package="org.wso2.carbon.connector">
        <dependency component="googlebooks_volume" />
        <description>wso2 sample connector library</description>
    </component>
</connector>

If the name is defined as 'sample' it will raise an error

Connector directory name, 'googlebook-connector-1.0.0', doesn't match with the connector name 'sample'.

NOTE: component name should be left as the name of the connector that was declared during the initialization.

EI version 7.1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the EI documentation page at the Building a connector section, especially “Adding the new connector resources,” and review the connector.xml example in src/main/resources. Verify the component name against the connector initialization and confirm the published example no longer produces the directory-name error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.