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

add new column for required vs optional attributes of an API #436

Open
pratik151192 opened this issue Sep 22, 2023 · 1 comment
Open

add new column for required vs optional attributes of an API #436

pratik151192 opened this issue Sep 22, 2023 · 1 comment

Comments

@pratik151192
Copy link
Contributor

Do we have any plans to add a column for required vs optional attributes on our API signatures? https://docs.momentohq.com/cache/develop/api-reference. In some APIs I see we wrap an Optional word around the Type itself, but in some places we don't (ttl is optional as we default to cacheDefaultTTL).

I am particularly asking this as while writing certain examples or other stuff, I often referred to this documentation. But i couldn't figure out properly so resorted to my IDE to check if ? is present on TS, or Optional is present on Java. Usually I believe developers do read the API reference to figure such stuff.

@pratik151192
Copy link
Contributor Author

pratik151192 commented Sep 22, 2023

@eaddingtonwhite:

yea I agree. I think a dedicated column is good idea. I think if want to start that pattern 
then can make ticket to try and swarm on all them. 
Feel free cut over as many as you want to target state pattern though if your in there and easy change.

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

No branches or pull requests

1 participant