Skip to content

[DoNotMerge] Demo adding SwaggerUI to documentation #840

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

Draft
snake14 wants to merge 12 commits into
base: live
Choose a base branch
from
Draft

[DoNotMerge] Demo adding SwaggerUI to documentation #840

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
733c30c
Demo adding SwaggerUI to documentation
snake14 Sep 24, 2025
6dcd3bc
Adding files which were missed in first commit
snake14 Sep 24, 2025
8b0cdb2
Reverting unnecessary change
snake14 Sep 24, 2025
987f48c
Make the host of the include URL dynamic
snake14 Sep 24, 2025
ff00492
Add adjustment for dev instances using http
snake14 Sep 24, 2025
ec8edfc
Add heading back and link to the current list
snake14 Sep 24, 2025
1855032
Cleaned up routing and template a bit
snake14 Sep 25, 2025
b3e0ba9
A couple more adjustments
snake14 Sep 25, 2025
1b569e6
Made some minor corrections to the spec file
snake14 Sep 26, 2025
1ccd6ef
Reverted route caching change to put it in a standalong PR
snake14 Sep 26, 2025
c915327
Switch to constant to avoid unintentional downgrade from HTTPS
snake14 Sep 26, 2025
1adf70d
Scope the new constant even tighter
snake14 Sep 26, 2025
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
7 changes: 5 additions & 2 deletions app/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@
"slim/twig-view": "^3.0.0",
"php-di/php-di": "^7.0",
"ext-json": "*",
"symfony/yaml": "^6.4.7"
"symfony/yaml": "^6.4.7",
"swagger-api/swagger-ui": "^5.29"
},
"require-dev": {},
"scripts": {
"serve": [
"php -S 0.0.0.0:8000 -t public"
],
"start-ddev": [
"cd .. && bash ddev-developer-docs.sh"
]
}
}
63 changes: 62 additions & 1 deletion app/composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions app/helpers/Markdown/IncludeFilePostprocessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ private function getFileContent($url, $escape)
return 'remote file inclusion disabled';
}

// Replace the placeholder with the actual domain
if (str_contains($url, '[DOCS_DOMAIN]')) {
$url = str_replace('[DOCS_DOMAIN]', DOCS_DOMAIN, $url);
}

// When necessary, convert to http for local development environments
if (empty($_SERVER['HTTPS'])) {
$url = str_replace('https://', 'http://', $url);
}

try {
$content = @file_get_contents($url);
if ($content) {
Expand Down
Loading