Env variables to customize the openapi filename

Signed-off-by: Prabhu Subramanian <[email protected]>
AppThreat · Jan 15, 2025 · 360d334 · 360d334
1 parent 03283c4
commit 360d334
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -170,7 +170,11 @@ pip install atom-tools
 atom usages --extract-endpoints -o app.atom --slice-outfile usages.json -l java .
 ```
 
-A file called `openapi.generated.json` would be created with the endpoints information.
+A file called `openapi.generated.json` would be created with the endpoints information. Use the environment variable `ATOM_TOOLS_OPENAPI_FILENAME` to customize the filename.
+
+```shell
+ATOM_TOOLS_OPENAPI_FILENAME=openapi.json atom usages --extract-endpoints -o app.atom --slice-outfile usages.json -l ruby .
+```
 
 ### Export atom to graphml or dot format
 

diff --git a/src/main/scala/io/appthreat/atom/Atom.scala b/src/main/scala/io/appthreat/atom/Atom.scala
@@ -365,14 +365,17 @@ object Atom:
         case u: UsagesConfig =>
             saveSlice(config.outputSliceFile, sliceCpg(ag).map(_.toJson))
             if u.extractEndpoints then
+              val openapiFileName =
+                  sys.env.getOrElse("ATOM_TOOLS_OPENAPI_FILENAME", "openapi.generated.json")
+              val openapiFormat = sys.env.getOrElse("ATOM_TOOLS_OPENAPI_FORMAT", "openapi3.1.0")
               val result = ExternalCommand.run(
-                s"atom-tools convert -i ${config.outputSliceFile} -t ${config.language} -f openapi3.1.0 -q -o ${config
-                        .inputPath.pathAsString}${java.io.File.separator}openapi.generated.json",
+                s"atom-tools convert -i ${config.outputSliceFile} -t ${config.language} -f ${openapiFormat} -q -o ${config
+                        .inputPath.pathAsString}${java.io.File.separator}${openapiFileName}",
                 "."
               )
               result match
                 case Success(_) =>
-                    println("openapi.generated.json created successfully.")
+                    println(s"${openapiFileName} created successfully.")
                 case Failure(exception) =>
                     println(
                       s"Failed to run atom-tools. Use the atom container image or perform 'pip install atom-tools' and re-run this command. Exception: ${exception.getMessage}"