APIs for publishing SmartDocs on Developer Portal

Google Cloud Apigee Knowledge Hub
1

There have been a lot of requests to enable APIs for SmartDocs module on Developer Portal to automate the rendering process.

Here is the module that we have created : https://github.com/apigeecs/smartdocs_service

You would install this module like any other drupal contrib module. It would go under sites/all/modules/ folder and will need to be enabled from the Modules section on your developer portal.

This module is provided as an example only for the community, and it is supported with best-effort via GitHub issues or community.apigee.com. If you find an issue please report it on the GitHub or create pull requests if you have patches.

Module exposes an api to create a SmartDocs model, import OpenAPI (json, yaml) Or WADL specification and to render it.

Rendering is a two step process, first step is to queue the items to be published and on cron run the queue items are processed.

The APIs exposed by this module are documented in the README file.

5 Likes
2

Thanks @Gitesh Koli.

I noticed that you can render the model, but does rendering it also publish it?

@Leonardo Ferrreira Can you review this module and try it out? You can post comments/issues on the Github page.

3

Yes it publishes it as a part of rendering. We are trying to keep this simple.

4

This is awesome! That is what I was looking for!
@Gitesh Koli does it “unpublish” the previous version of an openAPI doc when rendering a new one ?

5

It should.