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

There should be a way to always set return_fields_by_field_id to True on all supported calls. #365

Open
jonathanlaniado opened this issue Apr 16, 2024 · 5 comments

Comments

@jonathanlaniado
Copy link

Is this already supported? If so, I have not been able to find it. If not, then it would be a welcome feature addition!

@mesozoic
Copy link
Collaborator

This isn't supported today by the "traditional" API, but #355 added the ability to set this on every ORM model. That will be part of the 3.0 release.

If we wanted this to be a global setting, I think we'd need to add it as an optional parameter to the Api constructor, and we'd need to use that as the default value in places like this and this.

Is there a reason it's challenging to pass this flag to the API calls you're making?

@jonathanlaniado
Copy link
Author

If we wanted this to be a global setting, I think we'd need to add it as an optional parameter to the Api constructor, and we'd need to use that as the default value in places like this and this.

I'd love to see this happen. This is a great approach for implementation.

Is there a reason it's challenging to pass this flag to the API calls you're making?

It's not challenging as much as it is verbose. In large projects, it becomes redundant and wordy. Additionally, it's easy to forget to set it which can be frustrating in testing.

@mesozoic
Copy link
Collaborator

The tradeoff is a slightly more opaque API, because at the point where you're calling table.all() you don't necessarily know whether it's returning field names or field IDs. However, since the default behavior won't change, I'm not opposed to adding this in as long as it's well-tested. Pull requests are welcome! (Please read our contribution guidelines first.)

@BAPCon
Copy link
Contributor

BAPCon commented Apr 23, 2024

The tradeoff is a slightly more opaque API, because at the point where you're calling table.all() you don't necessarily know whether it's returning field names or field IDs. However, since the default behavior won't change, I'm not opposed to adding this in as long as it's well-tested. Pull requests are welcome! (Please read our contribution guidelines first.)

So basically taking the functionality of what is present in the ORM but for general API calls?

@mesozoic
Copy link
Collaborator

Same idea, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants