Skip to content

Commit 20e45a2

Browse files
authored
Merge pull request #462 from snyk/docs/automatic-api-docs-update
Generate API docs from spec
2 parents 942438f + f85d2c8 commit 20e45a2

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

docs/.gitbook/assets/rest-spec.json

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -907,7 +907,8 @@
907907
"style": "form"
908908
},
909909
"OrgId": {
910-
"description": "Unique identifier for an organization",
910+
"description": "The ID of the organization.",
911+
"example": "0d3728ec-eebf-484d-9907-ba238019f10b",
911912
"in": "path",
912913
"name": "org_id",
913914
"required": true,
@@ -20042,15 +20043,7 @@
2004220043
"$ref": "#/components/parameters/Version"
2004320044
},
2004420045
{
20045-
"description": "The ID of the organization.",
20046-
"example": "0d3728ec-eebf-484d-9907-ba238019f10b",
20047-
"in": "path",
20048-
"name": "org_id",
20049-
"required": true,
20050-
"schema": {
20051-
"format": "uuid",
20052-
"type": "string"
20053-
}
20046+
"$ref": "#/components/parameters/OrgId"
2005420047
},
2005520048
{
2005620049
"$ref": "#/components/parameters/Cursor"
@@ -26074,7 +26067,14 @@
2607426067
"$ref": "#/components/parameters/Version"
2607526068
},
2607626069
{
26077-
"$ref": "#/components/parameters/OrgId"
26070+
"description": "Unique identifier for an organization",
26071+
"in": "path",
26072+
"name": "org_id",
26073+
"required": true,
26074+
"schema": {
26075+
"format": "uuid",
26076+
"type": "string"
26077+
}
2607826078
}
2607926079
],
2608026080
"requestBody": {
@@ -26170,7 +26170,14 @@
2617026170
"$ref": "#/components/parameters/PackageUrl"
2617126171
},
2617226172
{
26173-
"$ref": "#/components/parameters/OrgId"
26173+
"description": "Unique identifier for an organization",
26174+
"in": "path",
26175+
"name": "org_id",
26176+
"required": true,
26177+
"schema": {
26178+
"format": "uuid",
26179+
"type": "string"
26180+
}
2617426181
},
2617526182
{
2617626183
"description": "Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.",
@@ -35474,7 +35481,14 @@
3547435481
"$ref": "#/components/parameters/Version"
3547535482
},
3547635483
{
35477-
"$ref": "#/components/parameters/OrgId"
35484+
"description": "Unique identifier for an organization",
35485+
"in": "path",
35486+
"name": "org_id",
35487+
"required": true,
35488+
"schema": {
35489+
"format": "uuid",
35490+
"type": "string"
35491+
}
3547835492
},
3547935493
{
3548035494
"description": "Unique identifier for a project",

0 commit comments

Comments
 (0)