Skip to content

artefactual-labs/archivematica-api-specification

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

archivematica-api-specification

Welcome to the repository for the Archivematica API specification. This documentation describes our API using TypeSpec.io, which we then use to generate the OpenAPI v3 specification.

From the OpenAPI specification, it is possible to create clients, servers or documentation in multiple languages thanks to extensive support from the community.

Although the Archivematica API design may not always adhere to best practices, we hope this repository provides a detailed and transparent desription of these imperfections.

The Archivematica Storage Service API specification is also available. Please visit this link.

Usage

npm --prefix=typespec run compile

OpenAPI specification

Check out the results here.

Resources