Merge pull request #539 from bci-oss/340-add-model-information-to-the-openapi-spec

Add Model information to the Openapi Spec

Author: Yauhenikapl

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/jsonschema/AspectModelJsonSchemaVisitor.java

@@ -231,6 +231,7 @@ public JsonNode visitBase( final ModelElement modelElement, final ObjectNode con
 
    public JsonNode visitAspectForOpenApi( final Aspect aspect ) {
       addDescription( rootNode, aspect, locale );
+      addXSammAspectModelUrn( rootNode, aspect );
       return visitHasProperties( aspect, rootNode );
    }
 
@@ -671,4 +672,8 @@ private ObjectNode addDescription( final ObjectNode node, final NamedElement des
 
       return node;
    }
+
+   private void addXSammAspectModelUrn( final ObjectNode node, final NamedElement describedElement ) {
+      describedElement.getAspectModelUrn().ifPresent( urn -> node.put( "x-samm-aspect-model-urn", urn.toString() ) );
+   }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/openapi/AspectModelOpenApiGenerator.java

@@ -27,6 +27,7 @@
 
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.AspectModelJsonSchemaGenerator;
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.AspectModelJsonSchemaVisitor;
+import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.metamodel.NamedElement;
 import org.eclipse.esmf.metamodel.Operation;
@@ -169,6 +170,7 @@ public JsonNode applyForJson( final Aspect aspect, final boolean useSemanticVers
 
          ( (ObjectNode) rootNode.get( "info" ) ).put( "title", aspect.getPreferredName( locale ) );
          ( (ObjectNode) rootNode.get( "info" ) ).put( "version", apiVersion );
+         ( (ObjectNode) rootNode.get( "info" ) ).put( "x-samm-aspect-model-urn", aspect.getAspectModelUrn().map( Object::toString ).orElse( "" ) );
 
          setServers( rootNode, baseUrl, apiVersion, READ_SERVER_PATH );
          final boolean includePaging = includePaging( aspect, pagingOption );

core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/openapi/OpenApiTest.java

@@ -95,6 +95,8 @@ public void testUseSemanticVersion( final KnownVersion metaModelVersion ) {
       final OpenAPI openApi = result.getOpenAPI();
 
       assertThat( openApi.getInfo().getVersion() ).isEqualTo( "v1.0.0" );
+      assertThat( json.get( "info" ).get( "x-samm-aspect-model-urn" ) ).isNotNull();
+      assertThat( json.get( "info" ).get( "x-samm-aspect-model-urn" ).asText() ).isEqualTo( aspect.getAspectModelUrn().map( Object::toString ).orElse( "" ) );
 
       openApi.getServers().forEach( server -> assertThat( server.getUrl() ).contains( "v1.0.0" ) );
    }
@@ -412,7 +414,7 @@ private void assertSpecificationIsValid( final JsonNode jsonNode, final String j
       validateUnsupportedKeywords( jsonNode );
 
       final SwaggerParseResult result = new OpenAPIParser().readContents( json, null, null );
-      assertThat( result.getMessages().size() ).isZero();
+      assertThat( result.getMessages() ).isEmpty();
 
       final OpenAPI openApi = result.getOpenAPI();
       validateOpenApiSpec( jsonNode, openApi, aspect );
@@ -436,6 +438,10 @@ private void validateOpenApiSpec( final JsonNode node, final OpenAPI openApi, fi
       final String expectedApiVersion = getExpectedApiVersion( aspect );
       assertThat( openApi.getInfo().getVersion() ).isEqualTo( expectedApiVersion );
 
+      final String xSammAspectModelUrn = "x-samm-aspect-model-urn";
+      assertThat( node.get( "info" ).get( xSammAspectModelUrn ) ).isNotNull();
+      assertThat( node.get( "info" ).get( xSammAspectModelUrn ).asText() ).isEqualTo( aspect.getAspectModelUrn().map( Object::toString ).orElse( "" ) );
+
       assertThat( openApi.getServers() ).hasSize( 1 );
       assertThat( openApi.getServers().get( 0 ).getUrl() ).isEqualTo( TEST_BASE_URL + "/api/" + expectedApiVersion );
 
@@ -450,6 +456,8 @@ private void validateOpenApiSpec( final JsonNode node, final OpenAPI openApi, fi
       assertThat( openApi.getComponents().getSchemas().keySet() ).contains( aspect.getName() );
       assertThat( openApi.getComponents().getResponses().keySet() ).contains( aspect.getName() );
       assertThat( openApi.getComponents().getRequestBodies().keySet() ).contains( aspect.getName() );
+      assertThat( openApi.getComponents().getSchemas().get( aspect.getName() ).getExtensions().get( xSammAspectModelUrn ) ).isNotNull();
+      assertThat( openApi.getComponents().getSchemas().get( aspect.getName() ).getExtensions().get( xSammAspectModelUrn ).toString() ).contains( aspect.getAspectModelUrn().map( Object::toString ).orElse( "" ));
 
       validateReferences( node );
    }