Skip to content

Commit

Permalink
apidoc@change_pass #78
Browse files Browse the repository at this point in the history
  • Loading branch information
@nethbot
nethbot committed Sep 14, 2021
0 parents commit 969eef6
Show file tree
Hide file tree
Showing 405 changed files with 11,958 additions and 0 deletions.
233 changes: 233 additions & 0 deletions core/README.md

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions core/add-module-input-1-properties-image.md
@@ -0,0 +1,15 @@
# Untitled string in add-module input Schema

```txt
http://schema.nethserver.org/cluster/add-module-input.json#/properties/image
```

Name of the module image to install

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-input.json*](cluster/add-module-input.json "open original schema") |

## image Type

`string`
19 changes: 19 additions & 0 deletions core/add-module-input-1-properties-node.md
@@ -0,0 +1,19 @@
# Untitled integer in add-module input Schema

```txt
http://schema.nethserver.org/cluster/add-module-input.json#/properties/node
```

Node identifier where the module has to be installed

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-input.json*](cluster/add-module-input.json "open original schema") |

## node Type

`integer`

## node Constraints

**minimum**: the value of this number must greater than or equal to: `1`
71 changes: 71 additions & 0 deletions core/add-module-input-1.md
@@ -0,0 +1,71 @@
# add-module input Schema

```txt
http://schema.nethserver.org/cluster/add-module-input.json
```

Input schema of the add-module action

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [add-module-input.json](cluster/add-module-input.json "open original schema") |

## add-module input Type

`object` ([add-module input](add-module-input-1.md))

## add-module input Examples

```json
{
"image": "traefik",
"node": 1
}
```

