Merge pull request #188 from Netflix/kavitha/update-docs

Update codegen docs.
Netflix · Aug 27, 2024 · b3d70e9 · b3d70e9
2 parents fd4189a + 22443e4
commit b3d70e9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 8 deletions.
diff --git a/.idea/tbe-PST.xml b/.idea/tbe-PST.xml
diff --git a/docs/generating-code-from-schema.md b/docs/generating-code-from-schema.md
@@ -101,6 +101,9 @@ dependencies {
 }
 ```
 
+For libraries that are looking to export [type mappings](#mapping-existing-types) for their schemas (see next section), you can also add a `dgs.codegen.typemappings` file as a resource under META-INF.
+For a project that is consuming schemas from an external JAR, codegen will also scan `dgs.codegen.typemappings` to automatically map types to corresponding Java classes.
+This avoids the need to explicitly specify type mappings by every consumer of the JAR.
 
 ### Mapping existing types