influxdata / influxdata/docs-v2

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

Open
#6,181 1 comment 0 reactions 0 assignees View on GitHub
InfluxDB 3 Core and Enterprise
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

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](https://github.com/influxdata/docs-v2/blob/master/api-docs/influxdb3/core/v3/ref.yml)

Enterprise spec: [enterprise/v3/ref.yml](https://github.com/influxdata/docs-v2/blob/master/api-docs/influxdb3/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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing api-docs/influxdb3/core/v3/ref.yml with api-docs/influxdb3/enterprise/v3/ref.yml, focusing on shared paths and schemas. Determine whether shared $ref or components can support Go client generation, and define an agreed consolidation approach and maintenance outcome.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, openapi
Domain
api, documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.