influxdata / influxdata/openapi

OSS header errors don't agree with spec

Open
#355 0 comments 0 reactions 2 assignees Claimed by @sunbryely-influxdata View on GitHub
bug
Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

`src/common/paths/query_analyze.yml` contains

```yaml
default:
description: Internal server error
headers:
X-Influx-Error:
description: A string that describes the problem.
schema:
type: string
X-Influx-Reference:
description: The numeric reference code for the error type.
schema:
type: integer
```

but I don't see either of those error headers returned by OSS; I only see `X-Platform-Error-Code`.

We need to compare this with Cloud and then fix the spec or document the differences.
For now, I've added it as an additional header:

```yaml
default:
description: Internal server error
headers:
X-Platform-Error-Code:
description: The reason for the error.
schema:
type: string
example: "internal error"
X-Influx-Error:
description: A string that describes the problem.
schema:
type: string
X-Influx-Reference:
description: The numeric reference code for the error type.
schema:
type: integer
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.