Skip to content

Commit

Permalink
add info on PermissionClaim on ApiExport update
Browse files Browse the repository at this point in the history
On-behalf-of: SAP [email protected]
Signed-off-by: Simon Bein <[email protected]>
  • Loading branch information
SimonTheLeg committed Dec 10, 2024
1 parent e6ad9ac commit d10b444
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/content/concepts/apis/exporting-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ TODO
`APIBindings` are used to import API resources. They contain a reference to an `APIExport` using the namespace and workspace path of an `APIExport` and will bind all APIs defined in the `APIExport`. The reference path needs to be provided to you by the provider of the API or an external catalog solution.

Furthermore, `APIBindings` provide the `APIExport` owner access to additional resources defined in an `APIExport`'s `PermissionClaims` list. `PermissionClaims` must be accepted by the user explicitly, before this access is granted. The resources can be builtin Kubernetes resources or resources from other `APIExports`.
When an `APIExport` is changed after workspaces have bound to it, new or changed APIs are automatically propagated to all `APIBindings`. New `PermissionClaims` on the other hand are NOT automatically accepted.

Returning to our previous example, we can use the following `APIBinding` to import the widgets api.

Expand Down

0 comments on commit d10b444

Please sign in to comment.