From d3271fbc5176c40a4f78fc323c124cc2db2d0917 Mon Sep 17 00:00:00 2001
From: Fabian Engelniederhammer <fabian.engelniederhammer@tngtech.com>
Date: Wed, 13 Nov 2024 13:06:33 +0100
Subject: [PATCH] fixup! feat(lapis-docs): mark sections of the docs that are
 generated from the config

---
 .../content/docs/getting-started/generate-your-request.mdx   | 5 +++++
 lapis-docs/src/content/docs/references/database-config.mdx   | 4 ++++
 .../src/content/docs/references/open-api-definition.mdx      | 4 ++++
 lapis-docs/src/content/docs/references/reference-genomes.mdx | 4 ++++
 4 files changed, 17 insertions(+)

diff --git a/lapis-docs/src/content/docs/getting-started/generate-your-request.mdx b/lapis-docs/src/content/docs/getting-started/generate-your-request.mdx
index a37edb590..7f5b30754 100644
--- a/lapis-docs/src/content/docs/getting-started/generate-your-request.mdx
+++ b/lapis-docs/src/content/docs/getting-started/generate-your-request.mdx
@@ -8,4 +8,9 @@ import { getLapisUrl } from '../../../lapisUrl.js';
 import { getReferenceGenomes } from '../../../reference_genomes.js';
 import { QueryGenerator } from '../../../components/QueryGenerator/QueryGenerator.tsx';
 
+:::note
+This generator is tailored to the configuration of the underlying LAPIS instance.
+Available fields may differ between instances.
+:::
+
 <QueryGenerator client:load config={getConfig()} referenceGenomes={getReferenceGenomes()} lapisUrl={getLapisUrl()} />
diff --git a/lapis-docs/src/content/docs/references/database-config.mdx b/lapis-docs/src/content/docs/references/database-config.mdx
index 2aabe36c6..77e4d0272 100644
--- a/lapis-docs/src/content/docs/references/database-config.mdx
+++ b/lapis-docs/src/content/docs/references/database-config.mdx
@@ -5,6 +5,10 @@ description: database config
 
 import DatabaseConfig from '../../../components/DatabaseConfig.astro';
 
+:::note
+This page is generated from the underlying LAPIS configuration.
+:::
+
 This instance of LAPIS uses the following configuration file:
 
 <DatabaseConfig />
diff --git a/lapis-docs/src/content/docs/references/open-api-definition.mdx b/lapis-docs/src/content/docs/references/open-api-definition.mdx
index 3c6efa2e6..9cda25844 100644
--- a/lapis-docs/src/content/docs/references/open-api-definition.mdx
+++ b/lapis-docs/src/content/docs/references/open-api-definition.mdx
@@ -5,4 +5,8 @@ description: Open API / Swagger
 
 import SwaggerUIContainer from '../../../components/SwaggerUIContainer.astro';
 
+:::note
+The SwaggerUI is generated from the LAPIS database config and thus it is specific to the underlying LAPIS instance.
+:::
+
 <SwaggerUIContainer />
diff --git a/lapis-docs/src/content/docs/references/reference-genomes.mdx b/lapis-docs/src/content/docs/references/reference-genomes.mdx
index e668f5bae..eab9992f3 100644
--- a/lapis-docs/src/content/docs/references/reference-genomes.mdx
+++ b/lapis-docs/src/content/docs/references/reference-genomes.mdx
@@ -5,6 +5,10 @@ description: reference genome
 
 import RefereneceGenome from '../../../components/ReferenceGenome.astro';
 
+:::note
+This page is generated from the underlying LAPIS configuration.
+:::
+
 This instance of LAPIS uses the following reference genome:
 
 <RefereneceGenome />