Skip to content

Commit

Permalink
chore: rename v1 spec for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
@tinygrasshopper
tinygrasshopper committed Jun 3, 2024
1 parent 8a7f217 commit 77cfeea
Show file tree
Hide file tree
Showing 16 changed files with 205 additions and 205 deletions.
0 docs/.gitbook/assets/spec.yaml → docs/.gitbook/assets/v1-api-spec.yaml
View file
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/snyk-api/reference/audit-logs-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/audit" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/audit" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/audit" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/audit" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
4 changes: 2 additions & 2 deletions docs/snyk-api/reference/dependencies-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/dependencies" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/dependencies" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
8 changes: 4 additions & 4 deletions docs/snyk-api/reference/entitlements-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/entitlements" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/entitlements" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/entitlement/{entitlementKey}" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/entitlement/{entitlementKey}" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
32 changes: 16 additions & 16 deletions docs/snyk-api/reference/groups-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,34 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/tags" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/tags" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/tags/delete" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/tags/delete" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/roles" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/roles" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/orgs" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/orgs" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/org/{orgId}/members" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/org/{orgId}/members" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/members" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/group/{groupId}/members" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
8 changes: 4 additions & 4 deletions docs/snyk-api/reference/import-projects-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import/{jobId}" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import/{jobId}" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
40 changes: 20 additions & 20 deletions docs/snyk-api/reference/integrations-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,42 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{type}" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{type}" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/clone" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/clone" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication" method="delete" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication" method="delete" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/switch-token" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/switch-token" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/provision-token" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/integrations/{integrationId}/authentication/provision-token" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
4 changes: 2 additions & 2 deletions docs/snyk-api/reference/licenses-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ This document uses the v1 API. For more details, see the [v1 API](../v1-api-over
{% endhint %}
**Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay.

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/licenses" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/licenses" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
4 changes: 2 additions & 2 deletions docs/snyk-api/reference/monitor-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/monitor/dep-graph" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/monitor/dep-graph" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
60 changes: 30 additions & 30 deletions docs/snyk-api/reference/organizations-v1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,62 +3,62 @@
{% hint style="info" %}
This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/).
{% endhint %}
{% swagger src="../../.gitbook/assets/spec.yaml" path="/orgs" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/orgs" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}" method="delete" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}" method="delete" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/settings" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/settings" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/provision" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/provision" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/provision" method="delete" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/provision" method="delete" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/notification-settings" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/notification-settings" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/notification-settings" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/notification-settings" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/members" method="get" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members" method="get" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/members/{userId}" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/{userId}" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/members/{userId}" method="delete" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/{userId}" method="delete" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/members/update/{userId}" method="put" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/members/update/{userId}" method="put" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/invite" method="post" %}
[spec.yaml](../../.gitbook/assets/spec.yaml)
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/invite" method="post" %}
[spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
{% endswagger %}
Loading

0 comments on commit 77cfeea

Please sign in to comment.