The Example Block in Externalizing the VCS Configuration Section Should be Corrected

Description:

• The example block in [1] which provides an example code segment for setting a custom location for the vcs-config.yaml file specifies only the folder location as follows.

$ apictl set --vcs-config-path /home/wso2/api-manager/gitconfigs
VCS config file path is set to : /home/wso2/api-manager/gitconfigs

• This causes an issue as reported in [2]. This code segment should be corrected to include the vcs-config.yaml file name as well as shown below.

$ apictl set --vcs-config-path /home/wso2/api-manager/gitconfigs/vcs-config.yaml
VCS config file path is set to : /home/wso2/api-manager/gitconfigs/vcs-config.yaml

• An example of how this command should be run with the relevant output is shown in point 6 of [3].

• This needs to be fixed in the documentation spaces from 3.2.0 and above.

[1] https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/advanced-topics/configuring-git-integration/#externalizing-the-vcs-configuration
[2] https://github.com/wso2/api-manager/issues/927
[3] https://github.com/wso2/api-manager/issues/927#issuecomment-1327121403

Open the linked Externalizing the VCS Configuration documentation and compare the example with point 6 of the referenced api-manager issue. Update the example in documentation spaces for version 3.2.0 and above so the path includes vcs-config.yaml, then verify the command and displayed output are consistent.