Skip to content

docs(fdw): correct relationships table caveat columns#3229

Open
capybara-alt wants to merge 1 commit into
authzed:mainfrom
capybara-alt:docs/fix-fdw-relationships-columns
Open

docs(fdw): correct relationships table caveat columns#3229
capybara-alt wants to merge 1 commit into
authzed:mainfrom
capybara-alt:docs/fix-fdw-relationships-columns

Conversation

@capybara-alt

@capybara-alt capybara-alt commented Jul 13, 2026

Copy link
Copy Markdown

Description

Fixes incorrect caveat column names and types in internal/fdw/README.md.

The documentation currently describes:

  • optional_caveat_name (text)
  • optional_caveat_context (jsonb)

However, the implementation and the example configuration use:

  • caveat_name (text)
  • caveat_context (text)

This PR updates the documentation to match the current implementation.

Testing

Verified that the documentation matches:

  • internal/fdw/tables/relationships.go
  • internal/fdw/configuration.sql

Documentation change only. No functional changes.

References

Closes #3227

@capybara-alt capybara-alt requested a review from a team as a code owner July 13, 2026 15:24
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@tstirrat15 tstirrat15 force-pushed the docs/fix-fdw-relationships-columns branch from bfe163b to 4c1f657 Compare July 13, 2026 16:47
@tstirrat15

Copy link
Copy Markdown
Contributor

Thank you!

@tstirrat15 tstirrat15 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTm

@tstirrat15

Copy link
Copy Markdown
Contributor

We'll need you to sign the CLA as a last step.

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@capybara-alt

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

@capybara-alt

Copy link
Copy Markdown
Author

recheck

authzedbot added a commit to authzed/cla that referenced this pull request Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Incorrect caveat column names and types in internal/fdw/README.md

2 participants