You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "kevinjqliu (via GitHub)" <gi...@apache.org> on 2025/11/25 18:51:55 UTC

[PR] open-api: use yaml linter [iceberg]

kevinjqliu opened a new pull request, #14686:
URL: https://github.com/apache/iceberg/pull/14686

   Will rebase #14684 
   
   
   This PR adds a yaml linter for `rest-catalog-open-api.yaml` and `../aws/src/main/resources/s3-signer-open-api.yaml` to keep formatting consistent. 
   Using `yamlfix` to check and automatically fix formatting issues. 
   
   Introduced a few new Makefile commands
   ```
   make lint-format
   make lint-spec
   make lint # runs both above
   make lint-fix # auto fix yaml formatting issues
   ```
   


-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] OpenAPI: use yaml linter [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #14686:
URL: https://github.com/apache/iceberg/pull/14686#issuecomment-3617656528

   thanks for the review everyone! 


-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] open-api: use yaml linter [iceberg]

Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on code in PR #14686:
URL: https://github.com/apache/iceberg/pull/14686#discussion_r2582440866


##########
open-api/.yamllint:
##########
@@ -0,0 +1,29 @@
+# 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.
+
+---
+extends: default
+
+rules:
+  line-length:
+    max: 350

Review Comment:
   This seems pretty long?



-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] open-api: use yaml linter [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #14686:
URL: https://github.com/apache/iceberg/pull/14686#issuecomment-3603650559

   All changes to `aws/src/main/resources/s3-signer-open-api.yaml` and `open-api/rest-catalog-open-api.yaml` are formatting / cosmetic only.
   I tried to address each class of change in individual commits, https://github.com/apache/iceberg/pull/14686/commits
   
   Specifically, here are the list of yamllint errors:
   Fixed
     too few spaces before comment: expected 2  (comments)
     too few spaces after comma  (commas)
     trailing spaces  (trailing-spaces)
     wrong indentation: expected 16 but found 18  (indentation)
     too many blank lines (3 > 2)  (empty-lines)
   
   Ignored  
     too many spaces inside braces  (braces)
     too many spaces inside brackets  (brackets)
     too many spaces inside empty braces  (braces)
     too many spaces inside empty brackets  (brackets)
     line too long (123 > 120 characters)  (line-length)
   


-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] open-api: use yaml linter [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #14686:
URL: https://github.com/apache/iceberg/pull/14686#issuecomment-3607992719

   sent out an email to dev@. if there are no objections by EOW, i'll merge this PR
   
   https://lists.apache.org/thread/g4yqzltzs2n4jsdpln66yzz439vy0bpy


-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org


Re: [PR] OpenAPI: use yaml linter [iceberg]

Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu merged PR #14686:
URL: https://github.com/apache/iceberg/pull/14686


-- 
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: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org