summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-09-13 11:24:45 -0700
committerBryan Newbold <bnewbold@robocracy.org>2019-09-13 11:31:48 -0700
commit601f3f6ac91546dd5e047c3e932a61c402305826 (patch)
tree27720ba42abdc4e623e8f6076a09abf3f7969724
parentd8e80cf222e44a6d1e82e1376ad712d473fcdeee (diff)
downloadfatcat-601f3f6ac91546dd5e047c3e932a61c402305826.tar.gz
fatcat-601f3f6ac91546dd5e047c3e932a61c402305826.zip
api spec: remove 'summary'; delineate full description
Full description was getting included in every single python client library header, and we don't want that. Also correct the contact email address.
-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"