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

refactor: API paths #862

Merged
merged 3 commits into from
Mar 29, 2022
Merged

refactor: API paths #862

merged 3 commits into from
Mar 29, 2022

Conversation

zepatrik
Copy link
Member

@zepatrik zepatrik commented Mar 26, 2022

This change refactors the API paths to be consistent with the rest of the Ory ecosystem. This step is required for the unified Ory SDK. Additionally, as we plan to add high level APIs, e.g. for RBAC. The check and expand API paths changed to allow adding those.

BREAKING CHANGES: /check is now /relation-tupes/check
BREAKING CHANGES: /expand is now /relation-tuples/expand
BREAKING CHANGES: /relation-tuples is now /admin/relation-tuples for write APIs
BREAKING CHANGES: gRPC package is now called ory.keto.relation_tuples.v1alpha2
BREAKING CHANGES: gRPC relation-tuple-delta action enum names are prefixed with ACTION_

This change refactors the API paths to be consistent with the rest of the Ory ecosystem. This step is required for the unified Ory SDK. Additionally, as we plan to add high level APIs, e.g. for RBAC, the check and expand API paths changed to allow adding those.

BREAKING CHANGE: `/check` is now `/acl/check`
BREAKING CHANGE: `/expand` is now `/acl/expand`
BREAKING CHANGE: `/relation-tuples` is now `/admin/relation-tuples` for write APIs
@zepatrik zepatrik requested a review from aeneasr March 26, 2022 09:36
@@ -6,5 +6,5 @@ curl -G --silent \
--data-urlencode "relation=access" \
--data-urlencode "object=/photos/beach.jpg" \
--data-urlencode "max-depth=3" \
http://127.0.0.1:4466/expand | \
http://127.0.0.1:4466/acl/expand | \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACL for Access Control List? Is that the nomenclautur you want to go here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was also not sure about that, but basically yes. The gRPC API is also package ory.keto.acl.v1alpha1, so it would be consistent.
In some way you could say that relation tuples are an ACL?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Later on we can have /rbac/check and others.

@zepatrik zepatrik requested a review from aeneasr March 29, 2022 06:36
@zepatrik zepatrik merged commit d29d42c into master Mar 29, 2022
@zepatrik zepatrik deleted the refactor/api-paths branch March 29, 2022 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants