docs: class defined as "Ping" but endpoints trying to fetch "Pings"#10033
docs: class defined as "Ping" but endpoints trying to fetch "Pings"#10033michalsn merged 5 commits intocodeigniter4:developfrom
Conversation
|
Hi there, cjbaezilla! 👋 Thank you for sending this PR! We expect the following in all Pull Requests (PRs).
Important We expect all code changes or bug-fixes to be accompanied by one or more tests added to our test suite to prove the code works. If pull requests do not comply with the above, they will likely be closed. Since we are a team of volunteers, we don't have any more time to work See https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/pull_request.md Sincerely, the mergeable bot 🤖 |
|
The plural endpoints were the review notes in #9808 when I picked that up. So I think it should be the other way around. Make the controller name as plural? |
|
The ping example is unsuccessful - it does not imply a Domain. Therefore, ping looks reasonable, since and /api/login /api/auth /api/jwt/ |
|
In general, the plural form should be used for resources (most common REST style). Singular form for service-style endpoints. So I would agree with this change, since this is health/action endpoint. |
|
Change spaces for table. |
|
@cjbaezilla would you be able to fix the failures so that this can be merged? |
hello there @paulbalandan, i really have no idea how to pass the tests, and honestly don't have the time either to start looking around, i like the project and i saw the error so if anyone else want to get attributed for it please be my guest, thank you very much for your consideration in the matter, best regards. |
this was the same rationale i made. |
…a/CodeIgniter4 into fix-typo-api-userguide
3b44b5d to
04b655c
Compare
|
Thank you @cjbaezilla |
|
Hooray! thanks guys have a great day 🤝 |
Title
Fix typo in user guide documentation first api page
Description
Class was defined as "Ping" but endpoints were pointing to "Pings" returning 404 in the example.
Checklist: