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.

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

Auto-generated OpenAPI is *incorrect* for /aws/creds #12794

Closed
maxb opened this issue Oct 11, 2021 · 1 comment · Fixed by #13487
Closed

Auto-generated OpenAPI is *incorrect* for /aws/creds #12794

maxb opened this issue Oct 11, 2021 · 1 comment · Fixed by #13487
Assignees
Labels
bug Used to indicate a potential bug core/openapi devex Developer Experience

Comments

@maxb
Copy link
Contributor

maxb commented Oct 11, 2021

Describe the bug

The auto-generated OpenAPI (from /sys/internal/specs/openapi) generates incorrect documentation for the AWS secrets engine API.

To Reproduce

  1. Mount an instance of the AWS secrets engine
  2. Visit the built-in Vault Swagger UI (at /ui/vault/api-explorer)
  3. Find the endpoint /aws/creds
  4. Compare with the actual API docs for the AWS secrets engine
  5. Realise that actually there is no such API endpoint /aws/creds, only /aws/creds/{name}

Expected behavior

Auto-generated OpenAPI should accurately reflect the actual APIs in Vault.

Additional context

It would seem highly likely that the bug is that the Vault OpenAPI generator doesn't correctly understand what to do with regexs employing alternatives:

		Pattern: "(creds|sts)/" + framework.GenericNameWithAtRegex("name"),

Pattern: "(creds|sts)/" + framework.GenericNameWithAtRegex("name"),

@heatherezell heatherezell added devex Developer Experience core/openapi labels Oct 12, 2021
@hghaf099 hghaf099 added the bug Used to indicate a potential bug label Oct 14, 2021
@averche
Copy link
Contributor

averche commented Jan 6, 2022

Resolved in #13487

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Used to indicate a potential bug core/openapi devex Developer Experience
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants