mchades commented on code in PR #6088: URL: https://github.com/apache/gravitino/pull/6088#discussion_r1904270965
########## 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: > This is an obvious abuse of the HTTP status code. Your interpretation of "target resource" seems too narrow in the context of RESTful APIs. The HTTP specification ([RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.4)) states that 404 applies when "the origin server did not find a current representation for the target resource." In REST, each path segment is considered a resource, not just the final element. GitHub's API provides a clear example of this practice. Consider their endpoint for getting a repository: GET /repos/{owner}/{repo} If either the {owner} or {repo} doesn't exist, GitHub returns a 404 status code. For instance, requesting https://api.github.com/repos/nonexistent-user/some-repo returns 404, even though the error is in the 'owner' part of the path, not the final resource. You can verify this behavior and see the documentation here: https://docs.github.com/en/rest/repos/repos#get-a-repository This approach aligns with RESTful design principles, providing clear feedback about resource availability throughout the URL path, and is consistent with industry best practices. -- 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]
