Skip to content

Commit 23fcd13

Browse files
david-roccadavid-rocca
authored
Merge pull request #1810 from CVEProject/dr_documentation_updates
Documentation Updates
2 parents ec8ff9d + 191fdad commit 23fcd13

7 files changed

Lines changed: 799 additions & 26 deletions

File tree

‎api-docs/openapi.json‎

Lines changed: 167 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2080,7 +2080,7 @@
20802080
},
20812081
"example": {
20822082
"short_name": "fake_company",
2083-
"name": "Fake Company",
2083+
"long_name": "Fake Company",
20842084
"hard_quota": 1000,
20852085
"authority": [
20862086
"CNA"
@@ -2140,18 +2140,15 @@
21402140
"users": [
21412141
{
21422142
"UUID": "fe566221-6a2c-4279-8800-4d3795325997",
2143-
"org_UUID": "9e243a41-352b-426a-9dfd-f664b4c71e80",
21442143
"username": "jdoe",
21452144
"name": {
21462145
"first": "John",
21472146
"last": "Doe"
21482147
},
21492148
"role": "ADMIN",
2150-
"is_active": true,
2151-
"time": {
2152-
"created": "2021-02-12T17:15:37.382Z",
2153-
"modified": "2021-02-12T17:15:37.382Z"
2154-
}
2149+
"status": "active",
2150+
"created": "2021-02-12T17:15:37.382Z",
2151+
"last_updated": "2021-02-12T17:15:37.382Z"
21552152
}
21562153
]
21572154
}
@@ -2542,6 +2539,20 @@
25422539
"application/json": {
25432540
"schema": {
25442541
"$ref": "../schemas/registry-user/update-registry-user-response.json"
2542+
},
2543+
"example": {
2544+
"message": "jdoe was successfully updated.",
2545+
"updated": {
2546+
"UUID": "fe566221-6a2c-4279-8800-4d3795325997",
2547+
"username": "jdoe",
2548+
"name": {
2549+
"first": "John",
2550+
"last": "Doe"
2551+
},
2552+
"status": "active",
2553+
"created": "2021-02-12T17:15:37.382Z",
2554+
"last_updated": "2021-02-12T17:15:37.382Z"
2555+
}
25452556
}
25462557
}
25472558
}
@@ -2698,7 +2709,7 @@
26982709
},
26992710
"example": {
27002711
"short_name": "fake_company",
2701-
"name": "Fake Company",
2712+
"long_name": "Fake Company",
27022713
"hard_quota": 1000,
27032714
"authority": [
27042715
"CNA"
@@ -2745,6 +2756,21 @@
27452756
"schema": {
27462757
"$ref": "../schemas/registry-user/create-registry-user-response.json"
27472758
}
2759+
},
2760+
"example": {
2761+
"message": "jdoe was successfully created.",
2762+
"created": {
2763+
"UUID": "fe566221-6a2c-4279-8800-4d3795325997",
2764+
"username": "jdoe",
2765+
"name": {
2766+
"first": "John",
2767+
"last": "Doe"
2768+
},
2769+
"status": "active",
2770+
"secret": "12345-abcde-67890",
2771+
"created": "2021-02-12T17:15:37.382Z",
2772+
"last_updated": "2021-02-12T17:15:37.382Z"
2773+
}
27482774
}
27492775
}
27502776
},
@@ -2806,6 +2832,13 @@
28062832
"schema": {
28072833
"$ref": "../schemas/registry-user/create-registry-user-request.json"
28082834
}
2835+
},
2836+
"example": {
2837+
"username": "jdoe",
2838+
"name": {
2839+
"first": "John",
2840+
"last": "Doe"
2841+
}
28092842
}
28102843
}
28112844
}
@@ -4522,6 +4555,24 @@
45224555
"application/json": {
45234556
"schema": {
45244557
"$ref": "../schemas/conversation/list-conversations-response.json"
4558+
},
4559+
"example": {
4560+
"totalCount": 1,
4561+
"itemsPerPage": 10,
4562+
"pageCount": 1,
4563+
"currentPage": 1,
4564+
"prevPage": null,
4565+
"nextPage": null,
4566+
"conversations": [
4567+
{
4568+
"UUID": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
4569+
"target_uuid": "123e4567-e89b-12d3-a456-426614174000",
4570+
"author_id": "fe566221-6a2c-4279-8800-4d3795325997",
4571+
"author_name": "John Doe",
4572+
"body": "This is a conversation message.",
4573+
"posted_at": "2021-02-12T17:15:37.382Z"
4574+
}
4575+
]
45254576
}
45264577
}
45274578
}
@@ -4622,6 +4673,24 @@
46224673
"application/json": {
46234674
"schema": {
46244675
"$ref": "../schemas/conversation/list-conversations-response.json"
4676+
},
4677+
"example": {
4678+
"totalCount": 1,
4679+
"itemsPerPage": 10,
4680+
"pageCount": 1,
4681+
"currentPage": 1,
4682+
"prevPage": null,
4683+
"nextPage": null,
4684+
"conversations": [
4685+
{
4686+
"UUID": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
4687+
"target_uuid": "123e4567-e89b-12d3-a456-426614174000",
4688+
"author_id": "fe566221-6a2c-4279-8800-4d3795325997",
4689+
"author_name": "John Doe",
4690+
"body": "This is a conversation message.",
4691+
"posted_at": "2021-02-12T17:15:37.382Z"
4692+
}
4693+
]
46254694
}
46264695
}
46274696
}
@@ -4712,6 +4781,14 @@
47124781
"application/json": {
47134782
"schema": {
47144783
"$ref": "../schemas/conversation/conversation.json"
4784+
},
4785+
"example": {
4786+
"UUID": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
4787+
"target_uuid": "123e4567-e89b-12d3-a456-426614174000",
4788+
"author_id": "fe566221-6a2c-4279-8800-4d3795325997",
4789+
"author_name": "John Doe",
4790+
"body": "This is a conversation message.",
4791+
"posted_at": "2021-02-12T17:15:37.382Z"
47154792
}
47164793
}
47174794
}
@@ -4782,6 +4859,9 @@
47824859
"required": [
47834860
"body"
47844861
]
4862+
},
4863+
"example": {
4864+
"body": "This is a conversation message."
47854865
}
47864866
}
47874867
}
@@ -4823,6 +4903,16 @@
48234903
"application/json": {
48244904
"schema": {
48254905
"$ref": "../schemas/conversation/conversation.json"
4906+
},
4907+
"example": {
4908+
"UUID": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
4909+
"target_uuid": "123e4567-e89b-12d3-a456-426614174000",
4910+
"author_id": "fe566221-6a2c-4279-8800-4d3795325997",
4911+
"author_name": "John Doe",
4912+
"body": "This is an updated conversation message.",
4913+
"visibility": "public",
4914+
"posted_at": "2021-02-12T17:15:37.382Z",
4915+
"edited_at": "2021-02-12T17:20:00.000Z"
48264916
}
48274917
}
48284918
}
@@ -4898,6 +4988,10 @@
48984988
"description": "The updated visibility of the conversation message"
48994989
}
49004990
}
4991+
},
4992+
"example": {
4993+
"body": "This is an updated conversation message.",
4994+
"visibility": "public"
49014995
}
49024996
}
49034997
}
@@ -4939,6 +5033,16 @@
49395033
"application/json": {
49405034
"schema": {
49415035
"$ref": "../schemas/review/review.json"
5036+
},
5037+
"example": {
5038+
"uuid": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
5039+
"target_object_uuid": "123e4567-e89b-12d3-a456-426614174000",
5040+
"status": "PENDING",
5041+
"new_review_data": {
5042+
"name": "New Organization Name"
5043+
},
5044+
"created": "2021-02-12T17:15:37.382Z",
5045+
"last_updated": "2021-02-12T17:15:37.382Z"
49425046
}
49435047
}
49445048
}
@@ -5031,6 +5135,16 @@
50315135
"application/json": {
50325136
"schema": {
50335137
"$ref": "../schemas/review/review.json"
5138+
},
5139+
"example": {
5140+
"uuid": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
5141+
"target_object_uuid": "123e4567-e89b-12d3-a456-426614174000",
5142+
"status": "PENDING",
5143+
"new_review_data": {
5144+
"name": "New Organization Name"
5145+
},
5146+
"created": "2021-02-12T17:15:37.382Z",
5147+
"last_updated": "2021-02-12T17:15:37.382Z"
50345148
}
50355149
}
50365150
}
@@ -5130,6 +5244,26 @@
51305244
"application/json": {
51315245
"schema": {
51325246
"$ref": "../schemas/review/list-reviews-response.json"
5247+
},
5248+
"example": {
5249+
"totalCount": 1,
5250+
"itemsPerPage": 100,
5251+
"pageCount": 1,
5252+
"currentPage": 1,
5253+
"prevPage": null,
5254+
"nextPage": null,
5255+
"reviews": [
5256+
{
5257+
"uuid": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
5258+
"target_object_uuid": "123e4567-e89b-12d3-a456-426614174000",
5259+
"status": "PENDING",
5260+
"new_review_data": {
5261+
"name": "New Organization Name"
5262+
},
5263+
"created": "2021-02-12T17:15:37.382Z",
5264+
"last_updated": "2021-02-12T17:15:37.382Z"
5265+
}
5266+
]
51335267
}
51345268
}
51355269
}
@@ -5330,6 +5464,16 @@
53305464
"application/json": {
53315465
"schema": {
53325466
"$ref": "../schemas/review/review.json"
5467+
},
5468+
"example": {
5469+
"uuid": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
5470+
"target_object_uuid": "123e4567-e89b-12d3-a456-426614174000",
5471+
"status": "PENDING",
5472+
"new_review_data": {
5473+
"name": "New Organization Name"
5474+
},
5475+
"created": "2021-02-12T17:15:37.382Z",
5476+
"last_updated": "2021-02-12T17:15:37.382Z"
53335477
}
53345478
}
53355479
}
@@ -5392,6 +5536,11 @@
53925536
"schema": {
53935537
"type": "object",
53945538
"description": "The updated review data"
5539+
},
5540+
"example": {
5541+
"new_review_data": {
5542+
"name": "New Organization Name"
5543+
}
53955544
}
53965545
}
53975546
}
@@ -5433,6 +5582,16 @@
54335582
"application/json": {
54345583
"schema": {
54355584
"$ref": "../schemas/review/review.json"
5585+
},
5586+
"example": {
5587+
"uuid": "c8a41738-f9d6-4447-9755-9ab0101b7a2d",
5588+
"target_object_uuid": "123e4567-e89b-12d3-a456-426614174000",
5589+
"status": "PENDING",
5590+
"new_review_data": {
5591+
"name": "New Organization Name"
5592+
},
5593+
"created": "2021-02-12T17:15:37.382Z",
5594+
"last_updated": "2021-02-12T17:15:37.382Z"
54365595
}
54375596
}
54385597
}

‎schemas/glossary/list-glossary-items-response.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"glossary": {
66
"type": "array",
77
"items": {
8-
"type": "object"
8+
"$ref": "glossary.json"
99
}
1010
}
1111
},

0 commit comments

Comments
 (0)