Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api doc link #277

Merged
merged 2 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Geopilot.Frontend/cypress/e2e/footer.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ describe("Footer tests", () => {
const expectedHeaders = [
"Information about geopilot",
"Terms of use",
"Version information",
"API",
"Development & bug tracking",
"License information",
];
Expand Down Expand Up @@ -91,7 +91,7 @@ describe("Footer tests", () => {
cy.wait("@termsOfUse");
cy.wait("@license");
cy.wait("@licenseCustom");
const expectedHeaders = ["Version information", "Development & bug tracking"];
const expectedHeaders = ["API", "Development & bug tracking"];
cy.get("h1")
.should("have.length", expectedHeaders.length)
.each(($el, index) => {
Expand Down
5 changes: 3 additions & 2 deletions src/Geopilot.Frontend/public/locale/de/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"addOrganisation": "Organisation hinzufügen",
"administration": "Administration",
"and": "und",
"api": "API",
"apiInformation": "Dieser <i>geopilot</i> verwendet die API-Version {{version}}. Weitere Informationen finden Sie in der <apiLink>Dokumentation</apiLink>.",
"bugTracking": "Bugtracking",
"cancel": "Abbrechen",
"clickToUpload": "Zum Hochladen klicken",
Expand Down Expand Up @@ -85,6 +87,5 @@
"usersLoadingError": "Beim Laden der Benutzer:innen ist ein Fehler aufgetreten: {{error}}",
"validate": "Validieren",
"validationIsRunning": "Die Datei wird gerade mit {{validators}} validiert...",
"version": "Version",
"versionInformation": "Versionsinformationen"
"version": "Version"
}
5 changes: 3 additions & 2 deletions src/Geopilot.Frontend/public/locale/en/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"addOrganisation": "Add organisation",
"administration": "Administration",
"and": "and",
"api": "API",
"apiInformation": "This <i>geopilot</i> uses the API version {{version}}. Further information can be found in the <apiLink>documentation</apiLink>.",
"bugTracking": "bug tracking",
"cancel": "Cancel",
"clickToUpload": "Click to upload",
Expand Down Expand Up @@ -85,6 +87,5 @@
"usersLoadingError": "An error occurred while loading the users: {{error}}",
"validate": "Validate",
"validationIsRunning": "The file is currently being validated with {{validators}}...",
"version": "Version",
"versionInformation": "Version information"
"version": "Version"
}
5 changes: 3 additions & 2 deletions src/Geopilot.Frontend/public/locale/fr/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"addOrganisation": "Ajouter une organisation",
"administration": "Administration",
"and": "et",
"api": "API",
"apiInformation": "Ce <i>geopilot</i> utilise la version {{version}} de l'API. Pour plus d'informations, consultez la <apiLink>documentation</apiLink>.",
"bugTracking": "Suivi des bugs",
"cancel": "Annuler",
"clickToUpload": "Cliquer pour télécharger",
Expand Down Expand Up @@ -85,6 +87,5 @@
"usersLoadingError": "Une erreur s'est produite lors du chargement des utilisateurs: {{error}}",
"validate": "Valider",
"validationIsRunning": "Le fichier est en cours de validation avec {{validators}}...",
"version": "Version",
"versionInformation": "Informations sur la version"
"version": "Version"
}
5 changes: 3 additions & 2 deletions src/Geopilot.Frontend/public/locale/it/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"addOrganisation": "Aggiungi organizzazione",
"administration": "Amministrazione",
"and": "e",
"api": "API",
"apiInformation": "Questo <i>geopilota</i> utilizza la versione dell'API {{version}}. Ulteriori informazioni sono disponibili nella <apiLink>documentazione</apiLink>.",
"bugTracking": "Tracciamento bug",
"cancel": "Annulla",
"clickToUpload": "Clicca per caricare",
Expand Down Expand Up @@ -85,6 +87,5 @@
"usersLoadingError": "Si è verificato un errore durante il caricamento degli utenti: {{error}}",
"validate": "Validare",
"validationIsRunning": "Il file è in corso di validazione con {{validators}}...",
"version": "Versione",
"versionInformation": "Informazioni sulla versione"
"version": "Versione"
}
12 changes: 9 additions & 3 deletions src/Geopilot.Frontend/src/pages/footer/about.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export const About = () => {
const [licenseInfo, setLicenseInfo] = useState<PackageList>();
const [licenseInfoCustom, setLicenseInfoCustom] = useState<PackageList>();
const { fetchApi } = useApi();
const { version, clientSettings, termsOfUse } = useAppSettings();
const { version, termsOfUse } = useAppSettings();
const { hash } = useLocation();

useEffect(() => {
Expand Down Expand Up @@ -62,10 +62,16 @@ export const About = () => {
{info && <MarkdownContent content={info} routeHash={"info"} />}
{termsOfUse && <MarkdownContent content={termsOfUse} routeHash={"termsofuse"} />}
<Typography variant="h1" id="version">
{t("versionInformation")}
{t("api")}
</Typography>
<p>
<b>geopilot {clientSettings?.application?.name}</b>: {version}
<Trans
i18nKey="apiInformation"
components={{
apiLink: <Link href={`${window.location.origin}/swagger/index.html`} target="_blank" rel="noreferrer" />,
}}
values={{ version }}
/>
</p>
<Typography variant="h1" id="development">
{t("development")} & {t("bugTracking")}
Expand Down