sdk-php icon indicating copy to clipboard operation
sdk-php copied to clipboard

[Feature Request] Add API reference

Open lorensr opened this issue 3 years ago • 5 comments
trafficstars

I see the docs at https://docs.temporal.io/php/introduction/ but is there a structured list of functions etc that the package provides?

lorensr avatar Jul 27 '22 00:07 lorensr

Hey @lorensr 👋🏻 Is this still actual? As far as I understand, there is no such docs for other SDKs, am I right?

rustatian avatar Sep 01 '23 12:09 rustatian

It remains something I would find useful.

They do have them:

  • http://t.mp/ts-api
  • http://t.mo/py-api
  • http://t.mp/go-api
  • http://t.mp/java-api
  • http://dotnet.temporal.io

lorensr avatar Sep 01 '23 15:09 lorensr

I think, for the PHP should be used phpdoc: https://www.phpdoc.org/

rustatian avatar Sep 01 '23 23:09 rustatian

If you add a step to CI that uses phpdoc to generate html, I can add a step that publishes it to php.temporal.io

On Fri, Sep 1, 2023 at 7:37 PM Valery Piashchynski @.***> wrote:

I think, for the PHP should be used phpdoc: https://www.phpdoc.org/

— Reply to this email directly, view it on GitHub https://github.com/temporalio/sdk-php/issues/213#issuecomment-1703517360, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAB5LGF6DVGVZN42ZXQTRODXYJWT7ANCNFSM54XYHYGA . You are receiving this because you were mentioned.Message ID: @.***>

lorensr avatar Sep 02 '23 00:09 lorensr

@wolfy-j We'll soon have things set up for you to start publishing API docs once you're ready. To publish from CI, you just need to generate the docs and then:

npx vercel deploy path/to/generated/docs -t ${{ secrets.VERCEL_TOKEN }} --name php --scope temporal --prod --yes

(The token's already set in the repo secrets.)

Our IT folks just need to finish up a couple things to get the domain ready (hopefully will be done by the time you read this).

josh-berry avatar Mar 14 '24 22:03 josh-berry

Looks like we can close this? https://php.temporal.io/

rachfop avatar Mar 25 '24 21:03 rachfop

Looks like we can close this? https://php.temporal.io/

Waiting merging https://github.com/temporalio/sdk-php/pull/408 The issue will be closed automatically

roxblnfk avatar Mar 26 '24 08:03 roxblnfk