influxdata / influxdata/openapi

schemas fail swagger-cli validation

Open
#239 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

commit 12c8165b70cb379486592ffbf43ac5a3dde04904

By way of sanity checking, I thought I'd run the schemas through the swagger-cli validator, and they don't seem to pass validation:

% swagger-cli validate oss.yml
Swagger schema validation failed. 
  Data does not match any schemas from 'oneOf' at #/components/securitySchemes/TokenAuthentication
    Missing required property: $ref at #/components/securitySchemes/TokenAuthentication
    Data does not match any schemas from 'oneOf' at #/components/securitySchemes/TokenAuthentication
      Missing required property: in at #/
      Data does not match any schemas from 'oneOf' at #/
        No enum match for: token at #/scheme
        Data matches schema from 'not' at #/
      Missing required property: flows at #/
      Missing required property: openIdConnectUrl at #/
 
JSON_OBJECT_VALIDATION_FAILED

It seems that the security schemas don't match the OpenAPI 3.1 specification (for example the TokenAuthentation scheme should probably be defined as scheme: bearer as a token scheme doesn't seem to exist).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open oss.yml and inspect components/securitySchemes/TokenAuthentication. Compare that definition with the referenced OpenAPI 3.1 security-scheme schema, then run swagger-cli validate oss.yml; done means the schema validates without the reported oneOf errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.