Problem: API documentation could be more detailed and provide a warning about the Support user and keys #1775
Description
Version of the documentation
Archivematica 1.18
Page (and section, if applicable) where the issue occurs
https://www.archivematica.org/en/docs/archivematica-1.18/dev-manual/api/api-overview/#api-overview
Description of the issue
It would be helpful if the documentation was more specific about how the Support user key works with the Storage Service API.
This request came from a client experience:
The client created a script for Automation Tools and in doing so generated a Storage Service API key for the Support user. After the script was set up and run, an error resulted. It appeared that Archivematica was no longer talking to the Storage Service correctly. Transfer locations did not display and the ingest tab displays this error: "Error retrieving originals/arrange directory locations: is the storage server running? Please contact an administrator”
The problem was caused by was caused by the updated API key that was generated for the "Support" user .
The client did not expect generating a key to break things.
Suggested fix
A clear warning at the start of this page:
https://www.archivematica.org/en/docs/archivematica-1.18/dev-manual/api/api-overview/#api-overview
It may also be a good idea to suggest using a specific service account for API connections rather than a general account used for other purposes (given the way the API for users is generated and updated).
For Artefactual use:
Before you close this issue, you must check off the following:
- All pull requests related to this issue are properly linked
- All pull requests related to this issue have been merged
- Details about this issue have been added to the release notes (if applicable)