Skip to content

Commit ff44214

Browse files
nethbotnethbot
committed
apidoc@port_forward #971 
0 parents  commit ff44214

File tree

1,207 files changed

+40560
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,207 files changed

+40560
-0
lines changed

‎core/README.md‎

Lines changed: 671 additions & 0 deletions
Large diffs are not rendered by default.

‎core/add-backup-input-properties-backup-name.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Backup name Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/name
5+
```
6+
7+
If set to empty, a default name is set (e.g. `Backup 3`)
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## name Type
14+
15+
`string` ([Backup name](add-backup-input-properties-backup-name.md))

‎core/add-backup-input-properties-backup-retention.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Backup retention Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/retention
5+
```
6+
7+
Number of backup snapshots to store before automatic deletion
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## retention Type
14+
15+
`integer` ([Backup retention](add-backup-input-properties-backup-retention.md))
16+
17+
## retention Constraints
18+
19+
**minimum**: the value of this number must greater than or equal to: `1`

‎core/add-backup-input-properties-enableddisabled-status-if-false-the-backup-is-stopped.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Enabled/disabled status. If \`false\` the backup is stopped. Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/enabled
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## enabled Type
14+
15+
`boolean` ([Enabled/disabled status. If \`false\` the backup is stopped.](add-backup-input-properties-enableddisabled-status-if-false-the-backup-is-stopped.md))

‎core/add-backup-input-properties-module-instances-items.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Untitled string in add-backup input Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/instances/items
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## items Type
14+
15+
`string`
16+
17+
## items Constraints
18+
19+
**minimum length**: the minimum number of characters for this string is: `1`

‎core/add-backup-input-properties-module-instances.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Module instances Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/instances
5+
```
6+
7+
Identifiers of module instances included in the backup
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## instances Type
14+
15+
`string[]`

‎core/add-backup-input-properties-repository-uuid-reference.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Repository UUID reference Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/repository
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## repository Type
14+
15+
`string` ([Repository UUID reference](add-backup-input-properties-repository-uuid-reference.md))
16+
17+
## repository Constraints
18+
19+
**pattern**: the string must match the following regular expression: 
20+
21+
```regexp
22+
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
23+
```
24+
25+
[try pattern](https://regexr.com/?expression=%5E%5B0-9a-f%5D%7B8%7D-%5B0-9a-f%5D%7B4%7D-%5B0-9a-f%5D%7B4%7D-%5B0-9a-f%5D%7B4%7D-%5B0-9a-f%5D%7B12%7D%24 "try regular expression with regexr.com")

‎core/add-backup-input-properties-schedule-expression-hint-for-ui.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Schedule expression hint for UI Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/schedule_hint
5+
```
6+
7+
Store arbitrary object to ease parsing of `schedule` value
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## schedule\_hint Type
14+
15+
`object` ([Schedule expression hint for UI](add-backup-input-properties-schedule-expression-hint-for-ui.md))

‎core/add-backup-input-properties-time-schedule-expression.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Time schedule expression Schema
2+
3+
```txt
4+
http://schema.nethserver.org/cluster/add-backup-input.json#/properties/schedule
5+
```
6+
7+
The string format must be compatible with Calendar Events, described in `systemd.timer` man page
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [add-backup-input.json\*](cluster/add-backup-input.json "open original schema") |
12+
13+
## schedule Type
14+
15+
`string` ([Time schedule expression](add-backup-input-properties-time-schedule-expression.md))
16+
17+
## schedule Constraints
18+
19+
**maximum length**: the maximum number of characters for this string is: `64`
20+
21+
**minimum length**: the minimum number of characters for this string is: `1`

‎core/add-backup-input.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"http://json-schema.org/draft-07/schema#","title":"add-backup input","$id":"http://schema.nethserver.org/cluster/add-backup-input.json","description":"Configure a new backup instance","examples":[{"name":"BB daily","repository":"6a2a6208-7d4f-5915-9419-e4f1faaa1c76","schedule":"daily","schedule_hint":{},"retention":"7d","instances":["dokuwiki1","nextcloud1"],"enabled":true}],"type":"object","required":["name","instances","repository","schedule","retention","enabled"],"properties":{"instances":{"title":"Module instances","description":"Identifiers of module instances included in the backup","type":"array","items":{"type":"string","minLength":1}},"repository":{"title":"Repository UUID reference","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"schedule":{"title":"Time schedule expression","description":"The string format must be compatible with Calendar Events, described in `systemd.timer` man page","type":"string","minLength":1,"maxLength":64},"schedule_hint":{"title":"Schedule expression hint for UI","description":"Store arbitrary object to ease parsing of `schedule` value","type":"object"},"retention":{"title":"Backup retention","description":"Number of backup snapshots to store before automatic deletion","type":"integer","minimum":1},"name":{"title":"Backup name","description":"If set to empty, a default name is set (e.g. `Backup 3`)","type":"string"},"enabled":{"type":"boolean","title":"Enabled/disabled status. If `false` the backup is stopped."}}}

0 commit comments

Comments
 (0)