Welcome to the repository for the Archivematica API specification. This repository defines the Archivematica API using TypeSpec.io, which we then use to generate an OpenAPI v3 specification.
From the OpenAPI specification, it is possible to generate clients, server stubs, and documentation in multiple languages thanks to extensive community support.
Although the Archivematica API design may not always adhere to best practices, we hope this repository provides a detailed and transparent description of these imperfections.
The Archivematica Storage Service API specification is also available.
npm --prefix=typespec run compile
You can browse the OpenAPI specification in two forms:
The specification is still incomplete, and we expect to extend it over time as we cover more of the API.
- Current documentation - not entirely accurate.
- Legacy documentation - abandoned, outdated.
- Dashboard API Django app - the source code!