Skip to content

fix(follower): add experimental tag to deltas endpoint. #5169

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.

Sign up for GitHub

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
winder merged 1 commit into from
Feb 28, 2023
Merged

fix(follower): add experimental tag to deltas endpoint. #5169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion daemon/algod/api/algod.oas2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1439,7 +1439,8 @@
"description": "Get ledger deltas for a round.",
"tags": [
"public",
"data"
"data",
"experimental"
],
"produces": [
"application/json",
Expand Down
3 changes: 2 additions & 1 deletion daemon/algod/api/algod.oas3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3802,7 +3802,8 @@
"summary": "Get a LedgerStateDelta object for a given round",
"tags": [
"public",
"data"
"data",
"experimental"
]
}
},
Expand Down
6 changes: 4 additions & 2 deletions daemon/algod/api/server/v2/generated/data/data_routes.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ generate:
output-options:
include-tags:
- data
- public
# do not include endpoints tagged public/experimental
# - public
Comment on lines +8 to +9
Copy link
Copy Markdown
Contributor

@Eric-Warehime Eric-Warehime Feb 28, 2023

Choose a reason for hiding this comment

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

This works, but it's a bit hacky because the tags weren't meant to be overlapping like this--each set of APIs, gated by certain configs, is tagged as public or private to identify the authenticator required, and a single category.

This will introduce partially overlapping sets of tags in ways that could become messy in the future. But it does look like the only viable way we currently have to disable sdk code gen for an API w/o requiring the admin token.

exclude-tags:
- common
- private
- participating
- nonparticipating
- experimental
# do not exclude endpoints tagged data/experimental
# - experimental
type-mappings:
integer: uint64
skip-prune: true
Expand Down
16 changes: 8 additions & 8 deletions daemon/algod/api/server/v2/generated/data/routes.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.