OpenAPI Spec for CP4D APIs

We got a first design of the API spec file from the Lab, where the different APIs are split up in smaller api files for specific uses. I had a session with my workmate currently useing the cloud pack for data API. They like the small API pieces very much. It makes it much easier for finding a specific API and easier to generte a client from a small file.

My workmates will already start working with the prototype files, as this is much easier than searching in the documentation, even if they are incomplete.

It would be perfect, If you could add the api spec files to the page where the api token can be created. A List with a small description, a button to download the spec yaml file and what would be a bonus a link to a swagger ui side with the api.

So fare great work we are looking forward to what the final result will be.

I want to add our first two usecases for the API. We will build our own API Spec files, but I hope we can replace them with yours in the future.

1) Our first usecase is cp4d project management. At wuestenrot we have experiences a lot of pain in the past in tools where everyone is able to create his own projects in a global environment. This causes troubles in the areas of naming-conventions, access-permissions and "ups I forgot something to setup".

We have build an inhouse tool to do such automation. Till may we now want to extend our inhouse tool (angular UI+ springboot backend) to be able to create cp4d projects.

features:

• create cp4d project with wuestenrot naming conventions
• set the correct permissions on the project
• add a bitbucket connection to the project if needed (most of them should get one)
• do the above stuff on all of our cp4d environments (we will get 3 - prod, qa, build/dev)
• trigger git pulls/commits on the different stages to do a deployment of the sources with the API 

All of this should be done via the api.

2) WKC Usecase

Our second API Usecase is arround WKC. Work is already in progress.

I am not working on this usecase, so I don't know how much of the API my workmates are useing. If you want to know more I can arrange a meeting.

I have an update to this request, maybe it is not as difficult to implement as talked befor.

In another support ticket your workmate told me about api explorer.

I didn' know you are using liberty as web server and also have the api exposed as swagger api.

I am not sure, if I am too stupid finding this or everyone

This is exactly what I wanted :)

Urls:

https://host/v2/connections/api/explorer/

https://host/v2/connections/api/docs -> yaml file - YES :)

Now my request slightly changes and you can decicde which direction you want to go:

NEW RFE Content: For me the main problem was not to find this stuff.

If you just could implement an API Site in the cpadmin Backend, where this links are aggregated and commented it would be enough and is self explaining.

There is no need for an additional extra api File. Just include the https://host/v2/connections/api/docs link into a download button and thats it.

What I haven't discovered jet is, what are all the apis you have. I read the documentaiton and found a lot of stuff, but it was more confusing than helpful.

For me there is no need for additional documentation.

The api explorer looks fine for me. Yes I am happy finding this and I am a little confused, that the support didn't point me in this direction.