exampleSetFlag additional property

Question

I am using Swagger in my RESTEasy project.

I am using the swagger-jaxrs2 version 2.1.12

Swagger UI displays GET api/{job-id} , POST api/{job-id}, DELETE api/{job-id} and GET api/restesy/{job-id} also along with my API's endpoints.
In the openapi.json, "schema" : { "type" : "string" , "exampleSetFlag" : false } is generating multiple times. So I am getting an error in the swagger editor that , " schema should not have additional properties, additionalProperty : exampleSetFlag

If I use swagger-jaxrs2 version 2.0.6, additionalProperties and extra endpoints are not generated, but the "info" section is not generated in the openapi.json. Getting error missingProperty :info

I would like to grow with the latest version, but how do I resolve generating of additionalProperty : exampleSetFlag and extra endpoints?

bella934 · Answer

Hello, Techtez&nbsp;&nbsp;1. Resolving additionalProperty: exampleSetFlag ErrorThe error regarding exampleSetFlag likely stems from incompatibilities between your Swagger configuration and the generated OpenAPI specification. This issue can be addressed as follows:a. Upgrade or Adjust Swagger AnnotationsEnsure you're using the appropriate annotations for Swagger compatibility. Double-check the annotations on your model and endpoints to avoid unnecessary fields like exampleSetFlag.b. Customize Schema GenerationYou can customize the schema generation by overriding Swagger's default schema behavior. To do this, implement a custom ModelConverter:javaimport io.swagger.v3.core.converter.ModelConverter;import io.swagger.v3.core.converter.ModelConverterContext;import io.swagger.v3.oas.models.media.Schema;public class CustomModelConverter implements ModelConverter {&nbsp; &nbsp; @Override&nbsp; &nbsp; public Schema&lt;?&gt; resolveSchema(io.swagger.v3.oas.models.media.Schema&lt;?&gt; schema, ModelConverterContext context) {&nbsp; &nbsp; &nbsp; &nbsp; schema.getExtensions().remove("exampleSetFlag");&nbsp; &nbsp; &nbsp; &nbsp; return schema;&nbsp; &nbsp; }}Register this custom model converter with your Swagger configuration.c. Exclude exampleSetFlag GloballyIn your Swagger setup, exclude the exampleSetFlag globally using configuration properties. For example:javaSwaggerConfiguration config = new SwaggerConfiguration();config.setModelConverters(new CustomModelConverter());2. Extra Endpoints in Swagger UIIf Swagger UI displays unintended endpoints, such as GET api/{job-id} or DELETE api/{job-id}, these may originate from:Unintentionally included resource classes.Default resources added by Swagger configuration.a. Check Swagger Resource ScanningReview your Application class or Swagger resource scanning setup. Limit the scanned resources to only your intended API endpoints:java@ApplicationPath("/api")public class RestApplication extends Application {&nbsp; &nbsp; @Override&nbsp; &nbsp; public Set&lt;Class&lt;?&gt;&gt; getClasses() {&nbsp; &nbsp; &nbsp; &nbsp; Set&lt;Class&lt;?&gt;&gt; resources = new HashSet&lt;&gt;();&nbsp; &nbsp; &nbsp; &nbsp; resources.add(MyApiResource.class); // Add your API resource classes explicitly&nbsp; &nbsp; &nbsp; &nbsp; return resources;&nbsp; &nbsp; }}b. Exclude Undesired EndpointsIf the unwanted endpoints are generated automatically by RESTEasy or Swagger, you can explicitly filter them out using Swagger configuration or annotations.3. info Section Missing in OpenAPI.jsonWhen using Swagger version 2.0.6, the info section is missing. This section is essential in OpenAPI and can be explicitly defined in your Swagger configuration.Define the info Section in Swagger ConfigAdd an OpenAPI bean to define the info section explicitly:java@OpenAPIDefinition(&nbsp; &nbsp; info = @Info(&nbsp; &nbsp; &nbsp; &nbsp; title = "My API",&nbsp; &nbsp; &nbsp; &nbsp; version = "1.0.0",&nbsp; &nbsp; &nbsp; &nbsp; description = "API for my RESTEasy project"&nbsp; &nbsp; ))public class SwaggerConfig {&nbsp; &nbsp; // Swagger configuration goes here}Ensure this configuration is picked up by your Swagger setup.4. Upgrade to Latest VersionIf you decide to use the latest version of swagger-jaxrs2 (2.1.12 or newer), ensure the following:Use a compatible version of swagger-ui to visualize the API.Test the openapi.json in the Swagger Editor for compliance.Validate all annotations and configurations to ensure they align with the OpenAPI 3.0 specification.5. Testing the SolutionAfter applying the changes:Regenerate the openapi.json.Validate the openapi.json in the Swagger Editor.Verify the Swagger UI only displays the desired endpoints and resolves errors.&nbsp;Best Regardsbella964

techtez · Answer

Hi Bella,Thanks for your response.When I use the swagger-jaxrs2 and swagger-core versions 2.2.26, it is resolved the additionalProperty: exampleSetFlag Error. Also using the latest&nbsp;swagger-ui.Regarding the Extra Endpoints in Swagger UI, how to disable the generating of Default resources ?@ApplicationPath("/serviceAPI")@OpenAPIDefinition(info= info(title = "REST API",&nbsp; version="Release 1.0",&nbsp; description="REST API description",&nbsp; servers= { @Server(url="/restInquiry")})public class RestApplication extends Application {&nbsp;@Override&nbsp;public Set&gt;Class&lt;?&gt;&gt; getClasses() {&nbsp; &nbsp;Set&lt;class&lt;?&gt;&gt; classes = new HashSet&lt;&gt;();&nbsp; &nbsp;classes.add (ApiController.class);&nbsp; &nbsp;classes.add (InquiryController.class);&nbsp; &nbsp;classes.add (OpenApiResource.class);&nbsp; &nbsp;return classes;&nbsp;}}How do we disable the displaying of extra endpoints?Thanks

Forum Discussion

exampleSetFlag additional property

Recent Discussions

How to customize the swagger-editor to include other definitions besides the PetStore

Jersey 3.x + Grizzly Web Service Swagger Advice

Weird css issue

Related Content

schema via oneOf with additional common properties

Cannot see additional properties in Ojbect Spy using HTML

Additional properties not allowed: oneOf