Skip to content

Commit 3df46c6

Browse files
committed
Add API docs for thumbnail file
1 parent b97849f commit 3df46c6

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

entity-api-spec.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
description: 'The HuBMAP Entity API is a standard RESTful web service with create, update and read operations for the standard HuBMAP provenance graph entities.<br><br>'
4-
version: 2.0.12
4+
version: 2.0.14
55
title: HuBMAP Entity API
66
contact:
77
name: HuBMAP Help Desk
@@ -191,7 +191,7 @@ components:
191191
description: "The name of the file."
192192
description:
193193
type: string
194-
description: "A description of the file."
194+
description: "A description of the file. The Dataset.thumbnail_file does not have this file description."
195195
file_uuid:
196196
type: string
197197
description: "The HuBMAP unique identifier for the file."
@@ -769,15 +769,17 @@ components:
769769
description: "The uuid of next revision dataset"
770770
thumbnail_file:
771771
readOnly: true
772-
description: "The dataset thumbnail file detail. Stored in db as a stringfied json, e.g., {'filename': 'thumbnail.jpg', 'file_uuid': 'dadasdasdadda'}"
772+
description: 'The dataset thumbnail file detail. Stored in db as a stringfied json, e.g., {"filename": "thumbnail.jpg", "file_uuid": "c35002f9c3d49f8b77e1e2cd4a01803d"}'
773773
thumbnail_file_to_add:
774+
writeOnly: true
774775
type: string
775776
format: temp_file_id
776777
description: 'Just a temporary file id. Provide as a json object with an temp_file_id like {"temp_file_id":"dzevgd6xjs4d5grmcp4n"}'
777778
thumbnail_file_to_remove:
779+
writeOnly: true
778780
type: string
779781
format: file_uuid
780-
description: 'The thumbnail image file previously uploaded to delete. Provide as a string of the file_uuid like: "232934234234234234234270c0ea6c51d604a850558ef2247d0b4"'
782+
description: 'The thumbnail image file previously uploaded to delete. Provide as a string of the file_uuid like: "c35002f9c3d49f8b77e1e2cd4a01803d"'
781783
Upload:
782784
type: object
783785
properties:

0 commit comments

Comments
 (0)