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

feat: allow using the existing numeric table IDs in the API #690

Merged

Conversation

CamilleLegeron
Copy link
Collaborator

@CamilleLegeron CamilleLegeron commented Oct 9, 2023

Context

#679

Realized in this PR

Allow using the existing numeric tableId in the API called tableRef in the code. We change nothing in the API, just allow to used tableRef instead of tableId in the endpoint url

@CamilleLegeron CamilleLegeron changed the title feat add technical id for tableId feat: allow using the existing numeric table IDs in the API Oct 9, 2023
@CamilleLegeron CamilleLegeron marked this pull request as ready for review October 9, 2023 14:22
@alexmojaki alexmojaki self-requested a review October 10, 2023 13:26
@CamilleLegeron
Copy link
Collaborator Author

Once this approach is validated, I could look into doing tests, and if you explain to me how to do it, adapt the documentation

@alexmojaki
Copy link
Contributor

Looks good! Can you add a couple of DocApi tests?

@alexmojaki alexmojaki merged commit f66ecbd into gristlabs:main Oct 12, 2023
12 of 13 checks passed
@alexmojaki
Copy link
Contributor

Thank you!

For the documentation, I think it's just a matter of updating this line:

https://github.com/gristlabs/grist-help/blob/f5dcca7bbab4ce2ed444a61311babe3d395f75c0/api/grist.yml#L2111

description: name of a table (normalized)

I think the original description could also be clearer. @dsagal how does this sound?

description: normalized table name (see TABLE ID in Raw Data) or numeric row ID in _grist_Tables

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.

2 participants