Skip to content

feat: allow downloading openapi specs (without decorators) #1414

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
merged 1 commit into from
Jan 17, 2025
Merged

feat: allow downloading openapi specs (without decorators) #1414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ tsconfig.tsbuildinfo
sources/api/*
!sources/api/sidebars.js
apify-api.yaml
static/api
apify-docs-theme/package-lock.json
4 changes: 4 additions & 0 deletions apify-docs-theme/src/theme/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1833,6 +1833,10 @@ iframe[src*="youtube"] {
text-transform: none;
}

.plugin-id-openapi .export-button {
--ifm-button-size-multiplier: 1.5;
}

@media (max-width: 996px) {
div[class^="navbarSearchContainer"] {
position: static;
Expand Down
1 change: 1 addition & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ module.exports = {
config: {
/** @type {import('docusaurus-plugin-openapi-docs').Options} */
v2: {
downloadUrl: 'apify-api.yaml',
specPath: 'apify-api.yaml',
outputDir: './sources/api',
markdownGenerators: {
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@
"start": "npm run api:rebuild && rimraf .docusaurus && cross-env LOCALHOST=1 CRAWLEE_DOCS_FAST=1 docusaurus start",
"start:dev": "npm run api:rebuild && rimraf .docusaurus && cross-env DEV=1 CRAWLEE_DOCS_FAST=1 docusaurus start",
"build": "npm run api:rebuild && rimraf .docusaurus && docusaurus build",
"api:generate": "npm run redoc:build && docusaurus gen-api-docs all",
"api:generate": "npm run redoc:build && npm run redoc:build:clean && docusaurus gen-api-docs all",
"api:clean": "docusaurus clean-api-docs all",
"api:rebuild": "npm run api:clean && npm run api:generate",
"redoc:start": "redocly preview-docs",
"redoc:build": "redocly bundle apify-api/openapi/openapi.yaml -o apify-api",
"redoc:build:clean": "redocly bundle apify-api/openapi/openapi.yaml --skip-decorator=apify/legacy-doc-url-decorator --skip-decorator=apify/client-references-links-decorator --skip-decorator=apify/code-samples-decorator -o static/api/apify-api.yaml",
"redoc:test": "redocly lint && npm run redoc:build",
"redoc:test2": "redocly lint && npm run redoc:build && bin/schemathesis",
"write-translations": "docusaurus write-translations",
Expand Down
Loading