adam/Piwigo
1
0 Fork 0
mirror of https://github.com/Piwigo/Piwigo.git synced 2026-11-03 07:22:22 +01:00
Code Issues 657 Packages Projects Releases Wiki Activity

Inconsistent API results #1003

New Issue
Open
opened 2026-10-05 00:28:02 +02:00 by adam · 2 comments
adam commented 2026-10-05 00:28:02 +02:00
Owner
Copy link
Copy source

Calling pwg.categories.getList with tree_output set to true returns just a list of categories, whereas with false you get a hash with the single key "categories" and the category list as a value. That doesn't make a whole lot of sense.
Now if the API was versioned, this could be fixed in a new revision, but as it stands, it will probably need a new method call, or compatibility will have to be broken.

Calling `pwg.categories.getList` with `tree_output` set to true returns just a list of categories, whereas with false you get a hash with the single key "categories" and the category list as a value. That doesn't make a whole lot of sense. Now if the API was versioned, this could be fixed in a new revision, but as it stands, it will probably need a new method call, or compatibility will have to be broken. <!-- github-sync-id:561104736 -->
adam commented 2026-10-05 00:28:03 +02:00
Author
Owner
Copy link
Copy source

Well... your script/app will either use tree_output or not. So, why do you care about consistency of the output with or without this parameter?

I confirm we can discuss about the output, but we can't change it without breaking third party apps, which is highly not a good option :-)

Well... your script/app will either use `tree_output` or not. So, why do you care about consistency of the output with or without this parameter? I confirm we can discuss about the output, but we can't change it without breaking third party apps, which is highly not a good option :-) <!-- github-comment-id:583442496 -->
adam commented 2026-10-05 00:28:04 +02:00
Author
Owner
Copy link
Copy source

I'm developing a new Perl module for simpler web service access, and this just struck me as something I wouldn't want to document -- but I have to cover both cases with one method. There's a pretty workaround though ... so perhaps just understand it as "if anyone touches this any time soon, think about adding a versioned API" ;-)

I'm developing a new Perl module for simpler web service access, and this just struck me as something I wouldn't want to document -- but I have to cover both cases with one method. There's a pretty workaround though ... so perhaps just understand it as "if anyone touches this any time soon, think about adding a versioned API" ;-) <!-- github-comment-id:583726884 -->
Sign in to join this conversation.
No Branch/Tag Specified
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Wojcieszonek)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: adam/Piwigo#1003