Skip to content
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

Few minor issues on https://docs.hiro.so/stacks/api/info/total-and-unlocked-stx-supply #753

Closed
diwakergupta opened this issue Sep 12, 2024 · 5 comments
Assignees

Comments

@diwakergupta
Copy link
Member

Description has unnecessary reference to Stacking, which anyways should have been an actual link (vs. in-lining the URL)

Screenshot 2024-09-12 at 1 51 59 PM

In the response description, we talk about "target block times" but this endpoint is for STX supply -- looks like copy pasta from a different endpoint?

Screenshot 2024-09-12 at 1 53 26 PM
@diwakergupta
Copy link
Member Author

Now that the API has implemented changes discussed in this doc, we should update the documentation accordingly.

In particular, document the new total_stx_year_2050 field, deprecations of some legacy endpoints etc.

cc/ @zone117x

@ryanwaits
Copy link
Collaborator

Description has unnecessary reference to Stacking, which anyways should have been an actual link (vs. in-lining the URL)

In the response description, we talk about "target block times" but this endpoint is for STX supply

so this copy is still being pulled in with a fresh pull of the OpenAPI spec. i can get this fixed in docs for now, but will need to target the source of the issue to avoid the problem in the future.

In particular, document the new total_stx_year_2050 field, deprecations of some legacy endpoints etc.

i can update this accordingly

@ryanwaits ryanwaits mentioned this issue Oct 1, 2024
5 tasks
@diwakergupta
Copy link
Member Author

so this copy is still being pulled in with a fresh pull of the OpenAPI spec. i can get this fixed in docs for now, but will need to target the source of the issue to avoid the problem in the future.

@zone117x if the source of truth is in the API repo, can we open an issue to track this?

@ryanwaits
Copy link
Collaborator

so this copy is still being pulled in with a fresh pull of the OpenAPI spec. i can get this fixed in docs for now, but will need to target the source of the issue to avoid the problem in the future.

@zone117x if the source of truth is in the API repo, can we open an issue to track this?

i can take a look at this and report back - added this to our board https://github.com/orgs/hirosystems/projects/50/views/1?pane=issue&itemId=81806865

@ryanwaits
Copy link
Collaborator

also this is fixed: #761

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Status: No status
Development

No branches or pull requests

2 participants