Skip to content

Add description to request and response and version to the API.#27

Open
rmsj wants to merge 7 commits intoa-h:mainfrom
rmsj:main
Open

Add description to request and response and version to the API.#27
rmsj wants to merge 7 commits intoa-h:mainfrom
rmsj:main

Conversation

@rmsj
Copy link

@rmsj rmsj commented Sep 4, 2024

Change the method signature for Response, Request and the NewAPI one, to add version.

@a-h
Copy link
Owner

a-h commented Sep 4, 2024

This change would break everyone's existing code - i.e. if they upgrade the package, they'll get compilation errors.

I'm sure there's a way to add the version without breaking existing code, e.g. by using a WithVersion option.

Is there an issue driving this, or is it just a case of not liking the existing API design?

Thanks!

@rmsj
Copy link
Author

rmsj commented Sep 4, 2024

I see.
I've updated the changes following your idea with the option function. This it keeps backward compatibility with current users.
Let me know what you think.

Thank you for your work on this project.

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