HonahX commented on code in PR #808:
URL: https://github.com/apache/polaris/pull/808#discussion_r1950209013
##########
spec/generated/bundled-polaris-catalog-service.yaml:
##########
@@ -1359,6 +1359,253 @@ paths:
$ref: '#/components/responses/ServiceUnavailableResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'
+ /v1/{prefix}/namespaces/{namespace}/policies:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ - $ref: '#/components/parameters/namespace'
+ post:
+ tags:
+ - Catalog API
+ summary: Create a policy in the given namespace
+ operationId: createPolicy
+ description: |
+ Creates a policy within the specified namespace.
+
+ A policy defines a set of rules governing actions on specified
resources under predefined conditions.
+ In Apache Polaris, policies are created, stored, and later referenced
by external engines to enforce access controls on associated resources.
+
+ User provides the following inputs when creating a policy
+ - `name`(REQUIRED): The name of the policy.
+ - `type` (REQUIRED): The type of the policy. It can be either
predefined type or custom type.
+ - **Predefined Policies:** system.compaction,
system.snapshot_retention
+ - **Custom Policies:** custom.<org_name>.data_masking,
custom.<user_id>.audit_policy
Review Comment:
Good questions! `org_name` and `user_id` were just placeholders to
illustrate possible naming conventions, but there’s no strict required
structure. Predefined policies always follow the `system.*` prefix, while
custom policies could use any naming scheme, typically reflecting the package
path to the policy definition.
That said, since we don’t fully support custom policy types yet, it makes
more sense to document them comprehensively when we introduce proper validation
and guidance. I'll remove the mention of custom policies for now and revisit
this when we add full support.
cc @flyrain
##########
spec/polaris-catalog-apis/policy-apis.yaml:
##########
@@ -0,0 +1,512 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+---
+paths:
+
+ /v1/{prefix}/namespaces/{namespace}/policies:
+ parameters:
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/prefix'
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/namespace'
+
+ post:
+ tags:
+ - Catalog API
+ summary: 'Create a policy in the given namespace'
+ operationId: createPolicy
+ description: |
+ Creates a policy within the specified namespace.
+
+ A policy defines a set of rules governing actions on specified
resources under predefined conditions.
+ In Apache Polaris, policies are created, stored, and later referenced
by external engines to enforce access controls on associated resources.
+
+ User provides the following inputs when creating a policy
+ - `name`(REQUIRED): The name of the policy.
+ - `type` (REQUIRED): The type of the policy.
+ - **Predefined Policies:** policies have a `system.*` prefix in
their type, such as `system.data_compaction`
+ - `description` (OPTIONAL): Provides details about the policy's
purpose and functionality
+ - `content` (OPTIONAL): Defines the rules that control actions and
access conditions on resources. The format can be JSON, SQL, or any other
format.
+
+ The policy content is validated against the policy's corresponding
validator upon creation.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreatePolicyRequest'
+ responses:
+ 200:
+ $ref: '#/components/responses/CreatePolicyResponse'
+ 400:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ForbiddenResponse'
+ 419:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServerErrorResponse'
+
+ /v1/{prefix}/namespaces/{namespace}/policies/{policyName}:
+ parameters:
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/prefix'
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/namespace'
+ - $ref: '#/components/parameters/policy-name'
+
+ get:
+ tags:
+ - Catalog API
+ summary: 'Get a policy'
+ operationId: getPolicy
+ description: |
+ Get a policy from the catalog
+
+ The response contains the policy's metadata and content. For more
details, refer to the definition of the `Policy` model.
+ responses:
+ 200:
+ $ref: '#/components/responses/LoadPolicyResponse'
+ 400:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ForbiddenResponse'
+ 404:
+ description:
+ Not Found - NoSuchPolicyException, policy to get does not exist
+ content:
+ application/json:
+ schema:
+ $ref:
'../rest-catalog-open-api.yaml#/components/schemas/IcebergErrorResponse'
+ examples:
+ PolicyToGetDoesNotExist:
+ $ref: '#/components/examples/NoSuchPolicyError'
+ 419:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServerErrorResponse'
+
+ put:
+ tags:
+ - Catalog API
+ summary: Update a policy
+ operationId: updatePolicy
+ description: |
+ Update a policy
+
+ A policy's description and content can be updated. The new content is
validated against the policy's corresponding validator.
+ Upon a successful update, the policy's version is incremented by 1.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdatePolicyRequest'
+
+ responses:
+ 200:
+ $ref: '#/components/responses/UpdatePolicyResponse'
+ 400:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ForbiddenResponse'
+ 404:
+ description:
+ Not Found - NoSuchPolicyException, policy to get does not exist
+ content:
+ application/json:
+ schema:
+ $ref:
'../rest-catalog-open-api.yaml#/components/schemas/IcebergErrorResponse'
+ examples:
+ PolicyToUpdateDoesNotExist:
+ $ref: '#/components/examples/NoSuchPolicyError'
+ 419:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServerErrorResponse'
+
+ delete:
+ tags:
+ - Catalog API
+ summary: Delete a policy from the catalog
+ operationId: deletePolicy
+ description: Remove a policy from the catalog
+ responses:
+ 204:
+ description: Success, no content
+ 400:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ForbiddenResponse'
+ 404:
+ description:
+ Not Found - NoSuchPolicyException, policy to get does not exist
+ content:
+ application/json:
+ schema:
+ $ref:
'../rest-catalog-open-api.yaml#/components/schemas/IcebergErrorResponse'
+ examples:
+ PolicyToDeleteDoesNotExist:
+ $ref: '#/components/examples/NoSuchPolicyError'
+ 419:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServerErrorResponse'
+
+ /v1/{prefix}/namespaces/{namespace}/policies/{policyName}/mappings:
+ parameters:
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/prefix'
+ - $ref: '../rest-catalog-open-api.yaml#/components/parameters/namespace'
+ - $ref: '#/components/parameters/policy-name'
+
+ put:
+ tags:
+ - Catalog API
+ summary: Create a mapping between a policy and a resource entity
+ operationId: setPolicy
+ description: |
+ Create a mapping between a policy and a resource entity
+
+ Policy can be set at different levels:
+ 1. **Table-like level:** Policies specific to individual tables,
views, or other table-like entities.
+ 2. **Namespace level:** Policies applies to a namespace.
+ 3. **Catalog level:** Policies that applies to a catalog
+
+ Additional parameters can be provided in `parameters` when creating a
mapping to define specific behavior or constraints.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SetPolicyRequest'
+
+ responses:
+ 204:
+ description: Success, no content
+ 400:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/BadRequestErrorResponse'
+ 401:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/UnauthorizedResponse'
+ 403:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ForbiddenResponse'
+ 404:
+ description:
+ Not Found - NoSuchPolicyException, NoSuchEntityException
+ content:
+ application/json:
+ schema:
+ $ref:
'../rest-catalog-open-api.yaml#/components/schemas/IcebergErrorResponse'
+ examples:
+ PolicyToSetDoesNotExist:
+ $ref: '#/components/examples/NoSuchPolicyError'
+ EntityToSetDoesNotExist:
+ $ref: '#/components/examples/NoSuchEntityError'
+ 419:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/AuthenticationTimeoutResponse'
+ 503:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServiceUnavailableResponse'
+ 5XX:
+ $ref:
'../rest-catalog-open-api.yaml#/components/responses/ServerErrorResponse'
+
+ post:
Review Comment:
Missed in previous commit. This should be `post` instead of `delete` because
DELETE operation should not have non-empty request body:
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
Similar to:
https://github.com/apache/polaris/blob/f9a24d4f43f0c8060bc7d0fe257184f250a42cfd/spec/polaris-management-service.yml#L728-L730
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
