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

Offline downloads API gateway authentication #927

Open
peggynewman opened this issue Oct 3, 2024 · 4 comments
Open

Offline downloads API gateway authentication #927

peggynewman opened this issue Oct 3, 2024 · 4 comments

Comments

@peggynewman
Copy link

This biocache-ws download url works but this api.ala one does not.

I get an Unauthorised response.

The ask is to

  • fix this so at least the offline download GET works
  • re-enable paging on 'occurrences/search' with a reasonable max page size (should this be a separate issue?)
  • author a clear help desk article that outlines how to use those 2 API calls, when a token is required, how to use a token, and users' responsibility to abide by the terms of the license on the data
@peggynewman
Copy link
Author

Related: #697

@kylie-m
Copy link

kylie-m commented Oct 3, 2024

Adding to this from the slack discussion:

The API documentation and a gateway config needs to be updated to reflect rule A (JTW with Roles) and C (Email address). Currently it reflects only rule A.

@adam-collins
Copy link
Contributor

Upon review, it appears there are no further actions required for this issue, and it is recommended to close it. The following points provide clarification:

  1. The initial comment suggests that the service was utilized without consulting the documentation. The Open API specification clearly states that authentication is mandatory.
  2. The API documentation site provides comprehensive instructions on authentication.
  3. Deep paging will not be re-enabled for the occurrences/search. The identified service is the appropriate one for bulk downloads.
  4. The offline downloads service includes citation information within the output files.
  5. A link to the home page is available from the API page, which provides access to more information, including citation guidelines.

@peggynewman
Copy link
Author

Disagree with all 4 points. We'll discuss this offline.

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

No branches or pull requests

3 participants