You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@iceberg.apache.org by Kevin Liu <ke...@apache.org> on 2025/12/03 17:29:58 UTC

apply yaml linter to IRC/S3 spec yamls

Hey folks,

I have an open PR #14686[1] to add a new yaml linter and to enforce
consistent formatting for these 2 spec yamls:
- *open-api/rest-catalog-open-api.yaml*
- *aws/src/main/resources/s3-signer-open-api.yaml*

It is using the python `yamllint` tool [2] and introduces 3 new
make commands:
```
make validate-spec
make lint-spec
make lint  # runs the 2 above
```
The linter is enforced in CI via the "Open-API" github workflow.

The PR itself introduces minor formatting changes, and aims to make as few
changes as possible. We can continue to iterate on the formatting rules in
`open-api/.yamllint`.
Please take a look!

Best,
Kevin Liu


[1] https://github.com/apache/iceberg/pull/14686
[2] https://pypi.org/project/yamllint/
[3]
https://github.com/apache/iceberg/blob/bfe06a540d9d31d89b5161b20dcdcf6b1b6e2ef4/.github/workflows/open-api.yml#L50-L52

Re: apply yaml linter to IRC/S3 spec yamls

Posted by Kevin Liu <ke...@apache.org>.
This has been merged, thanks for the review!

On Thu, Dec 4, 2025 at 9:49 AM Yufei Gu <fl...@gmail.com> wrote:

> +1 on the linter. Thanks Kevin!
>
> Yufei
>
>
> On Wed, Dec 3, 2025 at 11:55 PM Eduard Tudenhöfner <
> etudenhoefner@apache.org> wrote:
>
>> Thanks Kevin for looking into this and the changes LGTM.
>>
>> On Wed, Dec 3, 2025 at 6:30 PM Kevin Liu <ke...@apache.org> wrote:
>>
>>> Hey folks,
>>>
>>> I have an open PR #14686[1] to add a new yaml linter and to enforce
>>> consistent formatting for these 2 spec yamls:
>>> - *open-api/rest-catalog-open-api.yaml*
>>> - *aws/src/main/resources/s3-signer-open-api.yaml*
>>>
>>> It is using the python `yamllint` tool [2] and introduces 3 new
>>> make commands:
>>> ```
>>> make validate-spec
>>> make lint-spec
>>> make lint  # runs the 2 above
>>> ```
>>> The linter is enforced in CI via the "Open-API" github workflow.
>>>
>>> The PR itself introduces minor formatting changes, and aims to make as
>>> few changes as possible. We can continue to iterate on the formatting rules
>>> in `open-api/.yamllint`.
>>> Please take a look!
>>>
>>> Best,
>>> Kevin Liu
>>>
>>>
>>> [1] https://github.com/apache/iceberg/pull/14686
>>> [2] https://pypi.org/project/yamllint/
>>> [3]
>>> https://github.com/apache/iceberg/blob/bfe06a540d9d31d89b5161b20dcdcf6b1b6e2ef4/.github/workflows/open-api.yml#L50-L52
>>>
>>

Re: apply yaml linter to IRC/S3 spec yamls

Posted by Yufei Gu <fl...@gmail.com>.
+1 on the linter. Thanks Kevin!

Yufei


On Wed, Dec 3, 2025 at 11:55 PM Eduard Tudenhöfner <et...@apache.org>
wrote:

> Thanks Kevin for looking into this and the changes LGTM.
>
> On Wed, Dec 3, 2025 at 6:30 PM Kevin Liu <ke...@apache.org> wrote:
>
>> Hey folks,
>>
>> I have an open PR #14686[1] to add a new yaml linter and to enforce
>> consistent formatting for these 2 spec yamls:
>> - *open-api/rest-catalog-open-api.yaml*
>> - *aws/src/main/resources/s3-signer-open-api.yaml*
>>
>> It is using the python `yamllint` tool [2] and introduces 3 new
>> make commands:
>> ```
>> make validate-spec
>> make lint-spec
>> make lint  # runs the 2 above
>> ```
>> The linter is enforced in CI via the "Open-API" github workflow.
>>
>> The PR itself introduces minor formatting changes, and aims to make as
>> few changes as possible. We can continue to iterate on the formatting rules
>> in `open-api/.yamllint`.
>> Please take a look!
>>
>> Best,
>> Kevin Liu
>>
>>
>> [1] https://github.com/apache/iceberg/pull/14686
>> [2] https://pypi.org/project/yamllint/
>> [3]
>> https://github.com/apache/iceberg/blob/bfe06a540d9d31d89b5161b20dcdcf6b1b6e2ef4/.github/workflows/open-api.yml#L50-L52
>>
>

Re: apply yaml linter to IRC/S3 spec yamls

Posted by Eduard Tudenhöfner <et...@apache.org>.
Thanks Kevin for looking into this and the changes LGTM.

On Wed, Dec 3, 2025 at 6:30 PM Kevin Liu <ke...@apache.org> wrote:

> Hey folks,
>
> I have an open PR #14686[1] to add a new yaml linter and to enforce
> consistent formatting for these 2 spec yamls:
> - *open-api/rest-catalog-open-api.yaml*
> - *aws/src/main/resources/s3-signer-open-api.yaml*
>
> It is using the python `yamllint` tool [2] and introduces 3 new
> make commands:
> ```
> make validate-spec
> make lint-spec
> make lint  # runs the 2 above
> ```
> The linter is enforced in CI via the "Open-API" github workflow.
>
> The PR itself introduces minor formatting changes, and aims to make as few
> changes as possible. We can continue to iterate on the formatting rules in
> `open-api/.yamllint`.
> Please take a look!
>
> Best,
> Kevin Liu
>
>
> [1] https://github.com/apache/iceberg/pull/14686
> [2] https://pypi.org/project/yamllint/
> [3]
> https://github.com/apache/iceberg/blob/bfe06a540d9d31d89b5161b20dcdcf6b1b6e2ef4/.github/workflows/open-api.yml#L50-L52
>