mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-09-18 17:39:24 +00:00
1 line
96 KiB
JSON
1 line
96 KiB
JSON
|
{"openapi":"3.1.0","info":{"title":"Stirling PDF API","description":"API documentation for all Server-Side processing.\nPlease note some functionality might be UI only and missing from here.","termsOfService":"https://www.stirlingpdf.com/terms","contact":{"name":"Stirling Software","url":"https://www.stirlingpdf.com","email":"contact@stirlingpdf.com"},"license":{"name":"MIT","url":"https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/refs/heads/main/LICENSE","identifier":"MIT"},"version":"1.2.0"},"servers":[{"url":"https://stirlingpdf.io","description":"Generated server url"}],"tags":[{"name":"Filter","description":"Filter APIs"},{"name":"Admin Settings","description":"Admin-only Settings Management APIs"},{"name":"Security","description":"Security APIs"},{"name":"Pipeline","description":"Pipeline APIs"},{"name":"Analysis","description":"Analysis APIs"},{"name":"Misc","description":"Miscellaneous PDF APIs"},{"name":"Misc","description":"Miscellaneous APIs"},{"name":"Info","description":"Info APIs"},{"name":"Convert","description":"Convert APIs"},{"name":"General","description":"General APIs"}],"paths":{"/api/v1/admin/settings":{"get":{"tags":["Admin Settings"],"summary":"Get all application settings","description":"Retrieve all current application settings. Use includePending=true to include settings that will take effect after restart. Admin access required.","operationId":"getSettings","parameters":[{"name":"includePending","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Settings retrieved successfully","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Access denied - Admin role required","content":{"*/*":{"schema":{"type":"object"}}}}}},"put":{"tags":["Admin Settings"],"summary":"Update application settings (delta updates)","description":"Update specific application settings using dot notation keys. Only sends changed values. Changes take effect on restart. Admin access required.","operationId":"updateSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Settings updated successfully","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Invalid setting key or value","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Access denied - Admin role required","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Failed to save settings to configuration file","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/v1/admin/settings/section/{sectionName}":{"get":{"tags":["Admin Settings"],"summary":"Get specific settings section","description":"Retrieve settings for a specific section (e.g., security, system, ui). Admin access required.","operationId":"getSettingsSection","parameters":[{"name":"sectionName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Section settings retrieved successfully","content":{"*/*":{"schema":{"type":"object"}}}},"400":{"description":"Invalid section name","content":{"*/*":{"schema":{"type":"object"}}}},"403":{"description":"Access denied - Admin role required","content":{"*/*":{"schema":{"type":"object"}}}}}},"put":{"tags":["Admin Settings"],"summary":"Update specific settings section","description":"Update all settings within a specific section. Admin access required.","operationId":"updateSettingsSection","parameters":[{"name":"sectionName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":true},"responses":{"200":{"description":"Section settings updated successfully","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Invalid section name or data","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Access denied - Admin role required","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Failed to save settings","content":{
|