Skip to content

Commit 6b640c3

Browse files
authored
Merge pull request #460 from snyk/feat/add-note-for-projects-v1
feat: add note for v1 projects api
2 parents e57c486 + a83f0c8 commit 6b640c3

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/snyk-api/reference/projects-v1.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
This document uses the v1 API. For more details, see the [v1 API](../v1-api.md).
55
{% endhint %}
66

7+
**Note:** For a list of Project types, see [Project type responses from the API](../snyk-api/api-endpoints-index-and-tips/project-type-responses-from-the-api).
8+
79
{% swagger src="../../.gitbook/assets/v1-api-spec.yaml" path="/org/{orgId}/project/{projectId}" method="put" %}
810
[v1-api-spec.yaml](../../.gitbook/assets/v1-api-spec.yaml)
911
{% endswagger %}

tools/api-docs-generator/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ categoryContext:
1111
- name: licenses-v1
1212
hint: |
1313
**Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay.
14+
- name: projects-v1
15+
hint: |
16+
**Note:** For a list of Project types, see [Project type responses from the API](../snyk-api/api-endpoints-index-and-tips/project-type-responses-from-the-api).
1417
output:
1518
summaryPath: docs/SUMMARY.md
1619
apiReferencePath: docs/snyk-api/reference

0 commit comments

Comments
 (0)