From a1411c7f2c10ab7c0e3cd49b8ffff38009ade35b Mon Sep 17 00:00:00 2001 From: Alexis Degrugillier Date: Wed, 10 Sep 2025 01:04:17 -0400 Subject: Translate the API information page (#7922) Closes #6222 Translate the `api/index.php` page * Update app/i18n/pl/api.php Co-authored-by: Inverle * Update app/i18n/de/api.php Co-authored-by: maTh <1645099+math-GH@users.noreply.github.com> * i18n: fr * Co-authored-by: Alexandre Alapetite --------- Co-authored-by: Inverle Co-authored-by: maTh <1645099+math-GH@users.noreply.github.com> Co-authored-by: Alexandre Alapetite --- p/api/index.php | 58 +++++++++++++++------------- p/scripts/api.js | 114 +++++++++++++++++++++++++++++++++++-------------------- 2 files changed, 104 insertions(+), 68 deletions(-) (limited to 'p') diff --git a/p/api/index.php b/p/api/index.php index 1db1273dc..279826aa5 100644 --- a/p/api/index.php +++ b/p/api/index.php @@ -1,52 +1,58 @@ -FreshRSS API endpoints +<?= _t('api.information.title') ?> - -

FreshRSS API endpoints

+

-

Google Reader compatible API

+

-
Your API address:
-
-
Google Reader API configuration test:
-
?
+
+
+
+
+
?
-

Fever compatible API

+

-
Your API address:
-
-
Fever API configuration test:
-
?
+
+
+
+
?
-

API for extensions

+

-
Your API address:
-
+
+
diff --git a/p/scripts/api.js b/p/scripts/api.js index ce52c50ad..62ce386f8 100644 --- a/p/scripts/api.js +++ b/p/scripts/api.js @@ -1,7 +1,7 @@ // @license magnet:?xt=urn:btih:0b31508aeb0634b347b8270c7bee4d411b5d4109&dn=agpl-3.0.txt AGPL-3.0 'use strict'; -function check(url, next) { +const check = function (url, next) { if (!url || !next) { return; } @@ -19,45 +19,75 @@ function check(url, next) { } }; req.send(); -} - -const jsonVars = JSON.parse(document.getElementById('jsonVars').innerHTML); - -check(jsonVars.greader + '/check/compatibility', function next(result1) { - const greaderOutput = document.getElementById('greaderOutput'); - if (result1 === 'PASS') { - greaderOutput.innerHTML = '✔️ ' + result1; - } else { - check(jsonVars.greader + '/check%2Fcompatibility', function next(result2) { - if (result2 === 'PASS') { - greaderOutput.innerHTML = '⚠️ WARN: no %2F support, so some clients will not work!'; - } else { - check('./greader.php/check/compatibility', function next(result3) { - if (result3 === 'PASS') { - greaderOutput.innerHTML = '⚠️ WARN: Probable invalid base URL in ./data/config.php'; - } else { - greaderOutput.innerHTML = '❌ ' + result1; - } - }); - } - }); - } -}); - -check(jsonVars.fever + '?api', function next(result1) { - const feverOutput = document.getElementById('feverOutput'); - try { - JSON.parse(result1); - feverOutput.innerHTML = '✔️ PASS'; - } catch (ex) { - check('./fever.php?api', function next(result2) { - try { - JSON.parse(result2); - feverOutput.innerHTML = '⚠️ WARN: Probable invalid base URL in ./data/config.php'; - } catch (ex) { - feverOutput.innerHTML = '❌ ' + result1; - } - }); - } -}); +}; + +const pass = function (output) { + output.innerHTML = output.dataset.i18nPass; +}; + +const encodingSupport = function (output) { + output.innerHTML = output.dataset.i18nEncodingSupport; +}; + +const invalidConfiguration = function (output) { + output.innerHTML = output.dataset.i18nInvalidConfiguration; +}; + +const unknownError = function (output, message) { + output.innerHTML = output.dataset.i18nUnknownError + message; +}; + +const checkGReaderAPI = function () { + const output = document.getElementById('greaderOutput'); + const apiUrl = output.dataset.apiUrl; + + check(apiUrl + '/check/compatibility', function next(result1) { + if (result1 === 'PASS') { + pass(output); + } else { + check(apiUrl + '/check%2Fcompatibility', function next(result2) { + if (result2 === 'PASS') { + encodingSupport(output); + } else { + check('./greader.php/check/compatibility', function next(result3) { + if (result3 === 'PASS') { + invalidConfiguration(output); + } else { + unknownError(output, result1); + } + }); + } + }); + } + }); +}; + +const checkFeverAPI = function () { + const output = document.getElementById('feverOutput'); + const apiUrl = output.dataset.apiUrl; + + check(apiUrl + '?api', function next(result1) { + try { + JSON.parse(result1); + pass(output); + } catch (ex) { + check('./fever.php?api', function next(result2) { + try { + JSON.parse(result2); + invalidConfiguration(output); + } catch (ex) { + unknownError(output, result1); + } + }); + } + }); +}; + +/** + * The API tests are done this way to simulate in a more accurate manner + * outside requests. Since the APIs are used by third-party tools, they + * cannot interact at the server level. + */ +checkGReaderAPI(); +checkFeverAPI(); // @license-end -- cgit v1.2.3