Skip to content

Commit

Permalink
Update docs and version
Browse files Browse the repository at this point in the history
  • Loading branch information
AgustinSRG committed Jan 14, 2024
1 parent 9517f87 commit c08cebb
Show file tree
Hide file tree
Showing 3 changed files with 168 additions and 4 deletions.
162 changes: 160 additions & 2 deletions content/en/docs/Console Client/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ pmv-cli [OPTIONS] <COMMAND>
| [album](#command-album) | Manages albums |
| [config](#command-config) | Manages vault configuration |
| [task](#command-task) | Retrieves tasks information |
| [invites](#command-invites) | Manages invites |
| [batch](#command-batch) | Applies a batch operation to a list of media assets |
| [get-server-information](#command-get-server-information) | Gets server information, like the version it is using |

<ins>**Options:**</ins>

Expand All @@ -56,6 +58,8 @@ pmv-cli login [OPTIONS]
| Option | Description |
| --- | --- |
| `-U, --username <USERNAME>` | Vault username. You can also specify the credentials in the URL |
| `-D, --duration <DURATION>` | Session duration. Can be: day, week, month or year |
| `-I, --invite-code <INVITE_CODE>` | Invite code. Setting this option will ignore the credentials and use the code |
| `-h, --help` | Print help |

## Command: logout
Expand Down Expand Up @@ -240,7 +244,8 @@ pmv-cli media <COMMAND>
| [set-title](#command-media-set-title) | Changes the title of a media asset |
| [set-description](#command-media-set-description) | Changes the description of a media asset |
| [set-extended-description](#command-media-set-extended-description) | Changes the extended description of a media asset |
| [set-force-start-beginning](#command-media-set-force-start-beginning) | Changes the description of a media asset |
| [set-force-start-beginning](#command-media-set-force-start-beginning) | Changes the forced start from beginning parameter of a media asset |
| [set-is-animation](#command-media-set-is-animation) | Changes the is-animation parameter of a media asset |
| [set-thumbnail](#command-media-set-thumbnail) | Sets the thumbnail of a media asset |
| [get-time-slices](#command-media-get-time-slices) | Prints the time slices of a media asset |
| [set-time-slices](#command-media-set-time-slices) | Sets the time slices of a media asset |
Expand Down Expand Up @@ -476,7 +481,7 @@ pmv-cli media set-extended-description <MEDIA> <PATH>

### Command: media set-force-start-beginning

Changes the description of a media asset
Changes the forced start from beginning parameter of a media asset

<ins>**Usage:**</ins>

Expand All @@ -497,6 +502,29 @@ pmv-cli media set-force-start-beginning <MEDIA> <FORCE_START_BEGINNING>
| --- | --- |
| `-h, --help` | Print help |

### Command: media set-is-animation

Changes the is-animation parameter of a media asset

<ins>**Usage:**</ins>

```
pmv-cli media set-is-animation <MEDIA> <IS_ANIMATION>
```

<ins>**Arguments:**</ins>

| Argument | Description |
| --- | --- |
| `<MEDIA>` | Media asset ID |
| `<IS_ANIMATION>` | Set to 'true' if you want to tell the clients to treat the media as an animation, so they force the loop and disable time skipping |

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

### Command: media set-thumbnail

Sets the thumbnail of a media asset
Expand Down Expand Up @@ -1616,6 +1644,120 @@ pmv-cli task wait <TASK>
| --- | --- |
| `-h, --help` | Print help |

## Command: invites

Manages invites

<ins>**Usage:**</ins>

```
pmv-cli invites <COMMAND>
```

<ins>**Commands:**</ins>

| Command | Description |
| --- | --- |
| [check](#command-invites-check) | Prints the current invite code, if any |
| [generate](#command-invites-generate) | Generates a new invite code |
| [clear](#command-invites-clear) | Clears the current invite code |
| [list-sessions](#command-invites-list-sessions) | List active invited sessions |
| [close-session](#command-invites-close-session) | Closes an invited session |

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

### Command: invites check

Prints the current invite code, if any

<ins>**Usage:**</ins>

```
pmv-cli invites check
```

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

### Command: invites generate

Generates a new invite code

<ins>**Usage:**</ins>

```
pmv-cli invites generate [OPTIONS]
```

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-D, --duration <DURATION>` | Session duration. Can be: day, week, month or year |
| `-h, --help` | Print help |

### Command: invites clear

Clears the current invite code

<ins>**Usage:**</ins>

```
pmv-cli invites clear
```

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

### Command: invites list-sessions

List active invited sessions

<ins>**Usage:**</ins>

```
pmv-cli invites list-sessions [OPTIONS]
```

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-c, --csv` | CSV format |
| `-h, --help` | Print help |

### Command: invites close-session

Closes an invited session

<ins>**Usage:**</ins>

```
pmv-cli invites close-session <INDEX>
```

<ins>**Arguments:**</ins>

| Argument | Description |
| --- | --- |
| `<INDEX>` | Session index |

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

## Command: batch

Applies a batch operation to a list of media assets
Expand Down Expand Up @@ -1752,3 +1894,19 @@ pmv-cli batch delete
| Option | Description |
| --- | --- |
| `-h, --help` | Print help |

## Command: get-server-information

Gets server information, like the version it is using

<ins>**Usage:**</ins>

```
pmv-cli get-server-information
```

<ins>**Options:**</ins>

| Option | Description |
| --- | --- |
| `-h, --help` | Print help |
8 changes: 7 additions & 1 deletion static/apis/en/api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ swagger: "2.0"
info:
title: PersonalMediaVault Backend API
description: API to access PersonalMediaVault from a web client.
version: 1.15.0
version: 1.15.2

schemes:
- http
Expand Down Expand Up @@ -495,6 +495,9 @@ paths:
force_start_beginning:
type: boolean
description: "True to indicate clients that this media cannot save it's time status (for songs / short anims)"
is_anim:
type: boolean
description: "True to indicate the video is an animation, for example an animated gif"
img_notes:
type: boolean
description: "True if the image has notes"
Expand Down Expand Up @@ -737,6 +740,9 @@ paths:
force_start_beginning:
type: boolean
description: "True to indicate clients that this media cannot save it's time status (for songs / short anims)"
is_anim:
type: boolean
description: "True to indicate the video is an animation, for example an animated gif"
security:
- SessionTokenHeader: []
responses:
Expand Down
2 changes: 1 addition & 1 deletion static/last_release.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"version": "1.15.0"
"version": "1.15.2"
}

0 comments on commit c08cebb

Please sign in to comment.