-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
841ee02
commit f1c9a3d
Showing
58 changed files
with
7,335 additions
and
1,293 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/English/API Documentation/postman/Language.postman_collection.utils.json
Large diffs are not rendered by default.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
docs/English/API Documentation/postman/Stars.postman_collection.utils.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"info":{"name":"Stars","description":"All of the endpoints under the 'Stars' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Stars","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stars?=","host":["{{DOMAIN}}"],"path":["stars"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L49)\n\nGet all starred translations\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Stars","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stars?=","host":["{{DOMAIN}}"],"path":["stars"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L49)\n\nGet all starred translations\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"Translation Star","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nGet the stars for a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n#### Response\n\n##### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n\n```\n\n##### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source` | The source text | string | No |\n| `result` | The result text | string | No |\n| `language` | The translation languages | string | No |\n| `users` | The number of users who starred the translation | <class 'int'> | No |\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Star","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nGet the stars for a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n#### Response\n\n##### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n\n```\n\n##### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source` | The source text | string | No |\n| `result` | The result text | string | No |\n| `language` | The translation languages | string | No |\n| `users` | The number of users who starred the translation | <class 'int'> | No |\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n"}]},{"name":"Translation Star","event":[],"request":{"method":"POST","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=token","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[{"key":"token","value":"<token:TranslationToken>","description":"The token to authenticate the translation"}]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nStar a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n#### Response\n\n##### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n\n```\n\n##### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source` | The source text | string | No |\n| `result` | The result text | string | No |\n| `language` | The translation languages | string | No |\n| `users` | The number of users who starred the translation | <class 'int'> | No |\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Star","event":[],"request":{"method":"POST","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=token","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[{"key":"token","value":"<token:TranslationToken>","description":"The token to authenticate the translation"}]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nStar a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n#### Response\n\n##### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n\n```\n\n##### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source` | The source text | string | No |\n| `result` | The result text | string | No |\n| `language` | The translation languages | string | No |\n| `users` | The number of users who starred the translation | <class 'int'> | No |\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source\": \"no example\",\n \"result\": \"no example\",\n \"language\": \"no example\",\n \"users\": \"no example\"\n }\n}\n"}]},{"name":"Translation Star","event":[],"request":{"method":"DELETE","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nUnstar a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Star","event":[],"request":{"method":"DELETE","header":[],"url":{"raw":"{{DOMAIN}}/stars/{{translation_id}}?=","host":["{{DOMAIN}}"],"path":["stars","{{translation_id}}"],"query":[]},"description":"\n> [server/endpoints/stars.py](../../server/endpoints/stars.py#L82)\n\nUnstar a translation\n\n\n#### Authentication\n\nLogin is **not** required\n\n##### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `FORBIDDEN` | You are not allowed to star this translation | 403 |\n| `NOT_FOUND` | The translation could not be found | 404 |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} |
1 change: 1 addition & 0 deletions
1
docs/English/API Documentation/postman/Stats.postman_collection.utils.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"info":{"name":"Stats","description":"All of the endpoints under the 'Stats' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"<granularity:Granularity>","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"<granularity:Granularity>","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"<granularity:Granularity>","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"<granularity:Granularity>","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} |
2 changes: 1 addition & 1 deletion
2
docs/English/API Documentation/postman/Translation.postman_collection.utils.json
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.