# add-module input Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
| [image](#image) | `string` | Required | cannot be null | [add-module input](add-module-input-1-properties-image.md "http://schema.nethserver.org/cluster/add-module-input.json#/properties/image") |
| [node](#node) | `integer` | Required | cannot be null | [add-module input](add-module-input-1-properties-node.md "http://schema.nethserver.org/cluster/add-module-input.json#/properties/node") |

## image

Name of the module image to install

`image`

* is required

* Type: `string`

* cannot be null

* defined in: [add-module input](add-module-input-1-properties-image.md "http://schema.nethserver.org/cluster/add-module-input.json#/properties/image")

### image Type

`string`

## node

Node identifier where the module has to be installed

`node`

* is required

* Type: `integer`

* cannot be null

* defined in: [add-module input](add-module-input-1-properties-node.md "http://schema.nethserver.org/cluster/add-module-input.json#/properties/node")

### node Type

`integer`

### node Constraints

**minimum**: the value of this number must greater than or equal to: `1`
25 changes: 25 additions & 0 deletions core/add-module-input-properties-image-url.md
@@ -0,0 +1,25 @@
# Image URL Schema

```txt
http://schema.nethserver.org/node/add-module-input.json#/properties/image_url
```

URL of the module root image

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-input.json*](node/add-module-input.json "open original schema") |

## image_url Type

`string` ([Image URL](add-module-input-properties-image-url.md))

## image_url Constraints

**minimum length**: the minimum number of characters for this string is: `1`

## image_url Examples

```json
"ghcr.io/nethserver/mymodule:v2.3.2"
```
33 changes: 33 additions & 0 deletions core/add-module-input-properties-module-identifier.md
@@ -0,0 +1,33 @@
# Module identifier Schema

```txt
http://schema.nethserver.org/node/add-module-input.json#/properties/module_id
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-input.json*](node/add-module-input.json "open original schema") |

## module_id Type

`string` ([Module identifier](add-module-input-properties-module-identifier.md))

## module_id Constraints

**minimum length**: the minimum number of characters for this string is: `1`

## module_id Examples

```json
"dokuwiki1"
```

```json
"traefik3"
```

```json
"samba1"
```
16 changes: 16 additions & 0 deletions core/add-module-input-properties-required-type-of-installation.md
@@ -0,0 +1,16 @@
# Required type of installation Schema

```txt
http://schema.nethserver.org/node/add-module-input.json#/properties/is_rootfull
```

If `true` the module is installed in rootfull mode.
Its agent runs as root and its containers can be granted **privileged access**.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-input.json*](node/add-module-input.json "open original schema") |

## is_rootfull Type

`boolean` ([Required type of installation](add-module-input-properties-required-type-of-installation.md))
116 changes: 116 additions & 0 deletions core/add-module-input.md
@@ -0,0 +1,116 @@
# add-module input Schema

```txt
http://schema.nethserver.org/node/add-module-input.json
```

Install a module on the worker node

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [add-module-input.json](node/add-module-input.json "open original schema") |

## add-module input Type

`object` ([add-module input](add-module-input.md))

## add-module input Examples

```json
{
"image_url": "ghcr.io/nethserver/ldapproxy:latest",
"module_id": "ldapproxy2",
"is_rootfull": false
}
```

# add-module input Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [image_url](#image_url) | `string` | Required | cannot be null | [add-module input](add-module-input-properties-image-url.md "http://schema.nethserver.org/node/add-module-input.json#/properties/image_url") |
| [is_rootfull](#is_rootfull) | `boolean` | Required | cannot be null | [add-module input](add-module-input-properties-required-type-of-installation.md "http://schema.nethserver.org/node/add-module-input.json#/properties/is_rootfull") |
| [module_id](#module_id) | `string` | Required | cannot be null | [add-module input](add-module-input-properties-module-identifier.md "http://schema.nethserver.org/node/add-module-input.json#/properties/module_id") |

## image_url

URL of the module root image

`image_url`

* is required

* Type: `string` ([Image URL](add-module-input-properties-image-url.md))

* cannot be null

* defined in: [add-module input](add-module-input-properties-image-url.md "http://schema.nethserver.org/node/add-module-input.json#/properties/image_url")

### image_url Type

`string` ([Image URL](add-module-input-properties-image-url.md))

### image_url Constraints

**minimum length**: the minimum number of characters for this string is: `1`

### image_url Examples

```json
"ghcr.io/nethserver/mymodule:v2.3.2"
```

## is_rootfull

If `true` the module is installed in rootfull mode.
Its agent runs as root and its containers can be granted **privileged access**.

`is_rootfull`

* is required

* Type: `boolean` ([Required type of installation](add-module-input-properties-required-type-of-installation.md))

* cannot be null

* defined in: [add-module input](add-module-input-properties-required-type-of-installation.md "http://schema.nethserver.org/node/add-module-input.json#/properties/is_rootfull")

### is_rootfull Type

`boolean` ([Required type of installation](add-module-input-properties-required-type-of-installation.md))

## module_id



`module_id`

* is required

* Type: `string` ([Module identifier](add-module-input-properties-module-identifier.md))

* cannot be null

* defined in: [add-module input](add-module-input-properties-module-identifier.md "http://schema.nethserver.org/node/add-module-input.json#/properties/module_id")

### module_id Type

`string` ([Module identifier](add-module-input-properties-module-identifier.md))

### module_id Constraints

**minimum length**: the minimum number of characters for this string is: `1`

### module_id Examples

```json
"dokuwiki1"
```

```json
"traefik3"
```

```json
"samba1"
```
15 changes: 15 additions & 0 deletions core/add-module-output-1-properties-image_name.md
@@ -0,0 +1,15 @@
# Untitled string in add-module output Schema

```txt
http://schema.nethserver.org/cluster/add-module-output.json#/properties/image_name
```

Display name of the installed image

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-output.json*](cluster/add-module-output.json "open original schema") |

## image_name Type

`string`
15 changes: 15 additions & 0 deletions core/add-module-output-1-properties-image_url.md
@@ -0,0 +1,15 @@
# Untitled string in add-module output Schema

```txt
http://schema.nethserver.org/cluster/add-module-output.json#/properties/image_url
```

Repository URL of the installed image

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-output.json*](cluster/add-module-output.json "open original schema") |

## image_url Type

`string`
15 changes: 15 additions & 0 deletions core/add-module-output-1-properties-module_id.md
@@ -0,0 +1,15 @@
# Untitled string in add-module output Schema

```txt
http://schema.nethserver.org/cluster/add-module-output.json#/properties/module_id
```

Generated identifier of the added module instance

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-module-output.json*](cluster/add-module-output.json "open original schema") |

## module_id Type

`string`

0 comments on commit 969eef6

Please sign in to comment.