forked from plexara/api-test
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
162 lines (154 loc) · 4.87 KB
/
mkdocs.yml
File metadata and controls
162 lines (154 loc) · 4.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
site_name: api-test
# Trailing slash matters: it's used as a prefix in OG/Twitter card URLs
# and in JSON-LD, where doubling-up "//" breaks tools that don't normalize.
site_url: https://api-test.plexara.io/
site_description: >-
api-test is a controllable HTTP REST fixture, built specifically as an
upstream for testing API gateways. Endpoint groups for identity,
deterministic data, controlled failures, pagination styles, and SSRF
probes; multiple inbound auth modes matching what the Plexara API
gateway sends; and a Postgres-backed audit log of every request.
Open source by Plexara, Apache 2.0.
site_author: Plexara
repo_url: https://github.com/plexara/api-test
repo_name: plexara/api-test
edit_uri: edit/main/docs/
copyright: Copyright © 2026 Plexara
theme:
name: material
custom_dir: docs/overrides
logo: images/logo.svg
favicon: images/logo.svg
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to light mode
font: false
icon:
repo: fontawesome/brands/github
features:
- navigation.instant
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- navigation.footer
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- content.tabs.link
- content.action.edit
- toc.follow
- announce.dismiss
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started/overview.md
- Installation: getting-started/installation.md
- Quickstart: getting-started/quickstart.md
- Register with Plexara: getting-started/register-with-plexara.md
- Configuration:
- YAML Reference: configuration/reference.md
- Environment Variables: configuration/environment.md
- Authentication: configuration/auth.md
- Database & Migrations: configuration/database.md
- Endpoints:
- Overview: endpoints/overview.md
- Identity: endpoints/identity.md
- Data: endpoints/data.md
- Failure Modes: endpoints/failure.md
- Echo: endpoints/echo.md
- Streaming: endpoints/streaming.md
- Pagination: endpoints/pagination.md
- Methods: endpoints/methods.md
- Security: endpoints/security.md
- Export: endpoints/export.md
- Operations:
- Audit Log: operations/audit.md
- Portal: operations/portal.md
- Deployment: operations/deployment.md
- Testing a Gateway: operations/gateway-testing.md
- Troubleshooting: operations/troubleshooting.md
- Reference:
- HTTP API: reference/http-api.md
- Architecture: reference/architecture.md
- Releases: reference/releases.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/plexara/api-test
name: api-test on GitHub
- icon: fontawesome/solid/globe
link: https://plexara.io
name: Plexara
generator: false
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/shots.js
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: plexara
repo: api-test
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
# Note: mkdocs-material's `social` plugin (per-page auto-generated
# 1200x630 cards) was previously wired in here. We removed it in
# favor of a curated, hand-designed OG banner at images/og-card.png
# used site-wide via docs/overrides/main.html. The Tailwind / Stripe /
# Vercel pattern: one strong brand banner beats N generic
# auto-renders. To opt back into per-page cards, restore the plugin
# entry and re-add the imaging system deps + 'mkdocs-material[imaging]'
# to .github/workflows/docs.yml.