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.

Sign up for GitHub

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

Jump to bottom

Please add a section about .gateway() to the online DSL Documentation #3591

Closed
swiss-chris opened this issue Jul 16, 2021 · 2 comments · Fixed by #3593
Closed

Please add a section about .gateway() to the online DSL Documentation #3591

swiss-chris opened this issue Jul 16, 2021 · 2 comments · Fixed by #3593
Assignees
@artembilan
Labels
type: documentation
Milestone
5.5.2

Comments

@swiss-chris
Copy link
Contributor

Expected Behavior

https://docs.spring.io/spring-integration/reference/html/dsl.html#java-dsl-basics mentions .gateway() and possibly https://docs.spring.io/spring-integration/reference/html/dsl.html also has its own section about Gateways, e.g. https://docs.spring.io/spring-integration/reference/html/dsl.html#java-dsl-gateways

Current Behavior

There is no mention of .gateway() and no use of it in the spring-integration-saples code either. It's easy to completely miss that this endpoint exists in the DSL

Context

On Stackoverflow, @artembilan suggested I post this GH request.
https://stackoverflow.com/questions/68400511/spring-integration-dsl-how-to-refactor-into-subflows#comment120898078_68402954

How has this issue affected you?

It took me way to long to realize that Spring Integration DSL hat a .gateway() method available when .gateway() was exactly what I needed.
@swiss-chris swiss-chris added status: waiting-for-triage The issue need to be evaluated and its future decided type: enhancement labels Jul 16, 2021
@artembilan artembilan added this to the 5.5.2 milestone Jul 16, 2021
@artembilan artembilan added type: documentation and removed status: waiting-for-triage The issue need to be evaluated and its future decided type: enhancement labels Jul 16, 2021
@artembilan artembilan self-assigned this Jul 16, 2021
artembilan added a commit to artembilan/spring-integration that referenced this issue Jul 19, 2021
@artembilan
spring-projectsGH-3591: Add gateway() section into dsl.adoc
b2689a2 
Fixes spring-projects#3591
@artembilan artembilan mentioned this issue Jul 19, 2021
Merged
garyrussell pushed a commit that referenced this issue Jul 19, 2021
@artembilan
GH-3591: Add gateway() section into dsl.adoc (#3593)
dbc8af9 
* GH-3591: Add `gateway()` section into `dsl.adoc`

Fixes #3591

* Apply review requested changes
@swiss-chris
Copy link
Contributor Author

@artembilan @garyrussell will you add a mention of .gateway() to the bullet list under https://docs.spring.io/spring-integration/reference/html/dsl.html#java-dsl-basics as well ?
(inside the same dsl.adoc file, but earlier in the document where you list all the endpoints)

@artembilan
Copy link
Member

Probably no, because this one is some kind of handle() (Service Activator) and we mention over there just some general only.
As you see there is also something like enrichHeaders or scatterGather.
The point of those bullets just to give you a general idea of methods you can see in the IntegrationFlowDefinition.
Since we have there at about 100 methods it would be too excessive to list all of them in the doc.
It is much better to open JavaDocs of that class and follow the list of existing methods.
Another way is to come over the rest of Spring Integration documentation and make yourself familiar with all possible EIP implementation first of all and then go to IntegrationFlowDefinition trying to search for a respective method support.
The Java DSL is just a tool to simplify target developer experience, but it must not be treated as a source of truth for EIP implementations. It is really done in their individual classes and packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@artembilan artembilan

Labels
type: documentation
Projects
None yet
Milestone
5.5.2
Development

Successfully merging a pull request may close this issue.

GH-3591: Add gateway() section into dsl.adoc artembilan/spring-integration
2 participants
@swiss-chris @artembilan