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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix marshalling docs for Java #1367

Open
ktoso opened this issue Aug 18, 2017 · 10 comments
Open

Fix marshalling docs for Java #1367

ktoso opened this issue Aug 18, 2017 · 10 comments
Assignees
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation

Comments

@ktoso
Copy link
Member

ktoso commented Aug 18, 2017

This one was very very embarrassing to find...

The marshalling page for JavaDSL is ScalaDSL 馃槶 "TODO overhaul for Java"
We did not notice for quite some time it seems...

http://doc.akka.io/docs/akka-http/current/java/http/common/marshalling.html
We've had this since 2.4: http://doc.akka.io/docs/akka/2.4.10/java/http/common/marshalling.html

We have to fix this soon.

@ktoso ktoso added 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted 2 - pick next Used to mark issues which are next up in the queue to be worked on. The tag is non-binding help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation labels Aug 18, 2017
@ktoso
Copy link
Member Author

ktoso commented Aug 18, 2017

Help would be very welcome... I'll be away some days now sadly...

cc @jrudolph @jonas @jlprat @jypma

@ktoso ktoso added this to the 10.0.10 milestone Aug 18, 2017
@ktoso
Copy link
Member Author

ktoso commented Aug 18, 2017

Perhaps worth re-looking into the API? https://stackoverflow.com/questions/43973923/akka-http-marshalling-pojo

@jlprat
Copy link
Member

jlprat commented Aug 18, 2017

Re-looking into the API without breaking backwards compatibility, right? Or can we be more aggressive?

@ktoso
Copy link
Member Author

ktoso commented Aug 18, 2017

Re-looking into the API without breaking backwards compatibility, right?

Why? Completely unrelated. We can add a method there - see the DoNotInherit annotation definitions

@jlprat
Copy link
Member

jlprat commented Aug 18, 2017

Sorry, lack of coffee, and wrote that without looking at the code. All good :)

@jonas
Copy link
Member

jonas commented Aug 19, 2017

Note that there's the Java only docs/src/main/paradox/java/http/routing-dsl/marshalling.md which briefly introduces marshalling and unmarshalling and was added in #400.

@raboof raboof modified the milestones: 10.0.10, 10.0.11 Aug 31, 2017
@jonas
Copy link
Member

jonas commented Oct 24, 2017

I plan to fix this as part of the doc merge #1290 of common/marshalling.md similar to what was already done for the unmarshalling doc merge.

@jonas jonas self-assigned this Oct 24, 2017
@jrudolph jrudolph removed this from the 10.0.11 milestone Nov 30, 2017
@raboof
Copy link
Member

raboof commented Dec 6, 2017

@jonas I see you have some work underway master...jonas:merge-common-marshalling - is that ready for a PR?

@jonas
Copy link
Member

jonas commented Dec 6, 2017

@raboof It's almost there. I will make a PR today.

@jrudolph
Copy link
Member

jrudolph commented Dec 6, 2017

Cool, great!

@raboof raboof removed 2 - pick next Used to mark issues which are next up in the queue to be worked on. The tag is non-binding labels Jun 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Identifies issues that the core team will likely not have time to work on t:docs Issues related to the documentation
Projects
None yet
Development

No branches or pull requests

5 participants