Skip to content

Improve getEvents documentation surrounding filters#2084

Merged
ElliotFriend merged 6 commits into
mainfrom
getEvents-docs
Dec 15, 2025
Merged

Improve getEvents documentation surrounding filters#2084
ElliotFriend merged 6 commits into
mainfrom
getEvents-docs

Conversation

@Shaptic

@Shaptic Shaptic commented Dec 3, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Closes #2077.

This clarifies the format of a topic filter and introduces an example using the new ** topic syntax. Even though the filters were already defined, they weren't being rendered in the generated docs. Unfortunately another suggestion isn't possible:

Also, change the array[array] to be more descriptive, something like array[array[SegmentMatcher]].

Because types must be OpenRPC primitive types.

@stellar-jenkins

stellar-jenkins commented Dec 3, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

1 similar comment
@stellar-jenkins

stellar-jenkins commented Dec 3, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

leighmcculloch
leighmcculloch reviewed Dec 3, 2025
View reviewed changes

@leighmcculloch leighmcculloch left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for taking this. One ask and one question.

Comment thread openrpc/src/stellar-rpc/schemas/EventFilters.json
Comment thread openrpc/src/stellar-rpc/examplePairingObjects/EventsPairs.json Outdated
@stellar-jenkins

stellar-jenkins commented Dec 3, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

2 similar comments
@stellar-jenkins

stellar-jenkins commented Dec 3, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

@stellar-jenkins

stellar-jenkins commented Dec 3, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

@urvisavla

urvisavla commented Dec 3, 2025

Copy link
Copy Markdown
Contributor

Even though the filters were already defined, they weren't being rendered in the generated docs.

I previously highlighted this exact issue when working on the getevents documentation but it wasn't addressed at the time.

@stellar-jenkins

stellar-jenkins commented Dec 15, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

@stellar-jenkins

stellar-jenkins commented Dec 15, 2025

Copy link
Copy Markdown

Preview is available here:
http://developers-pr2084.previews.kube001.services.stellar-ops.com

@ElliotFriend ElliotFriend merged commit 77e8575 into main Dec 15, 2025
9 checks passed
@ElliotFriend ElliotFriend deleted the getEvents-docs branch December 15, 2025 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leighmcculloch leighmcculloch leighmcculloch approved these changes

@ElliotFriend ElliotFriend Awaiting requested review from ElliotFriend

@urvisavla urvisavla Awaiting requested review from urvisavla

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

getEvents topics parameter documentation is ambiguous about array structure

5 participants

@Shaptic @stellar-jenkins @urvisavla @leighmcculloch @ElliotFriend