Skip to content

Commit e7c0f33

Browse files
authored
Update api docs with md5 param (#1364)
1 parent 0983b71 commit e7c0f33

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

jupyter_server/services/api/api.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,10 @@ paths:
106106
in: query
107107
description: "Return content (0 for no content, 1 for return content)"
108108
type: integer
109+
- name: md5
110+
in: query
111+
description: "Return md5 hexdigest string of content (0 for no md5, 1 for return md5)"
112+
type: integer
109113
responses:
110114
404:
111115
description: No item found
@@ -885,7 +889,7 @@ definitions:
885889
kernel:
886890
$ref: "#/definitions/Kernel"
887891
Contents:
888-
description: "A contents object. The content and format keys may be null if content is not contained. If type is 'file', then the mimetype will be null."
892+
description: "A contents object. The content and format keys may be null if content is not contained. The md5 maybe null if md5 is not contained. If type is 'file', then the mimetype will be null."
889893
type: object
890894
required:
891895
- type
@@ -897,6 +901,7 @@ definitions:
897901
- mimetype
898902
- format
899903
- content
904+
- md5
900905
properties:
901906
name:
902907
type: string
@@ -934,6 +939,9 @@ definitions:
934939
format:
935940
type: string
936941
description: Format of content (one of null, 'text', 'base64', 'json')
942+
md5:
943+
type: string
944+
description: "The md5 hexdigest string of content, if requested (otherwise null)."
937945
Checkpoints:
938946
description: A checkpoint object.
939947
type: object

0 commit comments

Comments
 (0)