Skip to content

Update api docs with md5 param #1364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion jupyter_server/services/api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ paths:
in: query
description: "Return content (0 for no content, 1 for return content)"
type: integer
- name: md5
in: query
description: "Return md5 hexdigest string of content (0 for no md5, 1 for return md5)"
type: integer
responses:
404:
description: No item found
Expand Down Expand Up @@ -885,7 +889,7 @@ definitions:
kernel:
$ref: "#/definitions/Kernel"
Contents:
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."
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."
type: object
required:
- type
Expand All @@ -897,6 +901,7 @@ definitions:
- mimetype
- format
- content
- md5
properties:
name:
type: string
Expand Down Expand Up @@ -934,6 +939,9 @@ definitions:
format:
type: string
description: Format of content (one of null, 'text', 'base64', 'json')
md5:
type: string
description: "The md5 hexdigest string of content, if requested (otherwise null)."
Checkpoints:
description: A checkpoint object.
type: object
Expand Down