Skip to content

Conversation

@psilabs-dev
Copy link
Contributor

The "api key requirement" probably shouldn't be specified in the query parameter, and it is not consistent with the other modules (e.g. shinobu, database), I'm suspecting this is just outdated documentation.

@Guerra24
Copy link
Contributor

Guerra24 commented Oct 4, 2025

FYI

# It can also be passed as a parameter. (Undocumented, mostly just meant for OPDS)
my $param_key = $self->req->param('key') || '';

@psilabs-dev
Copy link
Contributor Author

psilabs-dev commented Oct 4, 2025

Right, I was imprecise. If it is specified, it's not mandatory, and either the other docs should include this as well, or we remove it from the docs, but currently it's not consistent (but also do we want credentials in query parameters, not headers?)

@Guerra24
Copy link
Contributor

Guerra24 commented Oct 4, 2025

Went thru the changelogs because I couldn't remember why.

TL;DR: The API got reworked around 0.6.9~0.7.3. Key param got removed. Got restored in 0.8.8 for OPDS "only".

Should be fine to remove.

@Difegue
Copy link
Owner

Difegue commented Oct 19, 2025

Yeah it's technically possible to still use key as a queryparam everywhere, since even through it was restored for OPDS compliance I didn't make a separate auth sub just for it...

It's still better to be consistent in the documentation though so might as well remove the mentions.

@Difegue Difegue merged commit 48732b4 into Difegue:dev Oct 19, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants