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

docs: Add PHP library to framework list #7728

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

RedstonePfalz
Copy link

@RedstonePfalz RedstonePfalz commented Apr 8, 2024

Definition of Ready

  • I am happy with the code
  • Short description of the feature/issue is added in the pr description
  • Acceptance criteria are met
  • No debug or dead code
  • My code has no repetitions
  • Documentation/examples are up-to-date
  • All non-functional requirements are met

I have added a link to a PHP library to the documentation.

Copy link

vercel bot commented Apr 8, 2024

@RedstonePfalz is attempting to deploy a commit to the zitadel Team on Vercel.

A member of the Team first needs to authorize it.

@hifabienne hifabienne added the os-contribution This is a contribution from our open-source community label Apr 8, 2024
Copy link

vercel bot commented Apr 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 11, 2024 10:05am

@muhlemmer
Copy link
Contributor

Thanks for sharing your work on a zitadel framework! Until now we only linked to frameworks that were published by persons or companies affiliated to zitadel. That makes yours the first true community library that is submitted! We didn't formalize any guidelines for inclusion of frameworks yet, so we had a quick internal discussion about it.

Some points we would like to clarify as part of the review process:

  1. What is the long-term plan for the framework? Can we expect it to stay maintained in the long run?
  2. We would appreciate if there is some kind of automatic tests / pipeline against zitadel, so that breakage is detected early. We can help out if that's hard to accomplish
  3. Code quality: we will try to do a review of the linked repository. This might take some time.
  4. Feature coverage: what will be the scope of this framework? Login? API client? Resource management? To what level are those scopes implemented? We might want to hold-off including the framework in our documentation until it has some level of feature-completeness.

@RedstonePfalz
Copy link
Author

Hello there,
Thanks for your message.
Regarding the questions:

  1. The library will be extended in the longer term. Currently only the user and session management API areas are supported. Over the next few weeks, the APIs for instance management will gradually be added. After that, all other API areas will be covered gradually. If there are any changes to the API, I will try to implement them as soon as possible.

  2. I am currently writing PHPUnit tests. The first ones should be added to the repository sometime next week. The tests will then be added to a workflow so that we can regularly check that everything is working.

  3. The library should primarily serve as an API client. Support for user authentication, e.g. via OAuth, is not currently planned, as there are already enough PHP libraries available for this.

I have converted the pull request to a draft and will reopen it when the tests are available.

@RedstonePfalz RedstonePfalz marked this pull request as draft April 13, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx os-contribution This is a contribution from our open-source community
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

None yet

3 participants