summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml11
1 files changed, 6 insertions, 5 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index 9853de2f..3de72126 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -3,17 +3,17 @@ swagger: "2.0"
info:
title: fatcat
version: 0.3.0
- summary: "A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata"
description: |
-
- ## Introduction
-
Fatcat is a scalable, versioned, API-oriented catalog of bibliographic
entities and file metadata.
+ <!-- STARTLONGDESCRIPTION -->
These API reference documents, along with client software libraries, are
generated automatically from an OpenAPI 2.0 ("Swagger") definition file.
+ ## Introduction
+
+
A higher-level introduction to the API, as well as a description of the
fatcat data model, are available in ["The Fatcat Guide"](https://guide.fatcat.wiki/).
The guide also includes a [Cookbook](https://guide.fatcat.wiki/cookbook.html)
@@ -71,11 +71,12 @@ info:
passes them through to the API to authenticate editor actions.
<!-- ReDoc-Inject: <security-definitions> -->
+ <!-- ENDLONGDESCRIPTION -->
termsOfService: "https://guide.fatcat.wiki/policies.html"
contact:
name: "Internet Archive Web Group"
- email: "webgroup@archive.org"
+ email: "webservices@archive.org"
url: "https://fatcat.wiki"
x-logo:
url: "https://fatcat.wiki/static/paper_man_confused.gif"