From 896ce3aa21e8ac9c45b9bd9625e6223b92f8081e Mon Sep 17 00:00:00 2001 From: Cecilia Stevens <63068179+ceciliastevens@users.noreply.github.com> Date: Wed, 30 Apr 2025 09:21:30 -0400 Subject: [PATCH 1/2] host export documentation --- docs/export.md | 44 ++++++++++++++++++++++++++++++++++++++++ docs/overrides/main.html | 2 ++ mkdocs.yml | 1 + 3 files changed, 47 insertions(+) create mode 100644 docs/export.md diff --git a/docs/export.md b/docs/export.md new file mode 100644 index 00000000..6a3748fb --- /dev/null +++ b/docs/export.md @@ -0,0 +1,44 @@ +--- +hide: + - navigation + - toc +--- +# + diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 75322ddb..052ad394 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -7,6 +7,8 @@ {% block footer %} {% if page.url == "api/" %} {% include "partials/redoc.html" %} + {% elif page.url == "export/" %} + {% include "partials/redoc.html" %} {% else %} {{ super() }} {% endif %} diff --git a/mkdocs.yml b/mkdocs.yml index a961cc6b..13d2459f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,6 +34,7 @@ edit_uri: "" nav: - Introduction: 'index.md' - API Reference: 'api.md' + - Export Reference: 'export.md' - SDK: - Introduction: 'sdk/index.md' - Client: 'sdk/client.md' From 7c1b2fb41c9ff03eea849c9f6f6a19cbe08fc5f7 Mon Sep 17 00:00:00 2001 From: Cecilia Stevens <63068179+ceciliastevens@users.noreply.github.com> Date: Thu, 1 May 2025 09:38:55 -0400 Subject: [PATCH 2/2] correct tab label and automatically expand response schemas --- docs/export.md | 1 + mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/export.md b/docs/export.md index 6a3748fb..14a1e199 100644 --- a/docs/export.md +++ b/docs/export.md @@ -10,6 +10,7 @@ hide: hideHostname: true, hideDownloadButton: true, hideSingleRequestSampleTab: true, + expandResponses: 'all', theme: { colors: { primary: { diff --git a/mkdocs.yml b/mkdocs.yml index 13d2459f..0ebe68ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,7 +34,7 @@ edit_uri: "" nav: - Introduction: 'index.md' - API Reference: 'api.md' - - Export Reference: 'export.md' + - Event Data Export: 'export.md' - SDK: - Introduction: 'sdk/index.md' - Client: 'sdk/client.md'