Skip to content

Commit 4d73475

Browse files
waynehamadiGitHub Actions
waynehamadi
and
GitHub Actions
authored
Precise artifact created by agent or not (#54)
Signed-off-by: Merwane Hamadi <merwanehamadi@gmail.com> Co-authored-by: GitHub Actions <no-reply@github.com>
1 parent d8fcb8f commit 4d73475

4 files changed

Lines changed: 94 additions & 0 deletions

File tree

rfcs/AP-RFC-1.md renamed to rfcs/2023-08-14-AP-RFC.md

File renamed without changes.

‎rfcs/2023-08-28-agent-created-RFC-.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Tell the user whether the artifact is agent generated or not
2+
3+
| Feature name | Artifact Created At |
4+
|:--------------|:-----------------------------------------|
5+
| **Author(s)** | Merwane Hamadi (merwanehamadi@gmail.com) |
6+
| **RFC PR:** | |
7+
| **Created** | 2023-08-28 |
8+
| **Obsoletes** | |
9+
10+
## Summary
11+
Add agent_created to the artifact response body.
12+
13+
## Motivation
14+
If we don't know whether an artifact is generated by the agent or not, it's hard to know what the agent did or did not do.
15+
16+
17+
## Agent Builders Benefit
18+
19+
- They can tell their users what their agent did.
20+
21+
## Design Proposal
22+
23+
agent_created field in the response body
24+
25+
### Alternatives Considered
26+
27+
### Compatibility
28+
29+
- This is backwards compatible. We're just adding something.

‎schemas/openapi.json‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@
8888
"type": "string",
8989
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
9090
},
91+
"agent_created": {
92+
"description": "Whether the artifact has been created by the agent.",
93+
"type": "boolean",
94+
"example": false
95+
},
9196
"file_name": {
9297
"description": "Filename of the artifact.",
9398
"type": "string",
@@ -102,6 +107,7 @@
102107
},
103108
"required": [
104109
"artifact_id",
110+
"agent_created",
105111
"file_name"
106112
]
107113
},
@@ -243,6 +249,11 @@
243249
"type": "string",
244250
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
245251
},
252+
"agent_created": {
253+
"description": "Whether the artifact has been created by the agent.",
254+
"type": "boolean",
255+
"example": false
256+
},
246257
"file_name": {
247258
"description": "Filename of the artifact.",
248259
"type": "string",
@@ -257,6 +268,7 @@
257268
},
258269
"required": [
259270
"artifact_id",
271+
"agent_created",
260272
"file_name"
261273
]
262274
},
@@ -493,6 +505,11 @@
493505
"type": "string",
494506
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
495507
},
508+
"agent_created": {
509+
"description": "Whether the artifact has been created by the agent.",
510+
"type": "boolean",
511+
"example": false
512+
},
496513
"file_name": {
497514
"description": "Filename of the artifact.",
498515
"type": "string",
@@ -507,6 +524,7 @@
507524
},
508525
"required": [
509526
"artifact_id",
527+
"agent_created",
510528
"file_name"
511529
]
512530
},
@@ -696,6 +714,11 @@
696714
"type": "string",
697715
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
698716
},
717+
"agent_created": {
718+
"description": "Whether the artifact has been created by the agent.",
719+
"type": "boolean",
720+
"example": false
721+
},
699722
"file_name": {
700723
"description": "Filename of the artifact.",
701724
"type": "string",
@@ -710,6 +733,7 @@
710733
},
711734
"required": [
712735
"artifact_id",
736+
"agent_created",
713737
"file_name"
714738
]
715739
},
@@ -796,6 +820,11 @@
796820
"type": "string",
797821
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
798822
},
823+
"agent_created": {
824+
"description": "Whether the artifact has been created by the agent.",
825+
"type": "boolean",
826+
"example": false
827+
},
799828
"file_name": {
800829
"description": "Filename of the artifact.",
801830
"type": "string",
@@ -810,6 +839,7 @@
810839
},
811840
"required": [
812841
"artifact_id",
842+
"agent_created",
813843
"file_name"
814844
]
815845
},
@@ -906,6 +936,11 @@
906936
"type": "string",
907937
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
908938
},
939+
"agent_created": {
940+
"description": "Whether the artifact has been created by the agent.",
941+
"type": "boolean",
942+
"example": false
943+
},
909944
"file_name": {
910945
"description": "Filename of the artifact.",
911946
"type": "string",
@@ -920,6 +955,7 @@
920955
},
921956
"required": [
922957
"artifact_id",
958+
"agent_created",
923959
"file_name"
924960
]
925961
}
@@ -1051,6 +1087,11 @@
10511087
"type": "string",
10521088
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
10531089
},
1090+
"agent_created": {
1091+
"description": "Whether the artifact has been created by the agent.",
1092+
"type": "boolean",
1093+
"example": false
1094+
},
10541095
"file_name": {
10551096
"description": "Filename of the artifact.",
10561097
"type": "string",
@@ -1065,6 +1106,7 @@
10651106
},
10661107
"required": [
10671108
"artifact_id",
1109+
"agent_created",
10681110
"file_name"
10691111
]
10701112
},
@@ -1084,6 +1126,11 @@
10841126
"type": "string",
10851127
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
10861128
},
1129+
"agent_created": {
1130+
"description": "Whether the artifact has been created by the agent.",
1131+
"type": "boolean",
1132+
"example": false
1133+
},
10871134
"file_name": {
10881135
"description": "Filename of the artifact.",
10891136
"type": "string",
@@ -1098,6 +1145,7 @@
10981145
},
10991146
"required": [
11001147
"artifact_id",
1148+
"agent_created",
11011149
"file_name"
11021150
]
11031151
},
@@ -1192,6 +1240,11 @@
11921240
"type": "string",
11931241
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
11941242
},
1243+
"agent_created": {
1244+
"description": "Whether the artifact has been created by the agent.",
1245+
"type": "boolean",
1246+
"example": false
1247+
},
11951248
"file_name": {
11961249
"description": "Filename of the artifact.",
11971250
"type": "string",
@@ -1206,6 +1259,7 @@
12061259
},
12071260
"required": [
12081261
"artifact_id",
1262+
"agent_created",
12091263
"file_name"
12101264
]
12111265
},
@@ -1312,6 +1366,11 @@
13121366
"type": "string",
13131367
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
13141368
},
1369+
"agent_created": {
1370+
"description": "Whether the artifact has been created by the agent.",
1371+
"type": "boolean",
1372+
"example": false
1373+
},
13151374
"file_name": {
13161375
"description": "Filename of the artifact.",
13171376
"type": "string",
@@ -1326,6 +1385,7 @@
13261385
},
13271386
"required": [
13281387
"artifact_id",
1388+
"agent_created",
13291389
"file_name"
13301390
]
13311391
},

‎schemas/openapi.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,10 @@ components:
311311
description: ID of the artifact.
312312
type: string
313313
example: b225e278-8b4c-4f99-a696-8facf19f0e56
314+
agent_created:
315+
description: Whether the artifact has been created by the agent.
316+
type: boolean
317+
example: false
314318
file_name:
315319
description: Filename of the artifact.
316320
type: string
@@ -322,6 +326,7 @@ components:
322326
nullable: true
323327
required:
324328
- artifact_id
329+
- agent_created
325330
- file_name
326331
ArtifactUpload:
327332
description: Artifact to upload to the agent.

0 commit comments

Comments
 (0)