Giter Site home page Giter Site logo

OAuth2.0 documentation feedback about saloon HOT 5 CLOSED

boryn avatar boryn commented on May 22, 2024 1
OAuth2.0 documentation feedback

from saloon.

Comments (5)

Sammyjo20 avatar Sammyjo20 commented on May 22, 2024 1

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.

boryn avatar boryn commented on May 22, 2024

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.

boryn avatar boryn commented on May 22, 2024

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.

Sammyjo20 avatar Sammyjo20 commented on May 22, 2024

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.

Sammyjo20 avatar Sammyjo20 commented on May 22, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.