Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OSS API documentation documents InfluxDB Cloud features #5320

Closed
fungiboletus opened this issue Feb 12, 2024 · 1 comment · Fixed by #5325 · May be fixed by influxdata/openapi#646
Closed

OSS API documentation documents InfluxDB Cloud features #5320

fungiboletus opened this issue Feb 12, 2024 · 1 comment · Fixed by #5325 · May be fixed by influxdata/openapi#646
Assignees
@jstirnaman

Comments

@fungiboletus
Copy link

Steps to reproduce:
List the minimal actions needed to reproduce the behaviour.

  1. Visit https://docs.influxdata.com/influxdb/v2/api/#operation/PostQuery
  2. Notice the documentation about parameterised queries, a non OSS feature.

Expected behaviour:
No documentation for non OSS feature in the OSS documentation. I tried the query and it failed.

Actual behaviour:
Documentation of a proprietary feature int he OSS documentation. A stack overflow comment pointed out that parametised queries is not an OSS feature.

Environment info:

N/A.

Config:

N/A.

Logs:

N/A.
@jstirnaman jstirnaman transferred this issue from influxdata/influxdb Feb 14, 2024
@jstirnaman jstirnaman self-assigned this Feb 15, 2024
jstirnaman added a commit to influxdata/openapi that referenced this issue Feb 15, 2024
@jstirnaman
fix: OSS API documentation documents InfluxDB Cloud features (influxd…
d1496fa 
…ata/docs-v2#5320)

- Effectively removes  property from OSS Query API.
- Re-diverges Query schema, removing  from OSS and keeping it in Cloud.
@jstirnaman jstirnaman mentioned this issue Feb 15, 2024
Open
jstirnaman added a commit to influxdata/openapi that referenced this issue Feb 15, 2024
@jstirnaman
fix: OSS API documentation documents InfluxDB Cloud features (influxd…
2bb9cbb 
…ata/docs-v2#5320)

- Effectively removes  property from OSS Query API.
- Re-diverges Query schema, removing  from OSS and keeping it in Cloud.
- Re-diverges paths with oss- and cloud-specific schemas.
jstirnaman added a commit to influxdata/openapi that referenced this issue Feb 15, 2024
@jstirnaman
fix: OSS API documentation documents InfluxDB Cloud features (influxd…
2a0144a 
…ata/docs-v2#5320)

- Effectively removes  property from OSS Query API.
- Re-diverges Query schema, removing  from OSS and keeping it in Cloud.
- Re-diverges paths with oss- and cloud-specific schemas.
jstirnaman added a commit that referenced this issue Feb 15, 2024
@jstirnaman
fix(v2): (Closes #5320) Remove attribute from OSS /api/v2/query schem…
6c76ace 
…a. OSS doesn't support parameterized queries. See upstream PR: influxdata/openapi#646
@jstirnaman jstirnaman mentioned this issue Feb 15, 2024
Merged
jstirnaman added a commit that referenced this issue Feb 15, 2024
@jstirnaman
fix(v2): (Closes #5320) Remove attribute from OSS /api/v2/query schem…
5230b11 
…a. OSS doesn't support parameterized queries. See upstream PR: influxdata/openapi#646 (#5325)
@fungiboletus
Copy link
Author

Thanks for the quick fix 🙂

jstirnaman added a commit to influxdata/openapi that referenced this issue May 16, 2024
@jstirnaman
fix: OSS API documentation documents InfluxDB Cloud features (influxd…
582caab 
…ata/docs-v2#5320)

- Effectively removes  property from OSS Query API.
- Re-diverges Query schema, removing  from OSS and keeping it in Cloud.
- Re-diverges paths with oss- and cloud-specific schemas.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jstirnaman jstirnaman

Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@fungiboletus @jstirnaman