Unifying OpenAPI Specs for Core and Enterprise APIs to Enable Shared Client Generation

[thulasirajkomminar]

While reviewing the OpenAPI specifications for both the Core and Enterprise InfluxDB 3.0 Management APIs, I noticed that most of the endpoint paths and schemas are identical or significantly overlapping:

Core spec: core/v3/ref.yml

Enterprise spec: enterprise/v3/ref.yml

I'm interested in generating Go clients from these specs. Is there a specific reason for keeping them separate, or would it make sense to consolidate the shared parts (e.g., via $ref or shared components) to simplify client generation and maintenance?

Would appreciate your thoughts on this.

[jstirnaman]

Is there a specific reason for keeping them separate, or would it make sense to consolidate the shared parts (e.g., via $ref or shared components) to simplify client generation and maintenance?

No, there's no longer a good reason to keep them separate, and you're right: consolidating them would help with maintenance (of clients and the specs). By design, Enterprise is a superset of Core.

Note: However, there are outstanding bugs that have led to some unintentional divergence. The known issues should be fixed in v3.2.1, but unfortunately, the API divergence needs to be preserved for Enterprise API stability going forward.