Comments (5)
Hey @boryn
Many thanks for your suggestions around the documentation - I totally understand that it looks a little confusing. I'm going to amend the docs so they read better and don't feel so cluttered.
I'm also going to be writing the docs for the client credentials grant so I will give this whole section a reread and work out where else we can improve 🔥
from saloon.
Hi @Sammyjo20!
Found another place, where it would be good to add some details. After looking at source code, I have found out that we can pass key name while fetching response as an array or collection:
$response->json('data')
$response->collect('data')
The documentation at https://docs.saloon.dev/the-basics/responses does not mention this.
BTW. ->json()
is a little bit misleading, as actually we receive an array. Maybe it would be good to have an alias ->array()
to this method? Or even let json
return a json string and array
an array, but then it would be a breaking change.
from saloon.
The examples at https://docs.saloon.dev/digging-deeper/pagination contain $paginator->setCurrentOffset(1000);
but this method seems to be not implemented.
Examples should not contain semicolon at the end of methods,
e.g.: public function paginate(Request $request, mixed ...$additionalArguments): OffsetPaginator;
from saloon.
Hey @boryn just wanted to let you know that I've re-written the section on the authorization code grant: https://docs.saloon.dev/digging-deeper/oauth2-authentication/oauth2-authentication
Let me know your feedback and if it reads better :D I'm going in to write the documentation on the client credentials grant.
from saloon.
I'm going to close this for now, please can we discuss future documentation improvements as discussions as they are better suited (with replies and threads)
Cheers @boryn as ever!
from saloon.
Related Issues (20)
- Paginator Next Request URL help HOT 5
- Create commands not respecting config file HOT 4
- Dots in parameters get converted to underscores because of parse_str HOT 7
- Refresh token with Client Credentials Grant HOT 5
- Faking a response - failed to match url HOT 2
- Cannot Have Request with `headers` HOT 4
- Skipping authentication when request is cached HOT 5
- Skipping AuthenticatePendingRequest when fetching a new accessToken using OAuth2 plugins HOT 2
- OAuth2 - Method not allowed (405) when getting the access Token HOT 8
- Missing methods updates for MockResponse HOT 1
- ERROR There are no commands defined in the "saloon" namespace. HOT 1
- Rate Limit Plugin: Issue with 'allow(1)->everySeconds(1)->sleep()' Exceeding One Request per Second
- Inteliphense cannot recognize the merge() method on request HOT 3
- Connector default headers overwrite request body headers
- Remove authentication on a specific request HOT 1
- Some properties are removed from the response body
- Using non-standard HTTP methods HOT 2
- Generating Documentation Files for GPT on ChatGPT
- Tests using Fixtures with custom Authenticators record incorrect response HOT 1
- async request with multi connector
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from saloon.