aboutsummaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-11-26 23:39:06 -0800
committerBryan Newbold <bnewbold@robocracy.org>2018-11-26 23:47:08 -0800
commit00480a0eef176c4732ac627e5e905ef00bbfcc17 (patch)
treee53f2ef02d3cdc1a9758875a93b70119fc0d8f0e /fatcat-openapi2.yml
parent81edfe6e70763236e4f20e36e6ae318292d465c4 (diff)
downloadfatcat-00480a0eef176c4732ac627e5e905ef00bbfcc17.tar.gz
fatcat-00480a0eef176c4732ac627e5e905ef00bbfcc17.zip
hide flags (like expand)
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml60
1 files changed, 60 insertions, 0 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index fe1cf3e2..57b0ba17 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -503,6 +503,11 @@ paths:
type: string
required: false
description: "List of sub-entities to expand in response. For containers, none accepted (yet)."
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For containers, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -577,6 +582,11 @@ paths:
in: query
required: true
<<: *FATCATISSN
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For container, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -651,6 +661,11 @@ paths:
type: string
required: false
description: "List of sub-entities to expand in response. For creators, none accepted (yet)."
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For containers, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -721,6 +736,11 @@ paths:
in: path
type: string
required: true
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
get:
operationId: "get_creator_releases"
tags: # TAGLINE
@@ -743,6 +763,11 @@ paths:
in: query
required: true
<<: *FATCATORCID
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For creator, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -817,6 +842,11 @@ paths:
type: string
required: false
description: "List of sub-entities to expand in response. For files, none accepted (yet)."
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For files, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -891,6 +921,11 @@ paths:
in: query
type: string
required: true
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For files, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -965,6 +1000,11 @@ paths:
type: string
required: false
description: "List of sub-entities to expand in response. For releases, 'files' and 'container' are valid."
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
responses:
200:
description: Found Entity
@@ -1035,6 +1075,11 @@ paths:
in: path
type: string
required: true
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For files, none accepted (yet)."
get:
operationId: "get_release_files"
tags: # TAGLINE
@@ -1057,6 +1102,11 @@ paths:
in: query
type: string
required: true
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
responses:
200:
description: Found Entity
@@ -1131,6 +1181,11 @@ paths:
type: string
required: false
description: "List of sub-entities to expand in response. For works, none accepted (yet)."
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For works, none accepted (yet)."
responses:
200:
description: Found Entity
@@ -1201,6 +1256,11 @@ paths:
in: path
type: string
required: true
+ - name: hide
+ in: query
+ type: string
+ required: false
+ description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
get:
operationId: "get_work_releases"
tags: # TAGLINE