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 Roadmap to Readme #1054

Merged
merged 2 commits into from
Aug 30, 2019
Merged

Add Roadmap to Readme #1054

merged 2 commits into from
Aug 30, 2019

Conversation

kdavisk6
Copy link
Member

Propsed roadmap is now included in the readme.

Propsed roadmap is now included in the readme.
@kdavisk6 kdavisk6 requested a review from velo August 29, 2019 18:46
@kdavisk6 kdavisk6 added the documentation Issues that require updates to our documentation label Aug 29, 2019
Copy link
Member

@velo velo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, way better than my original comments. Awesome job. I'm good with it.

@@ -6,6 +6,41 @@

Feign is a Java to HTTP client binder inspired by [Retrofit](https://github.com/square/retrofit), [JAXRS-2.0](https://jax-rs-spec.java.net/nonav/2.0/apidocs/index.html), and [WebSocket](http://www.oracle.com/technetwork/articles/java/jsr356-1937161.html). Feign's first goal was reducing the complexity of binding [Denominator](https://github.com/Netflix/Denominator) uniformly to HTTP APIs regardless of [ReSTfulness](http://www.slideshare.net/adrianfcole/99problems).

---
# Roadmap
## Feign 11 and beyond
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think work mention that we will be breaking feign internal API? Which may affect people

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, should we have a compromise of what we are not going to break?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mention the breaking changes it in the Async section. Should I make it more prominent?

My thoughts are to defer any information on what is going to break and not going to break until we really dig into it. Anything we put out there now may be interpreted as fact when it's not.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fat finger the resolve conversation button.

Anyway, probably the retry changes will break some API too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's probably true. I'll update it.

Medium Term - What's up next. ⏲
---
* Metric API
* Provide a first-class Metrics API that user's can tap into to gain insight into the request/response lifecycle. Possibly provide better [OpenTracing](https://opentracing.io/) support.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was more thinking about timers and meters, not tracing, which is a nice to have too

https://metrics.dropwizard.io/4.0.0/

Added additional context to Retry and Async tasks to indicate
that these features will be breaking changes.
@kdavisk6 kdavisk6 merged commit d0106e3 into OpenFeign:master Aug 30, 2019
@kdavisk6 kdavisk6 deleted the readme-roadmap branch August 30, 2019 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that require updates to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants