diff --git a/src/pages/feature-guides/_meta.ts b/src/pages/feature-guides/_meta.ts index 7768c73..41e4256 100644 --- a/src/pages/feature-guides/_meta.ts +++ b/src/pages/feature-guides/_meta.ts @@ -9,4 +9,7 @@ export default { 'several-assets-and-artifacts-to-devguard-monorepos': { title: 'Mapping Several Assets and Artifacts (e.g., Monorepos)', }, + 'organization-wide-search': { + title: 'Searching specific Packages in Organization', + }, } diff --git a/src/pages/feature-guides/organization-wide-search.mdx b/src/pages/feature-guides/organization-wide-search.mdx new file mode 100644 index 0000000..bd85960 --- /dev/null +++ b/src/pages/feature-guides/organization-wide-search.mdx @@ -0,0 +1,32 @@ +# Searching for specific Package in Organization + +- It is now possible to search for a specific Package in each Repository in an Organization. + - Only Admin & Owner Roles can search for this Package. + - This Feature is useful, when you want to quickly check whether a certain Package is used in any Repository (e.g xz-util) and what version it is on. + - Additionally it is shown in which artifacts the Package is. + - It is found on the organization Page, in the Tabs Area, next to the Settings (you need the correct Permission to see the tab). + +# How it works + +- It recursively looks for the specific Package name with an LIKE statement, in each Repository in your Organization, + it will only find direct Dependencies (First Party Dependencies). + +- one new endpoint will be available: + - `api/v1/organizations/{organizationName}/dependency-components?search={packageName}` + - These endpoints will provide certain information: + - componentDependencyId + - dependencyPurl + - organizationId + - organizationName + - projectId + - projectName + - projectSlug + - assetId + - assetName + - assetSlug + - assetVersionName + - componentPurl + - componentVersion + - artifactName + - artifactAssetVersion + - added information for paging diff --git a/src/pages/getting-started/index.mdx b/src/pages/getting-started/index.mdx index b0c2490..7d3ae80 100644 --- a/src/pages/getting-started/index.mdx +++ b/src/pages/getting-started/index.mdx @@ -1,7 +1,8 @@ import { Tabs } from 'nextra/components' import { Callout } from 'nextra/components' -# Getting Started with DevGuard 🚀 +### Getting Started with DevGuard 🚀 + We are currently working on the set-up flows for DevGuard - some steps might currently not work as expected.