docs: synchronizing api spec with user-docs

snyk · Oct 22, 2024 · 8ed97ac · 8ed97ac
1 parent 4065ba7
commit 8ed97ac
Show file tree

Hide file tree

Showing 11 changed files with 14,885 additions and 39,370 deletions.
diff --git a/docs/.gitbook/assets/rest-spec.json b/docs/.gitbook/assets/rest-spec.json
diff --git a/docs/snyk-api/reference/accessrequests.md b/docs/snyk-api/reference/accessrequests.md
@@ -0,0 +1,9 @@
+# AccessRequests
+
+{% hint style="info" %}
+This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
+{% endhint %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/self/access_requests" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
diff --git a/docs/snyk-api/reference/assignment.md b/docs/snyk-api/reference/assignment.md
@@ -0,0 +1,13 @@
+# Assignment
+
+{% hint style="info" %}
+This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
+{% endhint %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/learn/assignments" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/learn/assignments" method="delete" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
diff --git a/docs/snyk-api/reference/catalog-resource.md b/docs/snyk-api/reference/catalog-resource.md
@@ -0,0 +1,9 @@
+# Catalog Resource
+
+{% hint style="info" %}
+This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
+{% endhint %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/learn/catalog" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
diff --git a/docs/snyk-api/reference/cloud.md b/docs/snyk-api/reference/cloud.md
@@ -0,0 +1,41 @@
+# Cloud
+
+{% hint style="info" %}
+This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
+{% endhint %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/scans" method="post" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/scans" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/scans/{scan_id}" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/resources" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/permissions" method="post" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/environments" method="post" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/environments" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/environments/{environment_id}" method="patch" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/cloud/environments/{environment_id}" method="delete" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
diff --git a/docs/snyk-api/reference/groups.md b/docs/snyk-api/reference/groups.md
@@ -4,6 +4,26 @@
 This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
 {% endhint %}
 
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/sso_connections" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/sso_connections/{sso_id}/users" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}" method="delete" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
 {% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/org_memberships" method="get" %}
 [rest-spec.json](../../.gitbook/assets/rest-spec.json)
 {% endswagger %}

diff --git a/docs/snyk-api/reference/sbom.md b/docs/snyk-api/reference/sbom.md
@@ -4,6 +4,18 @@
 This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
 {% endhint %}
 
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/sbom_tests" method="post" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/sbom_tests/{job_id}" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/sbom_tests/{job_id}/results" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
 {% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/projects/{project_id}/sbom" method="get" %}
 [rest-spec.json](../../.gitbook/assets/rest-spec.json)
 {% endswagger %}
diff --git a/docs/snyk-api/reference/tenants.md b/docs/snyk-api/reference/tenants.md
@@ -0,0 +1,17 @@
+# Tenants
+
+{% hint style="info" %}
+This document uses the REST API. For more details, see the [Authentication for API](../rest-api/authentication-for-api/) page.
+{% endhint %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/tenants/{tenant_id}/memberships" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/tenants/{tenant_id}/memberships/{membership_id}" method="patch" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/tenants/{tenant_id}/memberships/{membership_id}" method="delete" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
diff --git a/docs/snyk-api/reference/users.md b/docs/snyk-api/reference/users.md
@@ -7,3 +7,11 @@ This document uses the REST API. For more details, see the [Authentication for A
 {% swagger src="../../.gitbook/assets/rest-spec.json" path="/self" method="get" %}
 [rest-spec.json](../../.gitbook/assets/rest-spec.json)
 {% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/orgs/{org_id}/users/{id}" method="get" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}
+
+{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/users/{id}" method="patch" %}
+[rest-spec.json](../../.gitbook/assets/rest-spec.json)
+{% endswagger %}