diff --git a/lapis-docs/astro.config.mjs b/lapis-docs/astro.config.mjs index 2ae6f8404..40d962809 100644 --- a/lapis-docs/astro.config.mjs +++ b/lapis-docs/astro.config.mjs @@ -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', @@ -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', + }, + ], }, ], }, diff --git a/lapis-docs/src/content/docs/concepts/request-id.mdx b/lapis-docs/src/content/docs/concepts/request-id.mdx index 533231452..066b9f354 100644 --- a/lapis-docs/src/content/docs/concepts/request-id.mdx +++ b/lapis-docs/src/content/docs/concepts/request-id.mdx @@ -1,17 +1,17 @@ --- -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. @@ -19,5 +19,5 @@ to track problems across systems, e.g. if your own API calls LAPIS. 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. diff --git a/lapis-docs/tests/docs.spec.ts b/lapis-docs/tests/docs.spec.ts index fe3a110bb..211cb5d3e 100644 --- a/lapis-docs/tests/docs.spec.ts +++ b/lapis-docs/tests/docs.spec.ts @@ -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', );