lasdf1234 commented on code in PR #10971: URL: https://github.com/apache/gravitino/pull/10971#discussion_r3213111202
########## docs/open-api/idp.yaml: ########## @@ -0,0 +1,514 @@ +# 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: + + /idp/users: + post: + tags: + - authentication + summary: Add built-in IdP user + operationId: addIdpUser + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIdpUserRequest" + examples: + CreateIdpUserRequest: + $ref: "#/components/examples/CreateIdpUserRequest" + responses: + "200": + description: Returns the added built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "409": + description: Conflict - The target built-in IdP user already exists + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + UserAlreadyExistsException: + $ref: "#/components/examples/UserAlreadyExistsException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/users/{user}: + parameters: + - $ref: "./openapi.yaml#/components/parameters/user" + + get: + tags: + - authentication + summary: Get built-in IdP user + operationId: getIdpUser + responses: + "200": + description: Returns the built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + put: + tags: + - authentication + summary: Reset built-in IdP user password + operationId: resetIdpUserPassword + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ResetIdpUserPasswordRequest" + examples: + ResetIdpUserPasswordRequest: + $ref: "#/components/examples/ResetIdpUserPasswordRequest" + responses: + "200": + description: Returns the updated built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + delete: + tags: + - authentication + summary: Remove built-in IdP user + operationId: removeIdpUser + responses: + "200": + $ref: "./openapi.yaml#/components/responses/RemoveResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/groups: + post: + tags: + - authentication + summary: Add built-in IdP group + operationId: addIdpGroup + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIdpGroupRequest" + examples: + CreateIdpGroupRequest: + $ref: "#/components/examples/CreateIdpGroupRequest" + responses: + "200": + description: Returns the added built-in IdP group + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpGroupResponse" + examples: + IdpGroupResponse: + $ref: "#/components/examples/IdpGroupResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "409": + description: Conflict - The target built-in IdP group already exists + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + GroupAlreadyExistsException: + $ref: "#/components/examples/GroupAlreadyExistsException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/groups/{group}: + parameters: + - $ref: "./openapi.yaml#/components/parameters/group" + + get: + tags: + - authentication + summary: Get built-in IdP group + operationId: getIdpGroup + responses: + "200": + description: Returns the built-in IdP group + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpGroupResponse" + examples: + IdpGroupResponse: + $ref: "#/components/examples/IdpGroupResponse" + "404": + description: Not Found - The specified built-in IdP group does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchGroupException: + $ref: "#/components/examples/NoSuchGroupException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + delete: + tags: + - authentication + summary: Remove built-in IdP group + operationId: removeIdpGroup + parameters: + - name: force + in: query + required: false + schema: + type: boolean + default: false + description: Whether to force removal of the built-in IdP group + responses: + "200": + $ref: "./openapi.yaml#/components/responses/RemoveResponse" + "404": + description: Not Found - The specified built-in IdP group does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchGroupException: + $ref: "#/components/examples/NoSuchGroupException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" Review Comment: Fixed. The OpenAPI spec now documents the actual `200`/`removed=false` behavior for missing groups and includes both the `403` and `405` responses for delete-group. ########## docs/open-api/idp.yaml: ########## @@ -0,0 +1,514 @@ +# 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: + + /idp/users: + post: + tags: + - authentication + summary: Add built-in IdP user + operationId: addIdpUser + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIdpUserRequest" + examples: + CreateIdpUserRequest: + $ref: "#/components/examples/CreateIdpUserRequest" + responses: + "200": + description: Returns the added built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "409": + description: Conflict - The target built-in IdP user already exists + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + UserAlreadyExistsException: + $ref: "#/components/examples/UserAlreadyExistsException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/users/{user}: + parameters: + - $ref: "./openapi.yaml#/components/parameters/user" + + get: + tags: + - authentication + summary: Get built-in IdP user + operationId: getIdpUser + responses: + "200": + description: Returns the built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + put: + tags: + - authentication + summary: Reset built-in IdP user password + operationId: resetIdpUserPassword + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ResetIdpUserPasswordRequest" + examples: + ResetIdpUserPasswordRequest: + $ref: "#/components/examples/ResetIdpUserPasswordRequest" + responses: + "200": + description: Returns the updated built-in IdP user + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpUserResponse" + examples: + IdpUserResponse: + $ref: "#/components/examples/IdpUserResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + delete: + tags: + - authentication + summary: Remove built-in IdP user + operationId: removeIdpUser + responses: + "200": + $ref: "./openapi.yaml#/components/responses/RemoveResponse" + "404": + description: Not Found - The specified built-in IdP user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/groups: + post: + tags: + - authentication + summary: Add built-in IdP group + operationId: addIdpGroup + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateIdpGroupRequest" + examples: + CreateIdpGroupRequest: + $ref: "#/components/examples/CreateIdpGroupRequest" + responses: + "200": + description: Returns the added built-in IdP group + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpGroupResponse" + examples: + IdpGroupResponse: + $ref: "#/components/examples/IdpGroupResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "409": + description: Conflict - The target built-in IdP group already exists + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + GroupAlreadyExistsException: + $ref: "#/components/examples/GroupAlreadyExistsException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/groups/{group}: + parameters: + - $ref: "./openapi.yaml#/components/parameters/group" + + get: + tags: + - authentication + summary: Get built-in IdP group + operationId: getIdpGroup + responses: + "200": + description: Returns the built-in IdP group + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpGroupResponse" + examples: + IdpGroupResponse: + $ref: "#/components/examples/IdpGroupResponse" + "404": + description: Not Found - The specified built-in IdP group does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchGroupException: + $ref: "#/components/examples/NoSuchGroupException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + delete: + tags: + - authentication + summary: Remove built-in IdP group + operationId: removeIdpGroup + parameters: + - name: force + in: query + required: false + schema: + type: boolean + default: false + description: Whether to force removal of the built-in IdP group + responses: + "200": + $ref: "./openapi.yaml#/components/responses/RemoveResponse" + "404": + description: Not Found - The specified built-in IdP group does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchGroupException: + $ref: "#/components/examples/NoSuchGroupException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + + /idp/groups/{group}/add: + parameters: + - $ref: "./openapi.yaml#/components/parameters/group" + + put: + tags: + - authentication + summary: Add users to built-in IdP group + operationId: addUsersToIdpGroup + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/UpdateIdpGroupUsersRequest" + examples: + UpdateIdpGroupUsersRequest: + $ref: "#/components/examples/UpdateIdpGroupUsersRequest" + responses: + "200": + description: Returns the updated built-in IdP group + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/schemas/IdpGroupResponse" + examples: + IdpGroupResponse: + $ref: "#/components/examples/IdpGroupResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "404": + description: Not Found - The specified built-in IdP group or user does not exist + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "./openapi.yaml#/components/schemas/ErrorModel" + examples: + NoSuchGroupException: + $ref: "#/components/examples/NoSuchGroupException" + NoSuchUserException: + $ref: "#/components/examples/NoSuchUserException" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" Review Comment: Fixed. The OpenAPI spec now documents the `403` response for the built-in IdP group membership mutation endpoints. -- 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]
