aboutsummaryrefslogtreecommitdiffstats
path: root/rust/fatcat-api-spec/api/swagger.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'rust/fatcat-api-spec/api/swagger.yaml')
-rw-r--r--rust/fatcat-api-spec/api/swagger.yaml96
1 files changed, 96 insertions, 0 deletions
diff --git a/rust/fatcat-api-spec/api/swagger.yaml b/rust/fatcat-api-spec/api/swagger.yaml
index ded102e6..51f0630e 100644
--- a/rust/fatcat-api-spec/api/swagger.yaml
+++ b/rust/fatcat-api-spec/api/swagger.yaml
@@ -186,6 +186,14 @@ paths:
type: "string"
formatString: "{:?}"
example: "Some(\"expand_example\".to_string())"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For containers,\
+ \ none accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -437,6 +445,14 @@ paths:
pattern: "\\d{4}-\\d{3}[0-9X]"
formatString: "\\\"{}\\\""
example: "\"issnl_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For container, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -644,6 +660,14 @@ paths:
type: "string"
formatString: "{:?}"
example: "Some(\"expand_example\".to_string())"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For containers,\
+ \ none accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -892,6 +916,14 @@ paths:
type: "string"
formatString: "\\\"{}\\\""
example: "\"id_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For releases, 'abstracts',\
+ \ 'refs', and 'contribs' are valid."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found"
@@ -951,6 +983,14 @@ paths:
pattern: "\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]"
formatString: "\\\"{}\\\""
example: "\"orcid_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For creator, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -1158,6 +1198,14 @@ paths:
type: "string"
formatString: "{:?}"
example: "Some(\"expand_example\".to_string())"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For files, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -1406,6 +1454,14 @@ paths:
type: "string"
formatString: "\\\"{}\\\""
example: "\"sha1_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For files, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -1613,6 +1669,14 @@ paths:
type: "string"
formatString: "{:?}"
example: "Some(\"expand_example\".to_string())"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For releases, 'abstracts',\
+ \ 'refs', and 'contribs' are valid."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -1861,6 +1925,14 @@ paths:
type: "string"
formatString: "\\\"{}\\\""
example: "\"id_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For files, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found"
@@ -1917,6 +1989,14 @@ paths:
type: "string"
formatString: "\\\"{}\\\""
example: "\"doi_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For releases, 'abstracts',\
+ \ 'refs', and 'contribs' are valid."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -2124,6 +2204,14 @@ paths:
type: "string"
formatString: "{:?}"
example: "Some(\"expand_example\".to_string())"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For works, none\
+ \ accepted (yet)."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found Entity"
@@ -2372,6 +2460,14 @@ paths:
type: "string"
formatString: "\\\"{}\\\""
example: "\"id_example\".to_string()"
+ - name: "hide"
+ in: "query"
+ description: "List of entity fields to elide in response. For releases, 'abstracts',\
+ \ 'refs', and 'contribs' are valid."
+ required: false
+ type: "string"
+ formatString: "{:?}"
+ example: "Some(\"hide_example\".to_string())"
responses:
200:
description: "Found"