summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-09-22 17:41:40 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-09-22 17:41:44 -0700
commitcd5f87ca17c1c9843ff00541871bff09ed6e9ad8 (patch)
treeb4e077a29cc3112738e399fb3861bede78914b04 /fatcat-openapi2.yml
parentac1cbadf4d9a0374e6983df481549cc28a09a910 (diff)
downloadfatcat-cd5f87ca17c1c9843ff00541871bff09ed6e9ad8.tar.gz
fatcat-cd5f87ca17c1c9843ff00541871bff09ed6e9ad8.zip
annotate API spec with tag-related lines
So they can be striped easily in codegen.
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml194
1 files changed, 97 insertions, 97 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index f8d16f5b..23eb9724 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -14,19 +14,19 @@ consumes:
produces:
- application/json
-tags:
- - name: containers
- descriptions: "Container entities: such as journals, conferences, book series"
- - name: creators
- descriptions: "Creator entities: such as authors"
- - name: files
- descriptions: "File entities"
- - name: releases
- descriptions: "Release entities: individual articles, pre-prints, books"
- - name: works
- descriptions: "Work entities: grouping releases which are variants of the same work"
- - name: edit-lifecycle
- descriptions: "Endpoints relating to global edit submission and history"
+tags: # TAGLINE
+ - name: containers # TAGLINE
+ descriptions: "Container entities: such as journals, conferences, book series" # TAGLINE
+ - name: creators # TAGLINE
+ descriptions: "Creator entities: such as authors" # TAGLINE
+ - name: files # TAGLINE
+ descriptions: "File entities" # TAGLINE
+ - name: releases # TAGLINE
+ descriptions: "Release entities: individual articles, pre-prints, books" # TAGLINE
+ - name: works # TAGLINE
+ descriptions: "Work entities: grouping releases which are variants of the same work" # TAGLINE
+ - name: edit-lifecycle # TAGLINE
+ descriptions: "Endpoints relating to global edit submission and history" # TAGLINE
# don't want these to be rust types (at least for now)
x-fatcat-ident: &FATCATIDENT
@@ -438,8 +438,8 @@ paths:
/container:
post:
operationId: "create_container"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: entity
in: body
@@ -459,8 +459,8 @@ paths:
/container/batch:
post:
operationId: "create_container_batch"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: autoaccept
in: query
@@ -495,8 +495,8 @@ paths:
required: true
get:
operationId: "get_container"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: expand
in: query
@@ -511,8 +511,8 @@ paths:
<<: *ENTITYRESPONSES
put:
operationId: "update_container"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: entity
in: body
@@ -531,8 +531,8 @@ paths:
<<: *ENTITYRESPONSES
delete:
operationId: "delete_container"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: editgroup
in: query
@@ -556,8 +556,8 @@ paths:
format: int64
required: false
get:
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
operationId: "get_container_history"
responses:
200:
@@ -570,8 +570,8 @@ paths:
/container/lookup:
get:
operationId: "lookup_container"
- tags:
- - containers
+ tags: # TAGLINE
+ - containers # TAGLINE
parameters:
- name: issnl
in: query
@@ -586,8 +586,8 @@ paths:
/creator:
post:
operationId: "create_creator"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: entity
in: body
@@ -607,8 +607,8 @@ paths:
/creator/batch:
post:
operationId: "create_creator_batch"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: autoaccept
in: query
@@ -643,8 +643,8 @@ paths:
required: true
get:
operationId: "get_creator"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: expand
in: query
@@ -659,8 +659,8 @@ paths:
<<: *ENTITYRESPONSES
put:
operationId: "update_creator"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: entity
in: body
@@ -679,8 +679,8 @@ paths:
<<: *ENTITYRESPONSES
delete:
operationId: "delete_creator"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: editgroup
in: query
@@ -705,8 +705,8 @@ paths:
required: false
get:
operationId: "get_creator_history"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
responses:
200:
description: Found Entity History
@@ -723,8 +723,8 @@ paths:
required: true
get:
operationId: "get_creator_releases"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
responses:
200:
description: Found
@@ -736,8 +736,8 @@ paths:
/creator/lookup:
get:
operationId: "lookup_creator"
- tags:
- - creators
+ tags: # TAGLINE
+ - creators # TAGLINE
parameters:
- name: orcid
in: query
@@ -752,8 +752,8 @@ paths:
/file:
post:
operationId: "create_file"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: entity
in: body
@@ -773,8 +773,8 @@ paths:
/file/batch:
post:
operationId: "create_file_batch"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: autoaccept
in: query
@@ -809,8 +809,8 @@ paths:
required: true
get:
operationId: "get_file"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: expand
in: query
@@ -825,8 +825,8 @@ paths:
<<: *ENTITYRESPONSES
put:
operationId: "update_file"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: entity
in: body
@@ -845,8 +845,8 @@ paths:
<<: *ENTITYRESPONSES
delete:
operationId: "delete_file"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: editgroup
in: query
@@ -871,8 +871,8 @@ paths:
required: false
get:
operationId: "get_file_history"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
responses:
200:
description: Found Entity History
@@ -884,8 +884,8 @@ paths:
/file/lookup:
get:
operationId: "lookup_file"
- tags:
- - files
+ tags: # TAGLINE
+ - files # TAGLINE
parameters:
- name: sha1
in: query
@@ -900,8 +900,8 @@ paths:
/release:
post:
operationId: "create_release"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: entity
in: body
@@ -921,8 +921,8 @@ paths:
/release/batch:
post:
operationId: "create_release_batch"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: autoaccept
in: query
@@ -957,8 +957,8 @@ paths:
required: true
get:
operationId: "get_release"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: expand
in: query
@@ -973,8 +973,8 @@ paths:
<<: *ENTITYRESPONSES
put:
operationId: "update_release"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: entity
in: body
@@ -993,8 +993,8 @@ paths:
<<: *ENTITYRESPONSES
delete:
operationId: "delete_release"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: editgroup
in: query
@@ -1019,8 +1019,8 @@ paths:
required: false
get:
operationId: "get_release_history"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
responses:
200:
description: Found Entity History
@@ -1037,8 +1037,8 @@ paths:
required: true
get:
operationId: "get_release_files"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
responses:
200:
description: Found
@@ -1050,8 +1050,8 @@ paths:
/release/lookup:
get:
operationId: "lookup_release"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: doi
in: query
@@ -1066,8 +1066,8 @@ paths:
/work:
post:
operationId: "create_work"
- tags:
- - releases
+ tags: # TAGLINE
+ - releases # TAGLINE
parameters:
- name: entity
in: body
@@ -1087,8 +1087,8 @@ paths:
/work/batch:
post:
operationId: "create_work_batch"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
parameters:
- name: autoaccept
in: query
@@ -1123,8 +1123,8 @@ paths:
required: true
get:
operationId: "get_work"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
parameters:
- name: expand
in: query
@@ -1139,8 +1139,8 @@ paths:
<<: *ENTITYRESPONSES
put:
operationId: "update_work"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
parameters:
- name: entity
in: body
@@ -1159,8 +1159,8 @@ paths:
<<: *ENTITYRESPONSES
delete:
operationId: "delete_work"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
parameters:
- name: editgroup
in: query
@@ -1185,8 +1185,8 @@ paths:
required: false
get:
operationId: "get_work_history"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
responses:
200:
description: Found Entity History
@@ -1203,8 +1203,8 @@ paths:
required: true
get:
operationId: "get_work_releases"
- tags:
- - works
+ tags: # TAGLINE
+ - works # TAGLINE
responses:
200:
description: Found
@@ -1268,8 +1268,8 @@ paths:
/editgroup:
post:
operationId: "create_editgroup"
- tags:
- - edit-lifecycle
+ tags: # TAGLINE
+ - edit-lifecycle # TAGLINE
parameters:
- name: editgroup
in: body
@@ -1297,8 +1297,8 @@ paths:
<<: *FATCATIDENT
get:
operationId: "get_editgroup"
- tags:
- - edit-lifecycle
+ tags: # TAGLINE
+ - edit-lifecycle # TAGLINE
responses:
200:
description: Found
@@ -1324,8 +1324,8 @@ paths:
<<: *FATCATIDENT
post:
operationId: "accept_editgroup"
- tags:
- - edit-lifecycle
+ tags: # TAGLINE
+ - edit-lifecycle # TAGLINE
responses:
200:
description: Merged Successfully
@@ -1356,8 +1356,8 @@ paths:
required: false
get:
operationId: "get_changelog"
- tags:
- - edit-lifecycle
+ tags: # TAGLINE
+ - edit-lifecycle # TAGLINE
responses:
200:
description: Success
@@ -1378,8 +1378,8 @@ paths:
required: true
get:
operationId: "get_changelog_entry"
- tags:
- - edit-lifecycle
+ tags: # TAGLINE
+ - edit-lifecycle # TAGLINE
responses:
200:
description: Found Changelog Entry