Update README.md - Server parameters (#1329)

* Update README.md - Server parameters Match the server parameters as documented in docs/SERVER.md Signed-off-by: Largou Walid <[email protected]> * Update README.md - link Server docs Use link for Server Usage Signed-off-by: Largou Walid <[email protected]> * docs: use anchor link Signed-off-by: Adam Setch <[email protected]> --------- Signed-off-by: Largou Walid <[email protected]> Signed-off-by: Adam Setch <[email protected]> Co-authored-by: Adam Setch <[email protected]>
CycloneDX · Aug 26, 2024 · d109eb5 · d109eb5
1 parent 82a55b5
commit d109eb5
Showing 1 changed file with 1 addition and 13 deletions.
diff --git a/README.md b/README.md
@@ -232,19 +232,7 @@ Use curl or your favorite tool to pass arguments to the `/sbom` route.
 
 ### Server arguments
 
-Arguments can be passed either via the query string or as a JSON body. The following arguments are supported.
-
-| Argument       | Description                                                                                                                                 |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| type           | Project type. Please refer to [Supported Project Types][docs-project-types].                                                                |
-| multiProject   | [boolean]                                                                                                                                   |
-| requiredOnly   | Include only the packages with required scope on the SBOM. [boolean]                                                                        |
-| noBabel        | Do not use babel to perform usage analysis for JavaScript/TypeScript projects. [boolean]                                                    |
-| installDeps    | Install dependencies automatically for some projects. Defaults to true but disabled for containers and oci scans. [boolean] [default: true] |
-| project        |                                                                                                                                             |
-| projectName    | Dependency track project name. Default use the directory name                                                                               |
-| projectGroup   | Dependency track project group                                                                                                              |
-| projectVersion | Dependency track project version [default: ""]                                                                                              |
+Arguments can be passed either via the query string or as a JSON body. Please refer to [Server Usage][docs-server]
 
 ### Health endpoint