From 0b027cce77f767510f6dd0df32e910b11068e6be Mon Sep 17 00:00:00 2001 From: Umberto Baldi Date: Thu, 14 Oct 2021 17:45:10 +0200 Subject: [PATCH] remove pkgs.html because of dangerous eval --- design/docs.go | 10 ---- docs/pkgs.html | 123 ------------------------------------------------- 2 files changed, 133 deletions(-) delete mode 100644 design/docs.go delete mode 100644 docs/pkgs.html diff --git a/design/docs.go b/design/docs.go deleted file mode 100644 index d86fd9065..000000000 --- a/design/docs.go +++ /dev/null @@ -1,10 +0,0 @@ -package design - -import . "goa.design/goa/dsl" - -var _ = Service("docs", func() { - HTTP(func() { - Path("/docs") - }) - Files("/pkgs", "docs/pkgs.html") -}) diff --git a/docs/pkgs.html b/docs/pkgs.html deleted file mode 100644 index c505805f5..000000000 --- a/docs/pkgs.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - Interactive docs for pkgs api - - - -

pkgs api manage the indexes and tools installed on the system.

- -

Indexes

-

An index file contains the info about a core and its tools. You can see an example at https://downloads.arduino.cc/packages/package_index.json

- -

index files are saved (with an urlencoded filename) in the folder ~/.arduino-create/indexes

- -

List Indexes

-

You can list the indexes installed in the system with this simple GET

-
-
- - -

Add Indexes

-

You can add a new index with a POST request

-
-
- - -

You can now check if the new package_index was downloaded by repeating List Indexes.

- -

Remove Indexes

-

You can add a new index with a POST request

-
-
- - -

You can now check if the new package_index was removed by repeating List Indexes.

- - -

Tools

-

A tool is an executable that can be used to program a board.

- -

tools are saved in the folder ~/.arduino-create with a structure like {packager}/{name}/{version}

- -

List Available Tools

-

You can list the available tools that could be installed from an index with this simple GET. (Remember to add - indexes)

-
-
- - -

List Installed Tools

-

You can list the tools installed in the system with this simple GET

-
-
- - - -

Install a tool from an index file

-

You can install one of the available tools with a PUT request

-
-
- - - -

Remove an installed tool

-

You can remove one of the installed tools with a DELETE request

-
-
- - - - - - - \ No newline at end of file