Skip to content

Commit

Permalink
Precise artifact created by agent or not (#54)
Browse files Browse the repository at this point in the history 
Signed-off-by: Merwane Hamadi <[email protected]>
Co-authored-by: GitHub Actions <[email protected]>
  • Loading branch information
@waynehamadi
waynehamadi and GitHub Actions authored Aug 28, 2023
1 parent d8fcb8f commit 4d73475
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 0 deletions.
0 rfcs/AP-RFC-1.md → rfcs/2023-08-14-AP-RFC.md
View file
File renamed without changes.
29 changes: 29 additions & 0 deletions rfcs/2023-08-28-agent-created-RFC-.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Tell the user whether the artifact is agent generated or not

| Feature name | Artifact Created At |
|:--------------|:-----------------------------------------|
| **Author(s)** | Merwane Hamadi ([email protected]) |
| **RFC PR:** | |
| **Created** | 2023-08-28 |
| **Obsoletes** | |

## Summary
Add agent_created to the artifact response body.

## Motivation
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.


## Agent Builders Benefit

- They can tell their users what their agent did.

## Design Proposal

agent_created field in the response body

### Alternatives Considered

### Compatibility

- This is backwards compatible. We're just adding something.
60 changes: 60 additions & 0 deletions schemas/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -102,6 +107,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -243,6 +249,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -257,6 +268,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -493,6 +505,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -507,6 +524,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -696,6 +714,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -710,6 +733,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -796,6 +820,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -810,6 +839,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -906,6 +936,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -920,6 +955,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
}
Expand Down Expand Up @@ -1051,6 +1087,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -1065,6 +1106,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand All @@ -1084,6 +1126,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -1098,6 +1145,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -1192,6 +1240,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -1206,6 +1259,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down Expand Up @@ -1312,6 +1366,11 @@
"type": "string",
"example": "b225e278-8b4c-4f99-a696-8facf19f0e56"
},
"agent_created": {
"description": "Whether the artifact has been created by the agent.",
"type": "boolean",
"example": false
},
"file_name": {
"description": "Filename of the artifact.",
"type": "string",
Expand All @@ -1326,6 +1385,7 @@
},
"required": [
"artifact_id",
"agent_created",
"file_name"
]
},
Expand Down
5 changes: 5 additions & 0 deletions schemas/openapi.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,10 @@ components:
description: ID of the artifact.
type: string
example: b225e278-8b4c-4f99-a696-8facf19f0e56
agent_created:
description: Whether the artifact has been created by the agent.
type: boolean
example: false
file_name:
description: Filename of the artifact.
type: string
Expand All @@ -322,6 +326,7 @@ components:
nullable: true
required:
- artifact_id
- agent_created
- file_name
ArtifactUpload:
description: Artifact to upload to the agent.
Expand Down

0 comments on commit 4d73475

Please sign in to comment.