Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

Commit 49a7224

Browse files
committed
Update documentation
Signed-off-by: Vitor Mattos <[email protected]>
1 parent da3902d commit 49a7224

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

site/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ module.exports = {
44
description: 'Libre digital signature app for Nextcloud.',
55
theme: 'openapi',
66
themeConfig: {
7-
servers: ['/api/0.1/'],
7+
servers: ['/api/v1/'],
88
locales: {
99
'/': {
1010
sidebar: 'auto',

site/.vuepress/public/Insomnia_2021-11-24.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

site/.vuepress/public/specs/api.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ info:
1111
version: 2.2.2
1212
servers:
1313
- description: local
14-
url: 'http://localhost/apps/libresign/api/0.1'
14+
url: 'http://localhost/ocsapp/apps/libresign/api/v1'
1515
tags:
1616
- name: account
1717
description: Account
@@ -1209,7 +1209,7 @@ paths:
12091209
type: string
12101210
description: Success message
12111211
example: Success
1212-
'401':
1212+
'422':
12131213
description: Request failed
12141214
content:
12151215
application/json:
@@ -1255,7 +1255,7 @@ paths:
12551255
type: string
12561256
description: Success message
12571257
example: Success
1258-
'401':
1258+
'422':
12591259
description: Request failed
12601260
content:
12611261
application/json:

site/Getting-started.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Example:
1818

1919
```bash
2020
curl -X POST \
21-
http://localhost/index.php/apps/libresign/api/0.1/webhook/register \
21+
http://localhost/index.php/apps/libresign/api/v1/webhook/register \
2222
-H 'Accept: application/json' \
2323
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
2424
-H 'Content-Type: application/json'
@@ -50,7 +50,7 @@ POST /request-signature
5050

5151
```bash
5252
curl --request POST \
53-
--url http://localhost/apps/libresign/api/0.1/request-signature \
53+
--url http://localhost/apps/libresign/api/v1/request-signature \
5454
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
5555
--header 'Content-Type: application/json' \
5656
--data '{
@@ -80,7 +80,7 @@ The association between user and file will result on a `fileUserId`. You will ne
8080

8181
```bash
8282
curl --request GET \
83-
--url http://localhost/apps/libresign/api/0.1/file/validate/file_id/1995 \
83+
--url http://localhost/apps/libresign/api/v1/file/validate/file_id/1995 \
8484
--header 'Authorization: Basic YWRtaW46YWRtaW4='
8585
```
8686

@@ -90,7 +90,7 @@ List all LibreSign files
9090

9191
```bash
9292
curl --request GET \
93-
--url http://localhost/apps/libresign/api/0.1/file/list \
93+
--url http://localhost/apps/libresign/api/v1/file/list \
9494
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
9595
```
9696

@@ -101,7 +101,7 @@ POST /file/{uuid}/elements
101101

102102
```bash
103103
curl --request POST \
104-
--url http://localhost/apps/libresign/api/0.1/file/88968195-6f0a-4036-ac05-9680feb109e4/elements \
104+
--url http://localhost/apps/libresign/api/v1/file/88968195-6f0a-4036-ac05-9680feb109e4/elements \
105105
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
106106
--header 'Content-Type: application/json' \
107107
--data '{
@@ -124,7 +124,7 @@ The UUID you will receive when you will do a request to `POST /request-signature
124124

125125
```bash
126126
curl --request PATCH \
127-
--url http://localhost/apps/libresign/api/0.1/file/87e5d5f0-1a9b-48cd-8146-0ee8b3aafd83/elements/1 \
127+
--url http://localhost/apps/libresign/api/v1/file/87e5d5f0-1a9b-48cd-8146-0ee8b3aafd83/elements/1 \
128128
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
129129
--header 'Content-Type: application/json' \
130130
--data '{
@@ -149,7 +149,7 @@ If the system is enabled to sign using password, the user will need to create a
149149

150150
```bash
151151
curl --request POST \
152-
--url http://localhost/apps/libresign/api/0.1/account/signature \
152+
--url http://localhost/apps/libresign/api/v1/account/signature \
153153
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
154154
--header 'Content-Type: application/json' \
155155
--data '{
@@ -165,7 +165,7 @@ You will need change the status of a file from draft to able to sign. When you c
165165
166166
```bash
167167
curl --request PATCH \
168-
--url http://localhost/apps/libresign/api/0.1/request-signature \
168+
--url http://localhost/apps/libresign/api/v1/request-signature \
169169
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
170170
--header 'Content-Type: application/json' \
171171
--data '{
@@ -182,7 +182,7 @@ This is necessary for all user to store the own signature or initial.
182182

183183
```bash
184184
curl --request POST \
185-
--url http://localhost/apps/libresign/api/0.1/account/signature/elements \
185+
--url http://localhost/apps/libresign/api/v1/account/signature/elements \
186186
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
187187
--header 'Content-Type: application/json' \
188188
--data '{
@@ -212,11 +212,11 @@ To sign using SMS you will need install the app `twofactor_gateway` and configur
212212
Example:
213213

214214
```bash
215-
docker-compose exec --user www-data nextcloud php occ config:app:set libresign sign_method --value=password
215+
docker-compose exec --user www-data nextcloud php occ config:app:set libresign identify_method --value=["nextcloud"]
216216

217-
docker-compose exec --user www-data nextcloud php occ config:app:set libresign sign_method --value=email
217+
docker-compose exec --user www-data nextcloud php occ config:app:set libresign identify_method --value=["email"]
218218

219-
docker-compose exec --user www-data nextcloud php occ config:app:set libresign sign_method --value=sms
219+
docker-compose exec --user www-data nextcloud php occ config:app:set libresign identify_method --value=["sms"]
220220
```
221221

222222
#### SMS
@@ -247,7 +247,7 @@ If the sign method is a code, the authenticated user will need request a code to
247247

248248
```bash
249249
curl --request POST \
250-
--url http://localhost/apps/libresign/api/0.1/sign/file_id/3051/code \
250+
--url http://localhost/apps/libresign/api/v1/sign/file_id/3051/code \
251251
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
252252
--header 'Content-Type: application/json' \
253253
```
@@ -257,7 +257,7 @@ To sign you only will need send the code that you received by email or SMS.
257257

258258
```bash
259259
curl --request POST \
260-
--url http://localhost/apps/libresign/api/0.1/sign/file_id/1995 \
260+
--url http://localhost/apps/libresign/api/v1/sign/file_id/1995 \
261261
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
262262
--header 'Content-Type: application/json' \
263263
--data '{

site/pt/Getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Exemplo:
1212

1313
```bash
1414
curl -X POST \
15-
http://localhost/index.php/apps/libresign/api/0.1/webhook/register \
15+
http://localhost/index.php/apps/libresign/api/v1/webhook/register \
1616
-H 'Accept: application/json' \
1717
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
1818
-H 'Content-Type: application/json'
@@ -33,4 +33,4 @@ curl -X POST \
3333

3434
# Endpoints
3535

36-
[Documetnação da Api](api)
36+
[Documetnação da Api](api)

0 commit comments

Comments
 (0)