Skip to content

Commit 7e3e98b

Browse files
committed
updated readme and aliases
1 parent 102e811 commit 7e3e98b

File tree

2 files changed

+15
-22
lines changed

2 files changed

+15
-22
lines changed

.github/templates/README.template.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -214,16 +214,12 @@ like Blocked Endpoints and any sort of Auth.
214214

215215
Because Secured Signal API is just a Proxy you can use all of the [Signal REST API](https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/EXAMPLES.md) endpoints except for...
216216

217-
| Endpoint |
218-
| :-------------------- |
219-
| **/v1/about** |
220-
| **/v1/configuration** |
221-
| **/v1/devives** |
222-
| **/v1/register** |
223-
| **/v1/unregister** |
224-
| **/v1/qrcodelink** |
225-
| **/v1/accounts** |
226-
| **/v1/contacts** |
217+
| Endpoint | |
218+
| :-------------------- | ------------------ |
219+
| **/v1/about** | **/v1/unregister** |
220+
| **/v1/configuration** | **/v1/qrcodelink** |
221+
| **/v1/devives** | **/v1/contacts** |
222+
| **/v1/register** | **/v1/accounts** |
227223

228224
> [!NOTE]
229225
> Matching works by checking if the requested Endpoints startswith a Blocked or Allowed Endpoint
@@ -267,17 +263,15 @@ variables:
267263

268264
To improve compatibility with other services Secured Signal API provides aliases for the `message` attribute by default:
269265

270-
| Alias | Score |
271-
| ----------- | ----- |
272-
| msg | 100 |
273-
| content | 99 |
274-
| description | 98 |
275-
| text | 20 |
276-
| body | 15 |
277-
| summary | 10 |
278-
| details | 9 |
279-
| payload | 2 |
280-
| data | 1 |
266+
| Alias | Score | Alias | Score |
267+
| ------------ | ----- | ---------------- | ----- |
268+
| msg | 100 | data.content | 9 |
269+
| content | 99 | data.description | 8 |
270+
| description | 98 | data.text | 7 |
271+
| text | 20 | data.summary | 6 |
272+
| summary | 15 | data.details | 5 |
273+
| details | 14 | body | 2 |
274+
| data.message | 10 | data | 1 |
281275

282276
Secured Signal API will pick the best scoring Message Alias (if available) to extract the correct message from the Request Body.
283277

config/defaults.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ messageAliases:
1919
{ alias: data.summary, score: 6 },
2020
{ alias: data.details, score: 5 },
2121

22-
{ alias: payload, score: 3 },
2322
{ alias: body, score: 2 },
2423
{ alias: data, score: 1 },
2524
]

0 commit comments

Comments
 (0)