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

Where did the documentation go? #69

Open
dragonwize opened this issue Feb 5, 2015 · 14 comments
Open

Where did the documentation go? #69

dragonwize opened this issue Feb 5, 2015 · 14 comments

Comments

@dragonwize
Copy link
Contributor

I wrote code using Guzzle 4 services about 6 months ago and used documentation of the service description array options, however, I now can no longer find this documentation any where.

Where is the documentation for the description array options?

@mtdowling
Copy link
Member

There aren't any docs yet, and this repo isn't yet stable. I'm hoping to get guzzlehttp/command tagged stable soon, thoroughly document it, then come back to guzzlehttp/guzzle-services to write more docs.

@dragonwize
Copy link
Contributor Author

I realize the code could can change, and am will to accept that. I have used this code successfully in the past and remember specifically reading about the different options in the service description such "extends", "$ref", etc.

I believe it was on the old guzzlephp site, if I remember correctly. However, the site is now completely different and archive.org has been no help as I think the URLs have changed and there is only sporadic crawls.

Does this documentation not exist anymore?

@mtdowling
Copy link
Member

The Guzzle 3 documentation is hosted at http://guzzle3.readthedocs.org/webservice-client/guzzle-service-descriptions.html. The docs here are going to differ in many ways from this repo (and the rest of the docs differ quite a bit from Guzzle 5).

@hassankhan
Copy link

+1 on docs, I cannot figure out why I'm receiving no data back from a simple GET request to httpbin.org

For reference, here's the JSON schema:

{
    "name": "httpbin",
    "baseUrl": "http://httpbin.org",
    "operations": {
        "html": {
            "httpMethod": "GET",
            "uri": "/html"
        }
    }
}

@shirshir
Copy link

You need to define the response model. Here is an example (in PHP array notation):

https://github.com/Rarst/wporg-client/blob/33fb0dcce9f170b92824d09f5717ca814d7ecd29/php/WporgService.php

@hassankhan
Copy link

Thank you so much!!

@eddiejaoude
Copy link

Any docs coming soon?

@richhl
Copy link

richhl commented Jul 6, 2015

@mtdowling same doubt. thx

@cryptiklemur
Copy link

Any update on this?

@Guibod
Copy link

Guibod commented Nov 2, 2017

Soon they said. 2 years ago.

@gkzsolt
Copy link

gkzsolt commented Jan 18, 2018

We are using Guzzle services successfully for a few years now and I thought to upgrade it, because version 3.5 is very outdated, you have Guzzle 6 now. Composer is warning me any time that "Package guzzle/guzzle is abandoned, you should avoid using it. Use guzzlehttp/guzzle instead." So I decided to upgrade to 6, or, well, to version 5. So far so good.

The problems start when I want to migrate my services. Packages and namespaces are gone, there is no Guzzle/Service/Command/ResponseClassInterface, for example and, although there is a Migration Guide, I found NOT A WORD about new guzzle services! Was hoping to find an API reference, at least, but nothing! Are you serious? How do you imagine people will migrate their web services code??

I understand that most people use Guzzle for HTTP, but still it's not only for this. If you don't have the resources to write a proper doc, please don't upgrade the code. I am now looking to go back to Guzzle 3.*, hope to work with the other upgraded libraries.

A shame and too bad for such a good library.

@cdarken
Copy link

cdarken commented Jun 21, 2018

@gkzsolt same here, I'm pulling my hair out looking for something about that ResponseClassInterface. I can't find anything. In the upgrade guide from 3 to 4 they're mentioning methods that are gone in v4.

@tlorens
Copy link

tlorens commented Jan 28, 2019

Use the source, Luke.

@moniang
Copy link

moniang commented Feb 24, 2021

There aren't any docs yet, and this repo isn't yet stable. I'm hoping to get guzzlehttp/command tagged stable soon, thoroughly document it, then come back to guzzlehttp/guzzle-services to write more docs.

Is it now 2021 and the document has not been updated yet?

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