sfc-gh-yzou commented on code in PR #808: URL: https://github.com/apache/polaris/pull/808#discussion_r1980364343
########## spec/polaris-catalog-apis/policy-apis.yaml: ########## @@ -0,0 +1,508 @@ +# +# 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: 'Load a policy' + operationId: loadPolicy + description: | + Load 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: Drop a policy from the catalog + operationId: dropPolicy + 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: + tags: + - Catalog API + summary: Remove a mapping between a policy and a resource entity + operationId: unsetPolicy + description: | + Remove a mapping between a policy and a resource entity + + A resource entity can be a catalog, namespace, or any table-like entity + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnsetPolicyRequest' + + 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, NoSuchMappingException + content: + application/json: + schema: + $ref: '../rest-catalog-open-api.yaml#/components/schemas/IcebergErrorResponse' + examples: + PolicyToUnsetDoesNotExist: + $ref: '#/components/examples/NoSuchPolicyError' + EntityToUnsetDoesNotExist: + $ref: '#/components/examples/NoSuchEntityError' + MappingToUnsetDoesNotExist: + $ref: '#/components/examples/NoSuchMappingError' + 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' + + +components: + parameters: + policy-name: + name: policyName + in: path + required: true + schema: + $ref: '#/components/schemas/PolicyName' + + schemas: + PolicyName: + type: string + description: + A policy name. A valid policy name should only consist of uppercase and lowercase letters (A-Z, a-z), + digits (0-9), hyphens (-), underscores (_). + pattern: '^[A-Za-z0-9\-_]+$' + example: 'compaction' + + Policy: + type: object + description: | + A policy in Apache Polaris defines a set of rules for governing access, data usage, and operational consistency across various catalog resources. + Policies are stored within Polaris and can be applied to catalogs, namespaces, tables, views, and other table-like entities. + For example, they can be used for fine-grained control over who can perform specific actions on certain resources. + + The policy object includes + - **policy-type:** The type of the policy, which determines the expected format and semantics of the policy content. + - **name:** A human-readable name for the policy, which must be unique within a given namespace. + - **description:** Detailed description of the purpose and functionalities of the policy. + - **content:** Policy content, which can be validated against predefined schemas of a policy type. + - **version:** Indicates the current version of the policy. Versions increased monotonically, the default value is 0 + - **created_at:** A timestamp (in milliseconds) indicating when the policy was created. + - **updated_at:** A timestamp (in milliseconds) indicating the last update time of the policy. + + Policies stored in Polaris serve as the persistent definition for access control and governance rules. + required: + - policy-type + - name + - version + properties: + policy-type: + type: string + name: + $ref: '#/components/schemas/PolicyName' + description: + type: string + content: + type: string + version: + type: integer + created-at-ms: + type: integer + format: int64 + updated-at-ms: + type: integer + format: int64 + + CreatePolicyRequest: + type: object + required: + - name + - type + properties: + name: + $ref: '#/components/schemas/PolicyName' + type: + type: string + description: + type: string + content: + type: string + + LoadPolicyResult: + type: object + properties: + policy: + $ref: '#/components/schemas/Policy' + + UpdatePolicyRequest: + type: object + properties: + description: + type: string + content: + type: string + + SetPolicyRequest: + type: object + required: + - entity + properties: + entity: + $ref: '#/components/schemas/EntityIdentifier' + parameters: + type: object + additionalProperties: + type: string + + UnsetPolicyRequest: + type: object + required: + - entity + properties: + entity: + $ref: '#/components/schemas/EntityIdentifier' + + CatalogIdentifier: + allOf: + - $ref: '#/components/schemas/EntityIdentifier' + - type: object + required: + - catalog + properties: + catalog: + type: string + + NamespaceIdentifier: + allOf: + - $ref: '#/components/schemas/EntityIdentifier' + - type: object + required: + - catalog + - namespace + properties: + catalog: + type: string + nullable: false + namespace: + $ref: '../rest-catalog-open-api.yaml#/components/schemas/Namespace' + + TableLikeIdentifier: + allOf: + - $ref: '#/components/schemas/EntityIdentifier' + - type: object + required: + - catalog + - namespace + - name + properties: + catalog: + type: string + nullable: false + namespace: + $ref: '../rest-catalog-open-api.yaml#/components/schemas/Namespace' + name: + type: string + nullable: false + + EntityIdentifier: + type: object + discriminator: + propertyName: type + mapping: + catalog: '#/components/schemas/CatalogIdentifier' + namespace: '#/components/schemas/NamespaceIdentifier' + table-like: '#/components/schemas/TableLikeIdentifier' + properties: + type: + type: string + enum: + - catalog + - namespace + - table-like + required: + - type + + responses: + CreatePolicyResponse: Review Comment: @HonahX it seems there will be no generated class for the responses, do we plan to use LoadPolicyResult directly as the result of the API? -- 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]
