Skip to content

[#6860] docs: add OpenAPI docs for fileset/files #7334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

yunchipang
Copy link
Contributor

@yunchipang yunchipang commented Jun 4, 2025

What changes were proposed in this pull request?

Add OpenAPI doc for fileset/files endpoint

Why are the changes needed?

To generate docs for the new API endpoint at fileset/files
Fix: #7328

Does this PR introduce any user-facing change?

Yes, new REST API doc

How was this patch tested?

CI pass

@mchades mchades added the branch-0.9 Automatically cherry-pick commit to branch-0.9 label Jun 5, 2025
@yunchipang yunchipang requested a review from mchades June 5, 2025 20:53
Copy link
Contributor

@mchades mchades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plz fix the CI

@yunchipang yunchipang requested a review from mchades June 6, 2025 17:45
type: integer
format: int32
description: Status code of the response
enum: [0]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mchades I reverted this change to make CI pass. It seems like they require an array, and I believe this is the same as

enum
  - 0

Copy link
Contributor

@mchades mchades left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

@mchades mchades merged commit 45b6609 into apache:main Jun 7, 2025
30 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 7, 2025
### What changes were proposed in this pull request?

Add OpenAPI doc for fileset/files endpoint

### Why are the changes needed?

To generate docs for the new API endpoint at fileset/files
Fix: #7328

### Does this PR introduce _any_ user-facing change?

Yes, new REST API doc

### How was this patch tested?

CI pass
@yunchipang yunchipang deleted the docs/add-openapi-doc-for-list-fileset-files branch June 10, 2025 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch-0.9 Automatically cherry-pick commit to branch-0.9
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Subtask] Add OpenAPI doc for listing directories and files in FilesetCatalog
2 participants