Skip to content

Commit

Permalink
API for downloading package from Playground
Browse files Browse the repository at this point in the history
  • Loading branch information
jhpyle committed Sep 19, 2024
1 parent 48eaf6a commit 25ee1a5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
10 changes: 7 additions & 3 deletions _docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2344,13 +2344,14 @@ Parameters:
key.
- `folder` (optional): the folder in the [Playground] from which to
obtain the list of files. Must be one of `questions`, `sources`,
`static`, `templates`, or `modules`. The default is `static`.
`static`, `templates`, `modules`, or `packages`. The default is `static`.
- `project` (optional): the project in the [Playground] from which to
obtain the list of files. The default is `default`, which is the
"Default Playground" project.
- `filename` (optional): the name of the file to be downloaded. If a
`filename` is not provided, a [JSON] list of files will be
returned.
returned. If `folder` is `packages`, a ZIP file of the package
indicated by `filename` will be downloaded.

Required privileges:

Expand All @@ -2371,7 +2372,10 @@ Responses on failure:

Response on success: [200]

Body of response: a [JSON] array of file names
Body of response: a [JSON] array of file names, or if `filename` is
provided, the content of the file. If `folder` is `packages` and
`filename` is provided, the response will be a ZIP file containing the
package.

## <a name="playground_delete"></a>Delete a file in the Playground

Expand Down
7 changes: 7 additions & 0 deletions _docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ layout: docs
title: Change Log
short_title: Change Log
---
## [1.5.10](https://github.com/jhpyle/docassemble/releases/tag/v1.5.10) - 2024-09-19


### Added
- Option in the `/api/playground` GET endpoint for downloading the ZIP
file of a Playground package.

## [1.5.9](https://github.com/jhpyle/docassemble/releases/tag/v1.5.9) - 2024-09-18


Expand Down

0 comments on commit 25ee1a5

Please sign in to comment.