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

Missing Documentation #58

Open
fireproofsocks opened this issue Oct 31, 2014 · 4 comments
Open

Missing Documentation #58

fireproofsocks opened this issue Oct 31, 2014 · 4 comments

Comments

@fireproofsocks
Copy link

Seems like a promising library, but the documentation is missing. It's good to have an example of how to install composer, but missing here are examples of how to make even simple requests.

@matheo
Copy link

matheo commented Dec 5, 2014

@fireproofsocks
Copy link
Author

Best to put a link like that inside the main readme.md @ https://github.com/BeSimple/BeSimpleSoap where someone might actually find it.

That aside, that page is sort of a confusing mix of a reference and some examples, and in my opinion, it fails to accomplish either purpose. Some points:

  1. What nodes are expected in the yaml? I can guess from the example, but it's only a guess. (i.e. complete the reference: what's the syntax? What options are available?)
  2. What's the relationship between "be_simple_soap" in the yaml and "besimple.soap.client" in the client code? What other links are there betwen the yaml file and the code and are there any changes between the two (e.g. one version uses proper case, the other expects lowercase).
  3. How are methods expected to be defined in the WebService class? E.g. $client->hello() calls what exactly? How is that defined in the WSDL?

I could go on, but I hope that helps explain why I filed this bug and what I think "normal" users (i.e. developers) might be expecting to see if this library is to be used. Since SOAP itself is poorly documented and its integrations are rarely clean (esp. PHP's implementation of it), it's critical to document full working examples.

@mablae
Copy link

mablae commented Jan 4, 2016

+1

@delatbabel
Copy link

+1

Plus the documentation above does not document the base soap classes, it only documents the symfony bundle.

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

No branches or pull requests

4 participants