From 601f3f6ac91546dd5e047c3e932a61c402305826 Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Fri, 13 Sep 2019 11:24:45 -0700 Subject: 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. --- fatcat-openapi2.yml | 11 ++++++----- 1 file 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. + 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. + 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" -- cgit v1.2.3