Build OpenAPI from a 3scale product. Optionally create the activedocs out of it

[vishal41094]

It would be great if the mapping rules(for both products as well as backends) also get exported along with Methods & Metrics in a YAML format or in a Swagger file or OAS format, for the easy documentation of a product to expose.

[eguzki]

That is the purpose of ActiveDocs, isn't it?

If the customer configured the 3scale product out of a OpenAPI spec, the toolbox command already created activedoc for you.

If the customer created methods&metrics&mapping rules without control or tracking, then I guess the toolbox could provide a command to export OpenAPI spec or generate activedoc from existing 3scale configuration (preferred IMO)

[vishal41094]

As per above suggestion in [2] -

[2]. If the customer created methods&metrics&mapping rules without control or tracking, then I guess the toolbox could provide a command to export OpenAPI spec or generate activedoc from existing 3scale configuration (preferred IMO)
--> is this already implemented or can this be implemented?

[eguzki]

It is not implemented. It can be implemented.

Method and metrics are 3scale concepts that will not be included in the exported OpenAPI spec.

[vishal41094]

I am trying to understand how the onboarded service be exported as a documentation if no previous Open API spec file is not available.
How an onboarded API service can be made available to the users on the dev portal if we don't have a swagger file for the original backend service

[eguzki]

@sgutierr can you help on Vishal's question?

[eguzki]

I have created this jira issue for product visibility https://issues.redhat.com/browse/THREESCALE-6481

[sgutierr]

The typical flow is taking the Open API or the swagger file as the point of truth, and automating the import in 3scale, if you don't have the the Swagger/Open API we suggest generate it, for instance you can use Red Hat Apicurio Studio, with it you are able design the contract, validate it, define data types, add examples, responses, etc..