Skip to content

docs(lapis-docs): change order of articles in the 'concepts' section #1592

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.

Sign up for GitHub

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

Merged
fhennig merged 2 commits into from
Mar 12, 2026
Merged

docs(lapis-docs): change order of articles in the 'concepts' section #1592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b98f305
change concept order
fhennig Mar 10, 2026
0000087
change order in the test file
fhennig Mar 11, 2026
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
75 changes: 40 additions & 35 deletions lapis-docs/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,24 +79,8 @@ export default defineConfig({
label: 'Concepts',
items: [
{
label: 'Data versions',
link: '/concepts/data-versions',
},
{
label: 'Mutation filters',
link: '/concepts/mutation-filters',
},
{
label: 'Insertion filters',
link: '/concepts/insertion-filters',
},
{
label: 'Ambiguous symbols',
link: '/concepts/ambiguous-symbols',
},
{
label: 'Pango lineage query',
link: '/concepts/pango-lineage-query',
label: 'Authentication',
link: '/concepts/authentication',
},
{
label: 'Request methods: GET and POST',
Expand All @@ -107,28 +91,49 @@ export default defineConfig({
link: '/concepts/response-format',
},
{
label: 'Variant query',
link: '/concepts/variant-query',
},
{
label: 'Advanced query',
link: '/concepts/advanced-query',
},
{
label: 'String search',
link: '/concepts/string-search',
},
{
label: 'Filtering for null',
link: '/concepts/filtering-for-null',
label: 'Data versions',
link: '/concepts/data-versions',
},
{
label: 'Request Id',
label: 'Request ID',
link: '/concepts/request-id',
},
{
label: 'Authentication',
link: '/concepts/authentication',
label: 'Filters',
items: [
{
label: 'Mutation filters',
link: '/concepts/mutation-filters',
},
{
label: 'Insertion filters',
link: '/concepts/insertion-filters',
},
{
label: 'Ambiguous symbols',
link: '/concepts/ambiguous-symbols',
},
{
label: 'Pango lineage query',
link: '/concepts/pango-lineage-query',
},
{
label: 'Variant query',
link: '/concepts/variant-query',
},
{
label: 'Advanced query',
link: '/concepts/advanced-query',
},
{
label: 'String search',
link: '/concepts/string-search',
},
{
label: 'Filtering for null',
link: '/concepts/filtering-for-null',
},
],
},
],
},
Expand Down
12 changes: 6 additions & 6 deletions lapis-docs/src/content/docs/concepts/request-id.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
title: Request Id
description: Request Id
title: Request ID
description: Request ID
---

LAPIS uses a request id to identify requests.
LAPIS uses a request ID to identify requests.
This is useful for debugging and logging purposes.

:::note
If you report an error that occurred in LAPIS, please include the request id.
If you report an error that occurred in LAPIS, please include the request ID.
This will greatly simplify identifying the problem in our log files.
:::

You can provide a request id in the request as an HTTP header `X-Request-Id`.
You can provide a request ID in the request as an HTTP header `X-Request-Id`.
This is useful if you want to correlate requests in your own log files with the LAPIS log files
to track problems across systems, e.g. if your own API calls LAPIS.

:::caution
If you use the `X-Request-Id` header, make sure that the value is unique.
:::

If you don't specify a request id, LAPIS will generate one for you.
If you don't specify a request ID, LAPIS will generate one for you.
It is contained in the response header `X-Request-Id` and in `info` in the response body.
8 changes: 4 additions & 4 deletions lapis-docs/tests/docs.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,19 @@ const referencesPages = prependToRelativeUrl(

const conceptsPages = prependToRelativeUrl(
[
{ title: 'Authentication', relativeUrl: '/authentication' },
{ title: 'Request methods: GET and POST', relativeUrl: '/request-methods' },
{ title: 'Response format', relativeUrl: '/response-format' },
{ title: 'Data versions', relativeUrl: '/data-versions' },
{ title: 'Request ID', relativeUrl: '/request-id' },
{ title: 'Mutation filters', relativeUrl: '/mutation-filters' },
{ title: 'Insertion filters', relativeUrl: '/insertion-filters' },
{ title: 'Ambiguous symbols', relativeUrl: '/ambiguous-symbols' },
{ title: 'Pango lineage query', relativeUrl: '/pango-lineage-query' },
{ title: 'Request methods: GET and POST', relativeUrl: '/request-methods' },
{ title: 'Response format', relativeUrl: '/response-format' },
{ title: 'Variant query', relativeUrl: '/variant-query' },
{ title: 'Advanced query', relativeUrl: '/advanced-query' },
{ title: 'String search', relativeUrl: '/string-search' },
{ title: 'Filtering for null', relativeUrl: '/filtering-for-null' },
{ title: 'Request Id', relativeUrl: '/request-id' },
{ title: 'Authentication', relativeUrl: '/authentication' },
],
'/concepts',
);
Expand Down
Loading