spring-projects / spring-projects/spring-ws

Add support for WSDL documentation tag generation [SWS-913]

Open
#988 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: waiting-for-triage
Dominant language
Java
Stars
346
Forks
323
Avg merge
3d 2h
Merged PRs (30d)
7

Description

Ruben Suarez Alvarez opened SWS-913 and commented

When I annotate and @Endpoint and configure a new DefaultWsdl11Definition in the WsConfigurerAdapter, I can't specify any documentation info to be generated in WSDL.

My XSD file includes documentation tag inside annotation tag for element tags, so It's used in generated WSDL under types tag inside definitions tag, but I can't specify documentation outside that tags.

I think, there should be some kind of support for a new @Documention annotation, at EndPoint class, similar to Apache XCF @WSDLDocumentation or JBoss WS @Documentation.

Related info:
How to define portType documentation for generating WSDL with Spring-WS
Wich WDL tags can have documentation tag


No further details from SWS-913

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the @Endpoint and DefaultWsdl11Definition configuration described in the issue, then compare the linked Apache CXF and JBoss WS annotation examples. Define the required annotation/API surface and verify that documentation appears in the generated WSDL outside the schema types; the issue provides no test or file path.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.