mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-06 18:30:57 +00:00
c660ad80ce
# Description of Changes Please provide a summary of the changes, including: - Updated default Terms & Conditions URL from `/terms-and-conditions` to `/terms` in: - `InitialSetup.java` - `settings.yml.template` - `allEndpointsRemovedSettings.yml` - Improved OpenAPI metadata in `OpenApiConfig.java`: - Added contact information (`name`, `url`, `email`) - Added license section with MIT license - Included terms of service link - Changed string comparison in `MetricsConfig.java` to use `"constant".equals(...)` format - Cleaned up and unified YAML formatting and comments - Merged and restructured `enterpriseEdition` settings under `premium.proFeatures` ### Why the change was made - Ensure legal links are consistent and up-to-date - Improve clarity and completeness of the OpenAPI specification for external consumers - Follow best practices for code readability and configuration structure - Prevent misconfiguration from outdated or redundant YAML sections --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
68 lines
2.8 KiB
Java
68 lines
2.8 KiB
Java
package stirling.software.SPDF.config;
|
|
|
|
import org.springframework.context.annotation.Bean;
|
|
import org.springframework.context.annotation.Configuration;
|
|
|
|
import io.swagger.v3.oas.models.Components;
|
|
import io.swagger.v3.oas.models.OpenAPI;
|
|
import io.swagger.v3.oas.models.info.Contact;
|
|
import io.swagger.v3.oas.models.info.Info;
|
|
import io.swagger.v3.oas.models.info.License;
|
|
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
|
import io.swagger.v3.oas.models.security.SecurityScheme;
|
|
|
|
import lombok.RequiredArgsConstructor;
|
|
|
|
import stirling.software.SPDF.model.ApplicationProperties;
|
|
|
|
@Configuration
|
|
@RequiredArgsConstructor
|
|
public class OpenApiConfig {
|
|
|
|
private final ApplicationProperties applicationProperties;
|
|
|
|
private static final String DEFAULT_TITLE = "Stirling PDF API";
|
|
private static final String DEFAULT_DESCRIPTION =
|
|
"API documentation for all Server-Side processing.\n"
|
|
+ "Please note some functionality might be UI only and missing from here.";
|
|
|
|
@Bean
|
|
public OpenAPI customOpenAPI() {
|
|
String version = getClass().getPackage().getImplementationVersion();
|
|
if (version == null) {
|
|
// default version if all else fails
|
|
version = "1.0.0";
|
|
}
|
|
Info info =
|
|
new Info()
|
|
.title(DEFAULT_TITLE)
|
|
.version(version)
|
|
.license(
|
|
new License()
|
|
.name("MIT")
|
|
.url(
|
|
"https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/refs/heads/main/LICENSE")
|
|
.identifier("MIT"))
|
|
.termsOfService("https://www.stirlingpdf.com/terms")
|
|
.contact(
|
|
new Contact()
|
|
.name("Stirling Software")
|
|
.url("https://www.stirlingpdf.com")
|
|
.email("contact@stirlingpdf.com"))
|
|
.description(DEFAULT_DESCRIPTION);
|
|
if (!applicationProperties.getSecurity().getEnableLogin()) {
|
|
return new OpenAPI().components(new Components()).info(info);
|
|
} else {
|
|
SecurityScheme apiKeyScheme =
|
|
new SecurityScheme()
|
|
.type(SecurityScheme.Type.APIKEY)
|
|
.in(SecurityScheme.In.HEADER)
|
|
.name("X-API-KEY");
|
|
return new OpenAPI()
|
|
.components(new Components().addSecuritySchemes("apiKey", apiKeyScheme))
|
|
.info(info)
|
|
.addSecurityItem(new SecurityRequirement().addList("apiKey"));
|
|
}
|
|
}
|
|
}
|