Skip to content

Commit

Permalink
Ability to List Entities and not just Ids (#51)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Actions <[email protected]>
  • Loading branch information
waynehamadi and GitHub Actions committed Aug 29, 2023
1 parent 3fd7b4e commit eda6434
Show file tree
Hide file tree
Showing 6 changed files with 866 additions and 100 deletions.
2 changes: 1 addition & 1 deletion docs/src/app/endpoints/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ curl --request POST http://localhost:8000/agent/tasks

### Response

Returned list of agent's task IDs.
Returned list of agent's tasks.

</Col>
<Col sticky>
Expand Down
File renamed without changes.
35 changes: 35 additions & 0 deletions rfcs/2023-08-28-list-entities-RFC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# List tasks, artifacts and steps in a paginated way.

| Feature name | Support Pagination |
| :------------ |:-----------------------------------------|
| **Author(s)** | Merwane Hamadi ([email protected]) |
| **RFC PR:** | |
| **Updated** | 2023-08-28 |
| **Obsoletes** | |

## Summary

Allows to list resources.

## Motivation

We can't build any app without an index. An index is a GET /tasks endpoint that list information about tasks.
It's like a table.

Currently to build that you need to get the list of task ids. And if you want to display 20 tasks. You will make 20 GET calls to show them.


## Agent Builders Benefit

- They can allow their users to list things: Currently they get a list of ids, that's not useful.

## Design Proposal

Just do what everyone does: return an array of objects that represent the resource

### Alternatives Considered
- Just make 26 calls when you need to display a table of 25 tasks (1 call to get an id and then 25 calls to get the information of each task)

### Compatibility

- This is not backwards compatible.
Loading

0 comments on commit eda6434

Please sign in to comment.