tengqm commented on code in PR #6088: URL: https://github.com/apache/gravitino/pull/6088#discussion_r1904862735
########## docs/open-api/credentials.yaml: ########## @@ -0,0 +1,130 @@ +# 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: + + /metalakes/{metalake}/objects/{metadataObjectType}/{metadataObjectFullName}/credentials: + parameters: + - $ref: "./openapi.yaml#/components/parameters/metalake" + - $ref: "./openapi.yaml#/components/parameters/metadataObjectType" + - $ref: "./openapi.yaml#/components/parameters/metadataObjectFullName" + get: + tags: + - credentials + summary: Get credentials + operationId: getCredentials + responses: + "200": + description: Returns the list of credential objects associated with specified metadata object. + content: + application/vnd.gravitino.v1+json: + schema: + $ref: "#/components/responses/CredentialResponse" + examples: + CredentialResponse: + $ref: "#/components/examples/CredentialResponse" + "400": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "404": Review Comment: There have been maaany debates on this. And I don't think we will change that. See: - https://stackoverflow.com/questions/9930695/rest-api-404-bad-uri-or-missing-resource - https://dev.to/mdamaceno/404-status-code-really-11k6 Some examples: - https://docs.openstack.org/api-ref/compute/#list-servers, No 404 is returned for a list operation. - https://docs.openstack.org/api-ref/compute/#show-server-details, 404 means the server is not found. What I was trying to advocate is this clear distinction as some people suggested: <img width="605" alt="image" src="https://github.com/user-attachments/assets/c6bb89cb-e850-425d-98f6-fdd6ae466200"; /> Or, this <img width="731" alt="image" src="https://github.com/user-attachments/assets/15b432ec-7fec-42d7-9e2a-0b68f60bbcfd"; /> It makes the life for a client developer much easier. Whatever, this discussion can end here. -- 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]
