import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
+import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.CONTENT_KEY;
+import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.REF_KEY;
+import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.REQUEST_BODY_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.SCHEMA_KEY;
+import static org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder.getAppropriateModelPrefix;
import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Sets;
+import java.util.ArrayList;
+import java.util.HashSet;
import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
import org.junit.Test;
+import org.opendaylight.netconf.sal.rest.doc.swagger.OpenApiObject;
import org.opendaylight.netconf.sal.rest.doc.swagger.SwaggerObject;
-import org.opendaylight.yangtools.yang.common.Revision;
public final class ApiDocGeneratorRFC8040Test extends AbstractApiDocTest {
private static final String NAME = "toaster2";
+ private static final String MY_YANG = "my-yang";
+ private static final String MY_YANG_REVISION = "2022-10-06";
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 PATH_PARAMS_TEST_MODULE = "path-params-test";
+ private static final String MANDATORY_TEST = "mandatory-test";
+ private static final String CONFIG_ROOT_CONTAINER = "mandatory-test_config_root-container";
+ private static final String ROOT_CONTAINER = "mandatory-test_root-container";
+ private static final String CONFIG_MANDATORY_CONTAINER = "mandatory-test_root-container_config_mandatory-container";
+ private static final String MANDATORY_CONTAINER = "mandatory-test_root-container_mandatory-container";
+ private static final String CONFIG_MANDATORY_LIST = "mandatory-test_root-container_config_mandatory-list";
+ private static final String CONFIG_MANDATORY_LIST_POST = "mandatory-test_root-container_config_mandatory-list_post";
+ private static final String MANDATORY_LIST = "mandatory-test_root-container_mandatory-list";
+ private static final String MANDATORY_TEST_MODULE = "mandatory-test_config_module";
+ private static final String CHOICE_TEST_MODULE = "choice-test";
+ private static final String PROPERTIES = "properties";
+ private static final String CONTAINER = "container";
+ private static final String LIST = "list";
private final ApiDocGeneratorRFC8040 generator = new ApiDocGeneratorRFC8040(SCHEMA_SERVICE);
*/
@Test
public void testPaths() {
- final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow();
- final SwaggerObject doc = generator.getSwaggerDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT,
+ final SwaggerObject doc = (SwaggerObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
ApiDocServiceImpl.OAversion.V2_0);
assertEquals(List.of("/rests/data",
"/rests/data/toaster2:lst/cont1/lst11",
"/rests/data/toaster2:lst/lst1={key1},{key2}");
- final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow();
- final SwaggerObject doc = generator.getSwaggerDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT,
+ final SwaggerObject doc = (SwaggerObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
ApiDocServiceImpl.OAversion.V2_0);
for (final String path : configPaths) {
*/
@Test
public void testDefinitions() {
- final var module = CONTEXT.findModule(NAME, Revision.of(REVISION_DATE)).orElseThrow();
- final SwaggerObject doc = generator.getSwaggerDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT,
+ final SwaggerObject doc = (SwaggerObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
ApiDocServiceImpl.OAversion.V2_0);
final ObjectNode definitions = doc.getDefinitions();
final JsonNode configLstTop = definitions.get("toaster2_config_lst_TOP");
assertNotNull(configLstTop);
- DocGenTestHelper.containsReferences(configLstTop, "lst", "#/definitions/toaster2_config_lst");
+ DocGenTestHelper.containsReferences(configLstTop, "toaster2:lst", "#/definitions/toaster2_config_lst");
final JsonNode configLst = definitions.get("toaster2_config_lst");
assertNotNull(configLst);
final JsonNode configLst1Top = definitions.get("toaster2_lst_config_lst1_TOP");
assertNotNull(configLst1Top);
- DocGenTestHelper.containsReferences(configLst1Top, "lst1", "#/definitions/toaster2_lst_config_lst1");
+ DocGenTestHelper.containsReferences(configLst1Top, "toaster2:lst1", "#/definitions/toaster2_lst_config_lst1");
final JsonNode configLst1 = definitions.get("toaster2_lst_config_lst1");
assertNotNull(configLst1);
final JsonNode configCont1Top = definitions.get("toaster2_lst_config_cont1_TOP");
assertNotNull(configCont1Top);
- DocGenTestHelper.containsReferences(configCont1Top, "cont1", "#/definitions/toaster2_lst_config_cont1");
+ DocGenTestHelper.containsReferences(configCont1Top, "toaster2:cont1",
+ "#/definitions/toaster2_lst_config_cont1");
final JsonNode configCont1 = definitions.get("toaster2_lst_config_cont1");
assertNotNull(configCont1);
final JsonNode configCont11Top = definitions.get("toaster2_lst_cont1_config_cont11_TOP");
assertNotNull(configCont11Top);
- DocGenTestHelper.containsReferences(configCont11Top,
- "cont11", "#/definitions/toaster2_lst_cont1_config_cont11");
+ DocGenTestHelper.containsReferences(configCont11Top, "toaster2:cont11",
+ "#/definitions/toaster2_lst_cont1_config_cont11");
final JsonNode configCont11 = definitions.get("toaster2_lst_cont1_config_cont11");
assertNotNull(configCont11);
final JsonNode configLst11Top = definitions.get("toaster2_lst_cont1_config_lst11_TOP");
assertNotNull(configLst11Top);
- DocGenTestHelper.containsReferences(configLst11Top, "lst11", "#/definitions/toaster2_lst_cont1_config_lst11");
+ DocGenTestHelper.containsReferences(configLst11Top, "toaster2:lst11",
+ "#/definitions/toaster2_lst_cont1_config_lst11");
final JsonNode configLst11 = definitions.get("toaster2_lst_cont1_config_lst11");
assertNotNull(configLst11);
*/
@Test
public void testRPC() {
- final var module = CONTEXT.findModule(NAME_2, Revision.of(REVISION_DATE_2)).orElseThrow();
- final SwaggerObject doc = generator.getSwaggerDocSpec(module, "http", "localhost:8181", "/", "", CONTEXT,
+ final SwaggerObject doc = (SwaggerObject) generator.getApiDeclaration(NAME_2, REVISION_DATE_2, URI_INFO,
ApiDocServiceImpl.OAversion.V2_0);
assertNotNull(doc);
final ObjectNode definitions = doc.getDefinitions();
final JsonNode inputTop = definitions.get("toaster_make-toast_input_TOP");
assertNotNull(inputTop);
- final String testString = "{\"input\":{\"$ref\":\"#/definitions/toaster_make-toast_input\"}}";
+ final String testString = "{\"toaster:input\":{\"$ref\":\"#/definitions/toaster_make-toast_input\"}}";
assertEquals(testString, inputTop.get("properties").toString());
final JsonNode input = definitions.get("toaster_make-toast_input");
final JsonNode properties = input.get("properties");
assertTrue(properties.has("toasterDoneness"));
assertTrue(properties.has("toasterToastType"));
}
+
+ @Test
+ public void testMandatory() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(MANDATORY_TEST, null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(doc);
+ final var definitions = doc.getComponents().getSchemas();
+ final var containersWithRequired = new ArrayList<String>();
+
+ final var reqRootContainerElements = Set.of("mandatory-root-leaf", "mandatory-container",
+ "mandatory-first-choice", "mandatory-list");
+ verifyRequiredField(definitions.get(CONFIG_ROOT_CONTAINER), reqRootContainerElements);
+ containersWithRequired.add(CONFIG_ROOT_CONTAINER);
+ verifyRequiredField(definitions.get(ROOT_CONTAINER), reqRootContainerElements);
+ containersWithRequired.add(ROOT_CONTAINER);
+
+ final var reqMandatoryContainerElements = Set.of("mandatory-leaf", "leaf-list-with-min-elements");
+ verifyRequiredField(definitions.get(CONFIG_MANDATORY_CONTAINER), reqMandatoryContainerElements);
+ containersWithRequired.add(CONFIG_MANDATORY_CONTAINER);
+ verifyRequiredField(definitions.get(MANDATORY_CONTAINER), reqMandatoryContainerElements);
+ containersWithRequired.add(MANDATORY_CONTAINER);
+
+ final var reqMandatoryListElements = Set.of("mandatory-list-field");
+ verifyRequiredField(definitions.get(CONFIG_MANDATORY_LIST), reqMandatoryListElements);
+ containersWithRequired.add(CONFIG_MANDATORY_LIST);
+ verifyRequiredField(definitions.get(MANDATORY_LIST), reqMandatoryListElements);
+ containersWithRequired.add(MANDATORY_LIST);
+
+ final var testModuleMandatoryArray = Set.of("root-container", "root-mandatory-list");
+ verifyRequiredField(definitions.get(MANDATORY_TEST_MODULE), testModuleMandatoryArray);
+ containersWithRequired.add(MANDATORY_TEST_MODULE);
+
+ verifyThatPropertyDoesNotHaveRequired(containersWithRequired, definitions);
+ }
+
+ /**
+ * Test that request parameters are correctly numbered.
+ *
+ * <p>
+ * It means we should have name and name1, etc. when we have the same parameter in path multiple times.
+ */
+ @Test
+ public void testParametersNumbering() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(PATH_PARAMS_TEST_MODULE, null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+
+ var pathToList1 = "/rests/data/path-params-test:cont/list1={name}";
+ assertTrue(doc.getPaths().has(pathToList1));
+ assertEquals(List.of("name"), getPathGetParameters(doc.getPaths(), pathToList1));
+
+ var pathToList2 = "/rests/data/path-params-test:cont/list1={name}/list2={name1}";
+ assertTrue(doc.getPaths().has(pathToList2));
+ assertEquals(List.of("name", "name1"), getPathGetParameters(doc.getPaths(), pathToList2));
+
+ var pathToList3 = "/rests/data/path-params-test:cont/list3={name}";
+ assertTrue(doc.getPaths().has(pathToList3));
+ assertEquals(List.of("name"), getPathGetParameters(doc.getPaths(), pathToList3));
+
+ var pathToList4 = "/rests/data/path-params-test:cont/list1={name}/list4={name1}";
+ assertTrue(doc.getPaths().has(pathToList4));
+ assertEquals(List.of("name", "name1"), getPathGetParameters(doc.getPaths(), pathToList4));
+
+ var pathToList5 = "/rests/data/path-params-test:cont/list1={name}/cont2";
+ assertTrue(doc.getPaths().has(pathToList4));
+ assertEquals(List.of("name"), getPathGetParameters(doc.getPaths(), pathToList5));
+ }
+
+ private static void verifyThatPropertyDoesNotHaveRequired(final List<String> expected,
+ final ObjectNode definitions) {
+ final var fields = definitions.fields();
+ while (fields.hasNext()) {
+ final var next = fields.next();
+ final var nodeName = next.getKey();
+ final var jsonNode = next.getValue();
+ if (expected.contains(nodeName)) {
+ continue;
+ }
+ assertNull("Json node " + nodeName + " should not have 'required' field in body",
+ jsonNode.get("required"));
+ }
+ }
+
+ private static void verifyRequiredField(final JsonNode rootContainer, final Set<String> expected) {
+ assertNotNull(rootContainer);
+ final var required = rootContainer.get("required");
+ assertNotNull(required);
+ assertTrue(required.isArray());
+ final var actualContainerArray = StreamSupport.stream(required.spliterator(), false)
+ .map(JsonNode::textValue)
+ .collect(Collectors.toSet());
+ assertEquals(expected, actualContainerArray);
+ }
+
+ /**
+ * Test that request parameters are correctly typed.
+ */
+ @Test
+ public void testParametersTypes() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration("typed-params", "2023-10-24", URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ final var pathToContainer = "/rests/data/typed-params:typed/";
+ final var integerTypes = List.of("uint64", "uint32", "uint16", "uint8", "int64", "int32", "int16", "int8");
+ for (final var type: integerTypes) {
+ final var typeKey = type + "-key";
+ final var path = pathToContainer + type + "={" + typeKey + "}";
+ assertTrue(doc.getPaths().has(path));
+ assertEquals("integer", doc.getPaths().get(path).get("get").get("parameters").get(0).get("schema")
+ .get("type").textValue());
+ }
+ }
+
+ /**
+ * Test that request for actions is correct and has parameters.
+ */
+ @Test
+ public void testActionPathsParams() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration("action-types", null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+
+ final var pathWithParameters = "/rests/operations/action-types:list={name}/list-action";
+ assertTrue(doc.getPaths().has(pathWithParameters));
+ assertEquals(List.of("name"), getPathPostParameters(doc.getPaths(), pathWithParameters));
+
+ final var pathWithoutParameters = "/rests/operations/action-types:multi-container/inner-container/action";
+ assertTrue(doc.getPaths().has(pathWithoutParameters));
+ assertEquals(List.of(), getPathPostParameters(doc.getPaths(), pathWithoutParameters));
+ }
+
+ @Test
+ public void testChoice() {
+ final var doc = (SwaggerObject) generator.getApiDeclaration(CHOICE_TEST_MODULE, null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V2_0);
+ assertNotNull(doc);
+
+ final var definitions = doc.getDefinitions();
+ JsonNode firstContainer = definitions.get("choice-test_first-container");
+ assertEquals("default-value",
+ firstContainer.get(PROPERTIES).get("leaf-default").get("default").asText());
+ assertFalse(firstContainer.get(PROPERTIES).has("leaf-non-default"));
+
+ JsonNode secondContainer = definitions.get("choice-test_second-container");
+ assertTrue(secondContainer.get(PROPERTIES).has("leaf-first-case"));
+ assertFalse(secondContainer.get(PROPERTIES).has("leaf-second-case"));
+ }
+
+ @Test
+ public void testSimpleOpenApiObjects() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(MY_YANG, MY_YANG_REVISION, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertEquals(List.of("/rests/data", "/rests/data/my-yang:data"),
+ ImmutableList.copyOf(doc.getPaths().fieldNames()));
+
+ final var JsonNodeMyYangData = doc.getPaths().get("/rests/data/my-yang:data");
+ verifyRequestRef(JsonNodeMyYangData.path("post"),
+ "#/components/schemas/my-yang_config_data",
+ "#/components/schemas/my-yang_config_data");
+ verifyRequestRef(JsonNodeMyYangData.path("put"), "#/components/schemas/my-yang_config_data_TOP",
+ "#/components/schemas/my-yang_config_data");
+ verifyRequestRef(JsonNodeMyYangData.path("get"), "#/components/schemas/my-yang_data_TOP",
+ "#/components/schemas/my-yang_data");
+
+ // Test `components/schemas` objects
+ final var definitions = doc.getComponents().getSchemas();
+ assertEquals(5, definitions.size());
+ assertTrue(definitions.has("my-yang_config_data"));
+ assertTrue(definitions.has("my-yang_config_data_TOP"));
+ assertTrue(definitions.has("my-yang_data"));
+ assertTrue(definitions.has("my-yang_data_TOP"));
+ assertTrue(definitions.has("my-yang_config_module"));
+ }
+
+ @Test
+ public void testToaster2OpenApiObjects() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ final var jsonNodeToaster = doc.getPaths().get("/rests/data/toaster2:toaster");
+ verifyPostRequestRef(jsonNodeToaster.path("post"),
+ "#/components/schemas/toaster2_toaster_config_toasterSlot",
+ "#/components/schemas/toaster2_toaster_config_toasterSlot", LIST);
+ verifyRequestRef(jsonNodeToaster.path("put"), "#/components/schemas/toaster2_config_toaster_TOP",
+ "#/components/schemas/toaster2_config_toaster");
+ verifyRequestRef(jsonNodeToaster.path("get"), "#/components/schemas/toaster2_toaster_TOP",
+ "#/components/schemas/toaster2_toaster");
+
+ final var jsonNodeToasterSlot = doc.getPaths().get("/rests/data/toaster2:toaster/toasterSlot={slotId}");
+ verifyPostRequestRef(jsonNodeToasterSlot.path("post"),
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo",
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo", CONTAINER);
+ verifyRequestRef(jsonNodeToasterSlot.path("put"),
+ "#/components/schemas/toaster2_toaster_config_toasterSlot_TOP",
+ "#/components/schemas/toaster2_toaster_config_toasterSlot");
+ verifyRequestRef(jsonNodeToasterSlot.path("get"), "#/components/schemas/toaster2_toaster_toasterSlot_TOP",
+ "#/components/schemas/toaster2_toaster_toasterSlot");
+
+ final var jsonNodeSlotInfo = doc.getPaths().get(
+ "/rests/data/toaster2:toaster/toasterSlot={slotId}/toaster-augmented:slotInfo");
+ verifyRequestRef(jsonNodeSlotInfo.path("post"),
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo",
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo");
+ verifyRequestRef(jsonNodeSlotInfo.path("put"),
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo_TOP",
+ "#/components/schemas/toaster2_toaster_toasterSlot_config_slotInfo");
+ verifyRequestRef(jsonNodeSlotInfo.path("get"), "#/components/schemas/toaster2_toaster_toasterSlot_slotInfo_TOP",
+ "#/components/schemas/toaster2_toaster_toasterSlot_slotInfo");
+
+ final var jsonNodeLst = doc.getPaths().get("/rests/data/toaster2:lst");
+ verifyPostRequestRef(jsonNodeLst.path("post"), "#/components/schemas/toaster2_lst_config_cont1",
+ "#/components/schemas/toaster2_lst_config_cont1", CONTAINER);
+ verifyRequestRef(jsonNodeLst.path("put"), "#/components/schemas/toaster2_config_lst_TOP",
+ "#/components/schemas/toaster2_config_lst");
+ verifyRequestRef(jsonNodeLst.path("get"), "#/components/schemas/toaster2_lst_TOP",
+ "#/components/schemas/toaster2_lst");
+
+ final var jsonNodeLst1 = doc.getPaths().get("/rests/data/toaster2:lst/lst1={key1},{key2}");
+ verifyRequestRef(jsonNodeLst1.path("post"), "#/components/schemas/toaster2_lst_config_lst1",
+ "#/components/schemas/toaster2_lst_config_lst1");
+ verifyRequestRef(jsonNodeLst1.path("put"), "#/components/schemas/toaster2_lst_config_lst1_TOP",
+ "#/components/schemas/toaster2_lst_config_lst1");
+ verifyRequestRef(jsonNodeLst1.path("get"), "#/components/schemas/toaster2_lst_lst1_TOP",
+ "#/components/schemas/toaster2_lst_lst1");
+
+ final var jsonNodeMakeToast = doc.getPaths().get("/rests/operations/toaster2:make-toast");
+ assertTrue(jsonNodeMakeToast.path("get").isMissingNode());
+ verifyRequestRef(jsonNodeMakeToast.path("post"), "#/components/schemas/toaster2_make-toast_input_TOP",
+ "#/components/schemas/toaster2_make-toast_input");
+
+ final var jsonNodeCancelToast = doc.getPaths().get("/rests/operations/toaster2:cancel-toast");
+ assertTrue(jsonNodeCancelToast.path("get").isMissingNode());
+ // Test RPC with empty input
+ final var postContent = jsonNodeCancelToast.path("post").get("requestBody").get("content");
+ final var jsonSchema = postContent.get("application/json").get("schema");
+ assertNull(jsonSchema.get("$ref"));
+ assertEquals(2, jsonSchema.size());
+ final var xmlSchema = postContent.get("application/xml").get("schema");
+ assertNull(xmlSchema.get("$ref"));
+ assertEquals(2, xmlSchema.size());
+ // Test `components/schemas` objects
+ final var definitions = doc.getComponents().getSchemas();
+ assertEquals(44, definitions.size());
+ }
+
+ /**
+ * Test that reference to schema in each path is valid (all referenced schemas exist).
+ */
+ @Test
+ public void testRootPostSchemaReference() {
+ final var document = (OpenApiObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(document);
+ final var expectedSchema = "toaster2_config_module";
+ // verify schema reference itself
+ verifyRequestRef(document.getPaths().path("/rests/data").path("post"),
+ getAppropriateModelPrefix(ApiDocServiceImpl.OAversion.V3_0) + expectedSchema,
+ getAppropriateModelPrefix(ApiDocServiceImpl.OAversion.V3_0) + expectedSchema);
+ // verify existence of the schemas being referenced
+ assertTrue("The expected referenced schema (" + expectedSchema + ") is not created",
+ document.getComponents().getSchemas().has(expectedSchema));
+ }
+
+ /**
+ * Test that reference to schema in each path is valid (all referenced schemas exist).
+ */
+ @Test
+ public void testSchemasExistenceSingleModule() {
+ final var document = (OpenApiObject) generator.getApiDeclaration(NAME, REVISION_DATE, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(document);
+ final var referencedSchemas = new HashSet<String>();
+ for (final var elements = document.getPaths().elements(); elements.hasNext(); ) {
+ final var path = elements.next();
+ referencedSchemas.addAll(extractSchemaRefFromPath(path, ApiDocServiceImpl.OAversion.V3_0));
+ }
+ final var schemaNamesIterator = document.getComponents().getSchemas().fieldNames();
+ final var schemaNames = Sets.newHashSet(schemaNamesIterator);
+ for (final var ref : referencedSchemas) {
+ assertTrue("Referenced schema " + ref + " does not exist", schemaNames.contains(ref));
+ }
+ }
+
+ /**
+ * Test that checks if namespace for rpc is present.
+ */
+ @Test
+ public void testRpcNamespace() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(NAME_2, REVISION_DATE, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(doc);
+ final var path = doc.getPaths().get("/rests/operations/toaster:cancel-toast");
+ assertNotNull(path);
+ final var post = path.get("post");
+ assertNotNull(post);
+ final var requestBody = post.get("requestBody");
+ assertNotNull(requestBody);
+ final var content = requestBody.get("content");
+ assertNotNull(content);
+ final var application = content.get("application/xml");
+ assertNotNull(application);
+ final var schema = application.get("schema");
+ assertNotNull(schema);
+ final var xml = schema.get("xml");
+ assertNotNull(xml);
+ final var namespace = xml.get("namespace");
+ assertNotNull(namespace);
+ assertEquals("http://netconfcentral.org/ns/toaster", namespace.asText());
+ }
+
+ /**
+ * Test that checks if namespace for actions is present.
+ */
+ @Test
+ public void testActionsNamespace() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration("action-types", null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(doc);
+ final var path = doc.getPaths().get("/rests/operations/action-types:multi-container/inner-container/action");
+ assertNotNull(path);
+ final var post = path.get("post");
+ assertNotNull(post);
+ final var requestBody = post.get("requestBody");
+ assertNotNull(requestBody);
+ final var content = requestBody.get("content");
+ assertNotNull(content);
+ final var application = content.get("application/xml");
+ assertNotNull(application);
+ final var schema = application.get("schema");
+ assertNotNull(schema);
+ final var xml = schema.get("xml");
+ assertNotNull(xml);
+ final var namespace = xml.get("namespace");
+ assertNotNull(namespace);
+ assertEquals("urn:ietf:params:xml:ns:yang:test:action:types", namespace.asText());
+ }
+
+ /**
+ * Test that number of elements in payload is correct.
+ */
+ @SuppressWarnings("unchecked")
+ @Test
+ public void testLeafListWithMinElementsPayload() {
+ final var doc = (OpenApiObject) generator.getApiDeclaration(MANDATORY_TEST, null, URI_INFO,
+ ApiDocServiceImpl.OAversion.V3_0);
+ assertNotNull(doc);
+ final var paths = doc.getPaths();
+ final var path = paths.path("/rests/data/mandatory-test:root-container/mandatory-container");
+ final var requestBody = path.path("post").path("requestBody").path("content");
+ final var jsonRef = requestBody.path("application/json").path("schema").path("$ref");
+ final var xmlRef = requestBody.path("application/xml").path("schema").path("$ref");
+ final var schema = doc.getComponents().getSchemas().path("mandatory-test_root-container_mandatory-container");
+ final var minItems = schema.path("properties").path("leaf-list-with-min-elements").path("minItems");
+ final var listOfExamples = ((ArrayNode) schema.path("properties").path("leaf-list-with-min-elements")
+ .path("example"));
+ final var expectedListOfExamples = JsonNodeFactory.instance.arrayNode()
+ .add("Some leaf-list-with-min-elements")
+ .add("Some leaf-list-with-min-elements");
+ assertFalse(listOfExamples.isMissingNode());
+ assertEquals(xmlRef, jsonRef);
+ assertEquals(2, minItems.intValue());
+ assertEquals(expectedListOfExamples, listOfExamples);
+ }
+
+ /**
+ * Test JSON and XML references for request operation.
+ */
+ private static void verifyRequestRef(final JsonNode path, final String expectedJsonRef,
+ final String expectedXmlRef) {
+ final JsonNode postContent;
+ if (path.get("requestBody") != null) {
+ postContent = path.get("requestBody").get("content");
+ } else {
+ postContent = path.get("responses").get("200").get("content");
+ }
+ assertNotNull(postContent);
+ final var postJsonRef = postContent.get("application/json").get("schema").get("$ref");
+ assertNotNull(postJsonRef);
+ assertEquals(expectedJsonRef, postJsonRef.textValue());
+ final var postXmlRef = postContent.get("application/xml").get("schema").get("$ref");
+ assertNotNull(postXmlRef);
+ assertEquals(expectedXmlRef, postXmlRef.textValue());
+ }
+
+ private static void verifyPostRequestRef(final JsonNode path, final String expectedJsonRef,
+ final String expectedXmlRef, String nodeType) {
+ final JsonNode postContent;
+ if (path.get("requestBody") != null) {
+ postContent = path.get("requestBody").get("content");
+ } else {
+ postContent = path.get("responses").get("200").get("content");
+ }
+ assertNotNull(postContent);
+ final String postJsonRef;
+ if (nodeType.equals(CONTAINER)) {
+ postJsonRef = postContent.path("application/json").path("schema").path("properties").elements().next()
+ .path("$ref").textValue();
+ } else {
+ postJsonRef = postContent.path("application/json").path("schema").path("properties").elements().next()
+ .path("items").path("$ref").textValue();
+ }
+ assertEquals(expectedJsonRef, postJsonRef);
+ final var postXmlRef = postContent.get("application/xml").get("schema").get("$ref");
+ assertNotNull(postXmlRef);
+ assertEquals(expectedXmlRef, postXmlRef.textValue());
+ }
+
+ private static Set<String> extractSchemaRefFromPath(final JsonNode path,
+ final ApiDocServiceImpl.OAversion oaversion) {
+ if (path == null || path.isMissingNode()) {
+ return Set.of();
+ }
+ final var references = new HashSet<String>();
+ final var get = path.path("get");
+ if (!get.isMissingNode()) {
+ references.addAll(
+ schemaRefFromContent(get.path(RESPONSES_KEY).path("200").path(CONTENT_KEY), oaversion));
+ }
+ final var post = path.path("post");
+ if (!post.isMissingNode()) {
+ references.addAll(schemaRefFromContent(post.path(REQUEST_BODY_KEY).path(CONTENT_KEY), oaversion));
+ }
+ final var put = path.path("put");
+ if (!put.isMissingNode()) {
+ references.addAll(schemaRefFromContent(put.path(REQUEST_BODY_KEY).path(CONTENT_KEY), oaversion));
+ }
+ final var patch = path.path("patch");
+ if (!patch.isMissingNode()) {
+ references.addAll(schemaRefFromContent(patch.path(REQUEST_BODY_KEY).path(CONTENT_KEY), oaversion));
+ }
+ return references;
+ }
+
+ private static Set<String> schemaRefFromContent(final JsonNode content,
+ final ApiDocServiceImpl.OAversion oaversion) {
+ final HashSet<String> refs = new HashSet<>();
+ content.fieldNames().forEachRemaining(mediaType -> {
+ final JsonNode ref = content.path(mediaType).path(SCHEMA_KEY).path(REF_KEY);
+ if (ref != null && !ref.isMissingNode()) {
+ refs.add(ref.asText().replaceFirst(getAppropriateModelPrefix(oaversion), ""));
+ }
+ });
+ return refs;
+ }
}
Code Review / netconf.git / blobdiff