fixup! feat(lapis-docs): mark sections of the docs that are generated…

… from the config
GenSpectrum · Nov 13, 2024 · d3271fb · d3271fb
1 parent 88a2305
commit d3271fb
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
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
@@ -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
@@ -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
@@ -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
@@ -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 />