urbancode / ibm-api-connect-ucd

This plug-in for IBM API Connect to develop and publish APIs and LoopBack applications.

IBM API Connect plug-in for IBM UrbanCode Deploy

---

Note: This is not the plugin distributable! This is the source code. To find the installable plugin, go to the plug-in page on the IBM UrbanCode Plug-ins microsite.

License

This plug-in is protected under the Eclipse Public 1.0 License

Overview

IBM API Connect plug-in for IBM UrbanCode Deploy provides steps to publish API Definitions and Loopback Apps to an API Connect server. This plug-in communicates to API Connect through the use of the apiconnect (apic) command line toolkit.

Documentation

All plug-in documentation is updated and maintained on the IBM UrbanCode Plug-ins microsite.

Support

Plug-ins downloaded directly from the IBM UrbanCode Plug-ins microsite are fully supported by IBM. Create a GitHub Issue or Pull Request for minor requests and bug fixes. For time sensitive issues that require immediate assistance, file a PMR through the normal IBM support channels. Plug-ins built externally (like this one) or modified with custom code are supported on a best-effort-basis using GitHub Issues.

Locally Build the Plug-in

This open source plug-in uses Gradle as its build tool. Install the latest version of Gradle to build the plug-in locally. Build the plug-in by running the gradle command in the plug-in's root directory. The plug-in distributable will be placed under the build/distributions folder.

ibm-api-connect-ucd's Issues

API Connect Plug-in will not install

@nhmathis can you pls
apiconnect-5.898105.zip
answer below question
https://developer.ibm.com/answers/questions/401078/getting-an-error-for-customize-apic-plugin-ucd.html

node is not an internal or external command

Original question asked on Dev Works: https://developer.ibm.com/answers/questions/409910/ucd-apic-plugin-error-node-is-not-an-internal-or-e.html#comment-410329

I'm trying to deploy a product/API using UCD apiconnect plugin. I have installed API Connect: v5.0.7.2 (apiconnect: v2.6.71) on host system where UCD agent is also installed. While running the process i am getting an error like "[error] unable to run apic login command" and it also says "node is not an internal or external command" where as all of paths are properly configured as mentioned below out puts from the window commands:

     C:\Windows\system32>node -v
     v7.2.0
     C:\Windows\system32>npm -v
     3.10.9
     C:\Windows\system32>apic -v
     API Connect: v5.0.7.2 (apiconnect: v2.6.71)

When i am trying to use the apic :login and other commands from the commandline i am successfully able to login/ push / publish to API manager/ catalogues and Even if i do this via a Jenkins job i am abe to do all steps which includes login > push > publish but getting error while trying to do the same via APIC UCD plugin.
Can anyone please help?

No ability to specify space in product publish

When utilising the 'spaces' feature of API Connect https://www.ibm.com/support/knowledgecenter/SSMNED_5.0.0/com.ibm.apic.apionprem.doc/tapic_syndication_spaces_configure.html you are given the option to deploy a product to a space within a catalog. This feature is currently not supported by the Publish API Product Definitions Step

Is it possible to use APIC v5 and V10 on the same agent?

Is it possible to install the APIC CLIs of both versions on the same machine and use it from the plugin?

apic products:set support

Set a product as retired, staged, published, deprecated, or archived. Should model this step after the products:replace or products:publish steps.

apic products:set documentation below.

$ apic products:set -help
Usage: apic products:set OPTIONS PRODUCT_NAME[:VERSION]

Update a product in a catalog

Options
--status
staged update the status to staged
published update the status to published
deprecated update the status to deprecated
retired update the status to retired
archived update the status to archived
--visibility
public unauthenticated or authenticated users
authenticated authenticated users
ORG | TAG ... users in the ORG or in any ORG tagged with TAG
--subscribability
authenticated authenticated users
ORG | TAG ... users in the ORG or in any ORG tagged with TAG
-c, --catalog CATALOG catalog name (required)
-o, --organization ORGANIZATION provider organization name (required)
-s, --server SERVER management server endpoint (required)

Publish a product
$ apic products:set climbon --status published --catalog production --organization climbonorg --server mgmnthost.com
Updated climbon:1.0.0 in climbonorg:production (status: published)

Update a product's visibility and subscribability
$ apic products:set climbon --visibility public --subscribability authenticated --catalog production --organization climbonorg --server mgmnthost.com
Updated climbon:1.0.0 in climbonorg:production (visibility: public, subscribability: authenticated)