From 6b9d2cd4cea8044bfc83ce62ef93826a3430388a Mon Sep 17 00:00:00 2001 From: OleksandrZharov Date: Thu, 4 May 2023 19:26:21 +0200 Subject: [PATCH] Rename *ApiDoc* classess to *OpenApi* classes Rename all classes and methods in sal-rest-docgen which have *ApiDoc* in their name to *OpenApi* instead. JIRA: NETCONF-1012 Change-Id: I46779d465885d6e8411f8405d10fbf3505efbfde Signed-off-by: OleksandrZharov Signed-off-by: Ivan Hrasko --- ...ApiDocService.java => OpenApiService.java} | 2 +- .../doc/impl/BaseYangOpenApiGenerator.java | 10 ++++---- ...8040.java => OpenApiGeneratorRFC8040.java} | 6 ++--- ...rviceImpl.java => OpenApiServiceImpl.java} | 24 +++++++++---------- ...plication.java => OpenApiApplication.java} | 12 +++++----- .../sal/rest/doc/jaxrs/WebInitializer.java | 6 ++--- .../doc/mountpoints/MountPointOpenApi.java | 6 ++--- ...iDocTest.java => AbstractOpenApiTest.java} | 2 +- .../doc/impl/DefinitionGeneratorTest.java | 4 ++-- ....java => OpenApiGeneratorRFC8040Test.java} | 16 ++++++------- ...lTest.java => OpenApiServiceImplTest.java} | 14 +++++------ .../mountpoints/MountPointOpenApiTest.java | 4 ++-- 12 files changed, 53 insertions(+), 53 deletions(-) rename restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/{ApiDocService.java => OpenApiService.java} (98%) rename restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/{ApiDocGeneratorRFC8040.java => OpenApiGeneratorRFC8040.java} (75%) rename restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/{ApiDocServiceImpl.java => OpenApiServiceImpl.java} (83%) rename restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/{ApiDocApplication.java => OpenApiApplication.java} (61%) rename restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/{AbstractApiDocTest.java => AbstractOpenApiTest.java} (95%) rename restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/{ApiDocGeneratorRFC8040Test.java => OpenApiGeneratorRFC8040Test.java} (90%) rename restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/{ApiDocServiceImplTest.java => OpenApiServiceImplTest.java} (82%) diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/ApiDocService.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/OpenApiService.java similarity index 98% rename from restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/ApiDocService.java rename to restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/OpenApiService.java index 1e7a7b9838..adeaf6544c 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/ApiDocService.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/api/OpenApiService.java @@ -22,7 +22,7 @@ import javax.ws.rs.core.Response; * RESTCONF APIs. The output of this is used by embedded Swagger UI. */ @Path("/") -public interface ApiDocService { +public interface OpenApiService { @GET @Path("/single") diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangOpenApiGenerator.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangOpenApiGenerator.java index 45c08b6b67..657b78875c 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangOpenApiGenerator.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/BaseYangOpenApiGenerator.java @@ -133,7 +133,7 @@ public abstract class BaseYangOpenApiGenerator { LOG.debug("Working on [{},{}]...", module.getName(), revisionString); - getOpenApiDocSpec(module, context, deviceName, schemaContext, definitionNames, doc, false); + getOpenApiSpec(module, context, deviceName, schemaContext, definitionNames, doc, false); } } @@ -191,7 +191,7 @@ public abstract class BaseYangOpenApiGenerator { final String schema = createSchemaFromUriInfo(uriInfo); final String host = createHostFromUriInfo(uriInfo); - return getOpenApiDocSpec(module, schema, host, BASE_PATH, context, schemaContext); + return getOpenApiSpec(module, schema, host, BASE_PATH, context, schemaContext); } public String createHostFromUriInfo(final UriInfo uriInfo) { @@ -207,14 +207,14 @@ public abstract class BaseYangOpenApiGenerator { return uriInfo.getBaseUri().getScheme(); } - public OpenApiObject getOpenApiDocSpec(final Module module, final String schema, final String host, + public OpenApiObject getOpenApiSpec(final Module module, final String schema, final String host, final String basePath, final String context, final EffectiveModelContext schemaContext) { final OpenApiObject doc = createOpenApiObject(schema, host, basePath, module.getName()); final DefinitionNames definitionNames = new DefinitionNames(); - return getOpenApiDocSpec(module, context, Optional.empty(), schemaContext, definitionNames, doc, true); + return getOpenApiSpec(module, context, Optional.empty(), schemaContext, definitionNames, doc, true); } - public OpenApiObject getOpenApiDocSpec(final Module module, final String context, final Optional deviceName, + public OpenApiObject getOpenApiSpec(final Module module, final String context, final Optional deviceName, final EffectiveModelContext schemaContext, final DefinitionNames definitionNames, final OpenApiObject doc, final boolean isForSingleModule) { try { diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040.java similarity index 75% rename from restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040.java rename to restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040.java index 128233d380..aa7d658b3e 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040.java @@ -16,12 +16,12 @@ import org.opendaylight.mdsal.dom.api.DOMSchemaService; * * @author Thomas Pantelis */ -public class ApiDocGeneratorRFC8040 extends BaseYangOpenApiGeneratorRFC8040 { - public ApiDocGeneratorRFC8040(final DOMSchemaService schemaService) { +public class OpenApiGeneratorRFC8040 extends BaseYangOpenApiGeneratorRFC8040 { + public OpenApiGeneratorRFC8040(final DOMSchemaService schemaService) { super(Optional.of(schemaService)); } - public ApiDocGeneratorRFC8040(final DOMSchemaService schemaService, final String basePath) { + public OpenApiGeneratorRFC8040(final DOMSchemaService schemaService, final String basePath) { super(Optional.of(schemaService), basePath); } } diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImpl.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java similarity index 83% rename from restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImpl.java rename to restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java index 3149551c50..67af263cc0 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImpl.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImpl.java @@ -19,7 +19,7 @@ import javax.ws.rs.core.Response; import javax.ws.rs.core.UriInfo; import org.opendaylight.mdsal.dom.api.DOMMountPointService; import org.opendaylight.mdsal.dom.api.DOMSchemaService; -import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService; +import org.opendaylight.netconf.sal.rest.doc.api.OpenApiService; import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointOpenApi; import org.opendaylight.netconf.sal.rest.doc.openapi.MountPointInstance; import org.opendaylight.netconf.sal.rest.doc.openapi.OpenApiObject; @@ -43,7 +43,7 @@ import org.osgi.service.component.annotations.Reference; */ @Component @Singleton -public final class ApiDocServiceImpl implements ApiDocService { +public final class OpenApiServiceImpl implements OpenApiService { // FIXME: make this configurable public static final int DEFAULT_PAGESIZE = 20; @@ -51,34 +51,34 @@ public final class ApiDocServiceImpl implements ApiDocService { private static final String PAGE_NUM = "pageNum"; private final MountPointOpenApi mountPointOpenApiRFC8040; - private final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040; + private final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040; @Inject @Activate - public ApiDocServiceImpl(final @Reference DOMSchemaService schemaService, + public OpenApiServiceImpl(final @Reference DOMSchemaService schemaService, final @Reference DOMMountPointService mountPointService) { this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService), - new ApiDocGeneratorRFC8040(schemaService)); + new OpenApiGeneratorRFC8040(schemaService)); } - public ApiDocServiceImpl(final DOMSchemaService schemaService, + public OpenApiServiceImpl(final DOMSchemaService schemaService, final DOMMountPointService mountPointService, final String basePath) { this(new MountPointOpenApiGeneratorRFC8040(schemaService, mountPointService, basePath), - new ApiDocGeneratorRFC8040(schemaService, basePath)); + new OpenApiGeneratorRFC8040(schemaService, basePath)); } @VisibleForTesting - ApiDocServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040, - final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040) { + OpenApiServiceImpl(final MountPointOpenApiGeneratorRFC8040 mountPointOpenApiGeneratorRFC8040, + final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040) { mountPointOpenApiRFC8040 = requireNonNull(mountPointOpenApiGeneratorRFC8040).getMountPointOpenApi(); - this.apiDocGeneratorRFC8040 = requireNonNull(apiDocGeneratorRFC8040); + this.openApiGeneratorRFC8040 = requireNonNull(openApiGeneratorRFC8040); } @Override public synchronized Response getAllModulesDoc(final UriInfo uriInfo) { final DefinitionNames definitionNames = new DefinitionNames(); - final OpenApiObject doc = apiDocGeneratorRFC8040.getAllModulesDoc(uriInfo, definitionNames); + final OpenApiObject doc = openApiGeneratorRFC8040.getAllModulesDoc(uriInfo, definitionNames); return Response.ok(doc).build(); } @@ -88,7 +88,7 @@ public final class ApiDocServiceImpl implements ApiDocService { @Override public synchronized Response getDocByModule(final String module, final String revision, final UriInfo uriInfo) { return Response.ok( - apiDocGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo)) + openApiGeneratorRFC8040.getApiDeclaration(module, revision, uriInfo)) .build(); } diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/ApiDocApplication.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/OpenApiApplication.java similarity index 61% rename from restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/ApiDocApplication.java rename to restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/OpenApiApplication.java index ce573abddd..80cf051b89 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/ApiDocApplication.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/OpenApiApplication.java @@ -12,18 +12,18 @@ import static java.util.Objects.requireNonNull; import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; import java.util.Set; import javax.ws.rs.core.Application; -import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService; +import org.opendaylight.netconf.sal.rest.doc.api.OpenApiService; // FIXME: hide this class -public final class ApiDocApplication extends Application { - private final ApiDocService apiDocService; +public final class OpenApiApplication extends Application { + private final OpenApiService openApiService; - public ApiDocApplication(final ApiDocService apiDocService) { - this.apiDocService = requireNonNull(apiDocService); + public OpenApiApplication(final OpenApiService openApiService) { + this.openApiService = requireNonNull(openApiService); } @Override public Set getSingletons() { - return Set.of(apiDocService, new JaxbContextResolver(), new JacksonJaxbJsonProvider()); + return Set.of(openApiService, new JaxbContextResolver(), new JacksonJaxbJsonProvider()); } } diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/WebInitializer.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/WebInitializer.java index f44e601208..e2680dce7b 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/WebInitializer.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/jaxrs/WebInitializer.java @@ -17,7 +17,7 @@ import org.opendaylight.aaa.web.WebContext; import org.opendaylight.aaa.web.WebContextSecurer; import org.opendaylight.aaa.web.WebServer; import org.opendaylight.aaa.web.servlet.ServletSupport; -import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService; +import org.opendaylight.netconf.sal.rest.doc.api.OpenApiService; import org.opendaylight.yangtools.concepts.Registration; import org.osgi.service.component.annotations.Activate; import org.osgi.service.component.annotations.Component; @@ -37,14 +37,14 @@ public final class WebInitializer implements AutoCloseable { @Inject @Activate public WebInitializer(@Reference final WebServer webServer, @Reference final WebContextSecurer webContextSecurer, - @Reference final ServletSupport servletSupport, @Reference final ApiDocService apiDocService) + @Reference final ServletSupport servletSupport, @Reference final OpenApiService openApiService) throws ServletException { final var webContextBuilder = WebContext.builder() .name("OpenAPI") .contextPath("/apidoc") .supportsSessions(true) .addServlet(ServletDetails.builder() - .servlet(servletSupport.createHttpServletBuilder(new ApiDocApplication(apiDocService)).build()) + .servlet(servletSupport.createHttpServletBuilder(new OpenApiApplication(openApiService)).build()) .addUrlPattern("/openapi3/apis/*") .build()) .addResource(ResourceDetails.builder().name("/explorer").build()); diff --git a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApi.java b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApi.java index 180821495e..da2569108f 100644 --- a/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApi.java +++ b/restconf/sal-rest-docgen/src/main/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApi.java @@ -9,8 +9,8 @@ package org.opendaylight.netconf.sal.rest.doc.mountpoints; import static com.google.common.base.Preconditions.checkState; import static java.util.Objects.requireNonNull; -import static org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.DEFAULT_PAGESIZE; import static org.opendaylight.netconf.sal.rest.doc.impl.BaseYangOpenApiGenerator.BASE_PATH; +import static org.opendaylight.netconf.sal.rest.doc.impl.OpenApiServiceImpl.DEFAULT_PAGESIZE; import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.DESCRIPTION_KEY; import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.RESPONSES_KEY; import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.SUMMARY_KEY; @@ -144,7 +144,7 @@ public class MountPointOpenApi implements DOMMountPointListener, AutoCloseable { } if (DATASTORES_LABEL.equals(module) && DATASTORES_REVISION.equals(revision)) { - return generateDataStoreApiDoc(uriInfo, urlPrefix, deviceName); + return generateDataStoreOpenApi(uriInfo, urlPrefix, deviceName); } final OpenApiObject openApiObject = openApiGenerator.getApiDeclaration(module, revision, uriInfo, context, urlPrefix); @@ -192,7 +192,7 @@ public class MountPointOpenApi implements DOMMountPointListener, AutoCloseable { .values().getElement().toString(); } - private OpenApiObject generateDataStoreApiDoc(final UriInfo info, final String context, final String deviceName) { + private OpenApiObject generateDataStoreOpenApi(final UriInfo info, final String context, final String deviceName) { final var openApiObject = openApiGenerator.createOpenApiObject(openApiGenerator.createSchemaFromUriInfo(info), openApiGenerator.createHostFromUriInfo(info), BASE_PATH, context); openApiObject.setPaths(getDataStoreApiPaths(context, deviceName)); diff --git a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractApiDocTest.java b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractOpenApiTest.java similarity index 95% rename from restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractApiDocTest.java rename to restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractOpenApiTest.java index 654fd68485..f522e70b0f 100644 --- a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractApiDocTest.java +++ b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/AbstractOpenApiTest.java @@ -15,7 +15,7 @@ import org.opendaylight.mdsal.dom.api.DOMSchemaService; import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils; -public abstract class AbstractApiDocTest { +public abstract class AbstractOpenApiTest { protected static EffectiveModelContext CONTEXT; protected static DOMSchemaService SCHEMA_SERVICE; diff --git a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/DefinitionGeneratorTest.java b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/DefinitionGeneratorTest.java index fee5d3be9c..736b19691a 100644 --- a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/DefinitionGeneratorTest.java +++ b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/DefinitionGeneratorTest.java @@ -12,10 +12,10 @@ import static org.junit.Assert.assertNotNull; import com.fasterxml.jackson.databind.node.ObjectNode; import java.io.IOException; import org.junit.Test; -import org.opendaylight.netconf.sal.rest.doc.AbstractApiDocTest; +import org.opendaylight.netconf.sal.rest.doc.AbstractOpenApiTest; import org.opendaylight.yangtools.yang.common.Revision; -public final class DefinitionGeneratorTest extends AbstractApiDocTest { +public final class DefinitionGeneratorTest extends AbstractOpenApiTest { @Test public void testConvertToJsonSchema() throws IOException { final var module = CONTEXT.findModule("opflex", Revision.of("2014-05-28")).orElseThrow(); diff --git a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040Test.java b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040Test.java similarity index 90% rename from restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040Test.java rename to restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040Test.java index d15d7e4ee6..8209b0e073 100644 --- a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocGeneratorRFC8040Test.java +++ b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiGeneratorRFC8040Test.java @@ -17,20 +17,20 @@ import com.fasterxml.jackson.databind.node.ObjectNode; import java.util.List; import java.util.Set; import org.junit.Test; -import org.opendaylight.netconf.sal.rest.doc.AbstractApiDocTest; +import org.opendaylight.netconf.sal.rest.doc.AbstractOpenApiTest; import org.opendaylight.netconf.sal.rest.doc.DocGenTestHelper; import org.opendaylight.netconf.sal.rest.doc.openapi.OpenApiObject; import org.opendaylight.netconf.sal.rest.doc.openapi.Path; import org.opendaylight.yangtools.yang.common.Revision; -public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { +public final class OpenApiGeneratorRFC8040Test extends AbstractOpenApiTest { private static final String NAME = "toaster2"; private static final String REVISION_DATE = "2009-11-20"; private static final String NAME_2 = "toaster"; private static final String REVISION_DATE_2 = "2009-11-20"; private static final String CHOICE_TEST_MODULE = "choice-test"; private static final String PROPERTIES = "properties"; - private final ApiDocGeneratorRFC8040 generator = new ApiDocGeneratorRFC8040(SCHEMA_SERVICE); + private final OpenApiGeneratorRFC8040 generator = new OpenApiGeneratorRFC8040(SCHEMA_SERVICE); /** * Test that paths are generated according to the model. @@ -38,7 +38,7 @@ public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { @Test public void testPaths() { final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow(); - final OpenApiObject doc = generator.getOpenApiDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT); + final OpenApiObject doc = generator.getOpenApiSpec(module, "http", "localhost:8181", "/", "", CONTEXT); assertEquals(Set.of("/rests/data", "/rests/data/toaster2:toaster", @@ -67,7 +67,7 @@ public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { "/rests/data/toaster2:lst/lst1={key1},{key2}"); final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow(); - final OpenApiObject doc = generator.getOpenApiDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT); + final OpenApiObject doc = generator.getOpenApiSpec(module, "http", "localhost:8181", "/", "", CONTEXT); for (final String path : configPaths) { final Path node = doc.getPaths().get(path); @@ -85,7 +85,7 @@ public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { @Test public void testSchemas() { final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow(); - final OpenApiObject doc = generator.getOpenApiDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT); + final OpenApiObject doc = generator.getOpenApiSpec(module, "http", "localhost:8181", "/", "", CONTEXT); final ObjectNode schemas = doc.getComponents().getSchemas(); assertNotNull(schemas); @@ -140,7 +140,7 @@ public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { @Test public void testRPC() { final var module = CONTEXT.findModule(NAME_2, Revision.of(REVISION_DATE_2)).orElseThrow(); - final OpenApiObject doc = generator.getOpenApiDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT); + final OpenApiObject doc = generator.getOpenApiSpec(module, "http", "localhost:8181", "/", "", CONTEXT); assertNotNull(doc); final ObjectNode schemas = doc.getComponents().getSchemas(); @@ -157,7 +157,7 @@ public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest { @Test public void testChoice() { final var module = CONTEXT.findModule(CHOICE_TEST_MODULE).orElseThrow(); - final var doc = generator.getOpenApiDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT); + final var doc = generator.getOpenApiSpec(module, "http", "localhost:8181", "/", "", CONTEXT); assertNotNull(doc); final var schemas = doc.getComponents().getSchemas(); diff --git a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImplTest.java b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImplTest.java similarity index 82% rename from restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImplTest.java rename to restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImplTest.java index e5a0994845..5ed39acb8e 100644 --- a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/ApiDocServiceImplTest.java +++ b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/impl/OpenApiServiceImplTest.java @@ -19,13 +19,13 @@ import org.junit.Test; import org.opendaylight.mdsal.dom.api.DOMMountPoint; import org.opendaylight.mdsal.dom.api.DOMMountPointService; import org.opendaylight.mdsal.dom.api.DOMSchemaService; -import org.opendaylight.netconf.sal.rest.doc.AbstractApiDocTest; +import org.opendaylight.netconf.sal.rest.doc.AbstractOpenApiTest; import org.opendaylight.netconf.sal.rest.doc.DocGenTestHelper; -import org.opendaylight.netconf.sal.rest.doc.api.ApiDocService; +import org.opendaylight.netconf.sal.rest.doc.api.OpenApiService; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -public final class ApiDocServiceImplTest extends AbstractApiDocTest { +public final class OpenApiServiceImplTest extends AbstractOpenApiTest { private static final String HTTP_URL = "http://localhost/path"; private static final YangInstanceIdentifier INSTANCE_ID = YangInstanceIdentifier.builder() .node(QName.create("", "nodes")) @@ -33,7 +33,7 @@ public final class ApiDocServiceImplTest extends AbstractApiDocTest { .nodeWithKey(QName.create("", "node"), QName.create("", "id"), "123").build(); private static final ObjectMapper MAPPER = new ObjectMapper(); - private ApiDocService apiDocService; + private OpenApiService openApiService; @Before public void before() { @@ -44,16 +44,16 @@ public final class ApiDocServiceImplTest extends AbstractApiDocTest { when(service.getMountPoint(INSTANCE_ID)).thenReturn(Optional.of(mountPoint)); final MountPointOpenApiGeneratorRFC8040 mountPointRFC8040 = new MountPointOpenApiGeneratorRFC8040(SCHEMA_SERVICE, service); - final ApiDocGeneratorRFC8040 apiDocGeneratorRFC8040 = new ApiDocGeneratorRFC8040(SCHEMA_SERVICE); + final OpenApiGeneratorRFC8040 openApiGeneratorRFC8040 = new OpenApiGeneratorRFC8040(SCHEMA_SERVICE); mountPointRFC8040.getMountPointOpenApi().onMountPointCreated(INSTANCE_ID); - apiDocService = new ApiDocServiceImpl(mountPointRFC8040, apiDocGeneratorRFC8040); + openApiService = new OpenApiServiceImpl(mountPointRFC8040, openApiGeneratorRFC8040); } @Test public void getListOfMounts() throws Exception { final UriInfo mockInfo = DocGenTestHelper.createMockUriInfo(HTTP_URL); // simulate the behavior of JacksonJaxbJsonProvider - final String result = MAPPER.writer().writeValueAsString(apiDocService.getListOfMounts(mockInfo).getEntity()); + final String result = MAPPER.writer().writeValueAsString(openApiService.getListOfMounts(mockInfo).getEntity()); assertEquals("[{\"instance\":\"/nodes/node=123/\",\"id\":1}]", result); } } diff --git a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApiTest.java b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApiTest.java index c3ee927658..92dbdec86a 100644 --- a/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApiTest.java +++ b/restconf/sal-rest-docgen/src/test/java/org/opendaylight/netconf/sal/rest/doc/mountpoints/MountPointOpenApiTest.java @@ -25,7 +25,7 @@ import org.junit.Test; import org.opendaylight.mdsal.dom.api.DOMMountPoint; import org.opendaylight.mdsal.dom.api.DOMMountPointService; import org.opendaylight.mdsal.dom.api.DOMSchemaService; -import org.opendaylight.netconf.sal.rest.doc.AbstractApiDocTest; +import org.opendaylight.netconf.sal.rest.doc.AbstractOpenApiTest; import org.opendaylight.netconf.sal.rest.doc.DocGenTestHelper; import org.opendaylight.netconf.sal.rest.doc.impl.MountPointOpenApiGeneratorRFC8040; import org.opendaylight.netconf.sal.rest.doc.openapi.OpenApiObject; @@ -33,7 +33,7 @@ import org.opendaylight.netconf.sal.rest.doc.openapi.Path; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -public final class MountPointOpenApiTest extends AbstractApiDocTest { +public final class MountPointOpenApiTest extends AbstractOpenApiTest { private static final String HTTP_URL = "http://localhost/path"; private static final YangInstanceIdentifier INSTANCE_ID = YangInstanceIdentifier.builder() .node(QName.create("", "nodes")) -- 2.36.6