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

Inconsistancy with upstream.strip_path #56

Open
adamstrawson opened this issue Apr 8, 2022 · 1 comment
Open

Inconsistancy with upstream.strip_path #56

adamstrawson opened this issue Apr 8, 2022 · 1 comment
Labels
breaking change Changes behavior in a breaking manner. bug Something is not working. help wanted We are looking for help on this one.

Comments

@adamstrawson
Copy link
Contributor

adamstrawson commented Apr 8, 2022

Describe the bug

There is an inconstancy within the CRD when defining upstream.strip_path.

The Ory Oathkeeper documentation, and some references within the CRD uses snake case strip_path , however the CRD expects this to be camel case stripPath.

Snake Case references:
Documentation
Rule_type_tests.go
Rule_json.go

Camel case reference
rule_types.go

Expected behavior

The CRD should ideally match that of the Ory documentation for a standard rule outside of the CRD, as snake case strip_path

Environment
CRD version: v1alpha1

I would contribute a PR for this, but aware that it'll be a breaking change for those who have already implemented as stripPath, so not sure how best to action this.

@Demonsthere
Copy link
Collaborator

Hello there!
As this is a CRD change, you are right it can be breaking. In this situation we could do one of the following:

  • define a new field in the current CRD strip_path which would work alongside stripPath, and mark this as deprecated
  • build a new version of the CRD v1alpha2 with the new field

However, I cannot give you any indication when we could add either of the solutions 😞

@Demonsthere Demonsthere added bug Something is not working. help wanted We are looking for help on this one. breaking change Changes behavior in a breaking manner. labels Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Changes behavior in a breaking manner. bug Something is not working. help wanted We are looking for help on this one.
Projects
None yet
Development

No branches or pull requests

2 participants