https://github.com/artefactual-labs/archivematica-api-specification

Archivematica API definition built with TypeSpec
https://github.com/artefactual-labs/archivematica-api-specification

api archivematica archivematica-automation typespec

Last synced: about 2 months ago
JSON representation

Archivematica API definition built with TypeSpec

• Host: GitHub
• URL: https://github.com/artefactual-labs/archivematica-api-specification
• Owner: artefactual-labs
• License: agpl-3.0
• Created: 2024-04-25T16:26:33.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-17T04:38:44.000Z (3 months ago)
• Last Synced: 2024-10-19T06:55:02.222Z (3 months ago)
• Topics: api, archivematica, archivematica-automation, typespec
• Homepage: https://artefactual-labs.github.io/archivematica-api-specification/
• Size: 117 KB
• Stars: 0
• Watchers: 11
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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][ssclient-go].

## Usage

    npm --prefix=typespec run compile

## OpenAPI specification

Check out the results [here].

## Resources

- [Current documentation](https://www.archivematica.org/en/docs/latest/dev-manual/api/api-reference-archivematica/) - not entirely accurate.

- [Legacy documentattion](https://wiki.archivematica.org/Archivematica_API) - abandoned, outdated.

- [Dashboard API Django app](https://github.com/artefactual/archivematica/tree/qa/1.x/src/dashboard/src/components/api) - the source code!

[here]: https://editor.swagger.io/?url=https://raw.githubusercontent.com/artefactual-labs/archivematica-api-specification/main/typespec/tsp-output/%40typespec/openapi3/openapi.v1.yaml

[TypeSpec.io]: https://typespec.io

[ssclient-go]: https://github.com/artefactual-labs/ssclient-go/tree/main/typespec