Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arxiv/arxiv-submission-api

RESTful JSON API for submission to arXiv
https://github.com/arxiv/arxiv-submission-api

arxiv-ng part-of-ng-submit

Last synced: about 4 hours ago
JSON representation

RESTful JSON API for submission to arXiv

Awesome Lists containing this project

README

        

Note that this API is not currently under development. It was previously archived in 2024, and work stopped in 2019. We are currently investiating its utliity.

# arXiv Submission API service

The arXiv submission API supports programmatic submission mechanisms for
third-party applications.

## OpenAPI Schema

The [schema/](schema/) directory provides a description of the arXiv submission
API based on the OpenAPI 3.0.0 specification. The root API description is
located at ``schema/openapi.yaml``.

The OpenAPI description refers to [JSON Schema](json-schema.org) documents for
the various resources accepted/exposed by the submission API. Those schemas are
used to validate client requests and responses. **Note that OpenAPI 3 is a
subset of the JSON Schema specification**; we therefore only use keywords that
are supported by OpenAPI. [This
issue](https://github.com/OAI/OpenAPI-Specification/issues/333) provides
extensive background (scroll to the bottom for JSON Schema support in OpenAPI
3).

The OpenAPI and JSON Schema documents should be considered a contract for the
submission service API, and suitable as a basis for implementing clients.