Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC Allow Pagination #53

Merged
merged 3 commits into from
Aug 29, 2023
Merged

RFC Allow Pagination #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2b82fa
Pagination
waynehamadi Aug 29, 2023
85d7d93
Update endpoint docs
invalid-email-address Aug 29, 2023
bc243b7
Lint OpenAPI schemas
invalid-email-address Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/src/app/endpoints/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,17 @@ curl --request POST http://localhost:8000/agent/tasks
<Col>
List all tasks that have been created for the agent.

### Path attributes

<Properties>

<Property name="current_page" type="integer">
Page number
</Property>
<Property name="page_size" type="integer">
Number of items per page
</Property>
</Properties>


### Response
Expand Down Expand Up @@ -113,6 +123,12 @@ curl http://localhost:8000/agent/tasks/[task_id]
<Property name="task_id" type="string">
ID of the task.
</Property>
<Property name="current_page" type="integer">
Page number
</Property>
<Property name="page_size" type="integer">
Number of items per page
</Property>
</Properties>


Expand Down Expand Up @@ -223,6 +239,12 @@ curl http://localhost:8000/agent/tasks/[task_id]/steps/[step_id]
<Property name="task_id" type="string">
ID of the task
</Property>
<Property name="current_page" type="integer">
Page number
</Property>
<Property name="page_size" type="integer">
Number of items per page
</Property>
</Properties>


Expand Down
32 changes: 32 additions & 0 deletions rfcs/2-Pagination-RFC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# List tasks, artifacts and steps in a paginated way.

| Feature name | Support Pagination |
| :------------ |:-----------------------------------------|
| **Author(s)** | Merwane Hamadi ([email protected]) |
| **RFC PR:** | [PR 53](https://github.com/e2b-dev/agent-protocol/pull/53) |
| **Updated** | 2023-08-28 |
| **Obsoletes** | |

## Summary

We just want to be able to list tasks, artifacts and steps in a paginated way.

## Motivation

Every app needs this. It's not really farfetched

## Agent Builders Benefit

- They can paginate their tasks, steps and artifacts.

## Design Proposal

Query parameters for now.

### Alternatives Considered
- query parameter is the simplest, leanest design. We can add more later (body, headers, etc) => let's start lean.
- for now, we won't add the pages in the response of the requests, this is another RFC.

### Compatibility

- This is backwards compatible. We're just adding things.
120 changes: 115 additions & 5 deletions schemas/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,34 @@
"get": {
"operationId": "listAgentTasksIDs",
"summary": "List all tasks that have been created for the agent.",
"parameters": [
{
"name": "current_page",
"in": "query",
"description": "Page number",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"minimum": 1
},
"example": 2
},
{
"name": "page_size",
"in": "query",
"description": "Number of items per page",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"minimum": 1
},
"example": 25
}
],
"responses": {
"200": {
"description": "Returned list of agent's task IDs.",
Expand Down Expand Up @@ -334,6 +362,32 @@
"name": "task_id"
}
]
},
{
"name": "current_page",
"in": "query",
"description": "Page number",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"minimum": 1
},
"example": 2
},
{
"name": "page_size",
"in": "query",
"description": "Number of items per page",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"minimum": 1
},
"example": 25
}
],
"responses": {
Expand Down Expand Up @@ -411,7 +465,8 @@
"input": {
"description": "Input prompt for the step.",
"type": "string",
"example": "Write the words you receive to the file 'output.txt'."
"example": "Write the words you receive to the file 'output.txt'.",
"nullable": true
},
"additional_input": {
"description": "Input parameters for the task step. Any value is allowed.",
Expand All @@ -437,7 +492,8 @@
"input": {
"description": "Input prompt for the step.",
"type": "string",
"example": "Write the words you receive to the file 'output.txt'."
"example": "Write the words you receive to the file 'output.txt'.",
"nullable": true
},
"additional_input": {
"description": "Input parameters for the task step. Any value is allowed.",
Expand Down Expand Up @@ -646,7 +702,8 @@
"input": {
"description": "Input prompt for the step.",
"type": "string",
"example": "Write the words you receive to the file 'output.txt'."
"example": "Write the words you receive to the file 'output.txt'.",
"nullable": true
},
"additional_input": {
"description": "Input parameters for the task step. Any value is allowed.",
Expand Down Expand Up @@ -801,6 +858,32 @@
"name": "task_id"
}
]
},
{
"name": "current_page",
"in": "query",
"description": "Page number",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"minimum": 1
},
"example": 2
},
{
"name": "page_size",
"in": "query",
"description": "Number of items per page",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"minimum": 1
},
"example": 25
}
],
"responses": {
Expand Down Expand Up @@ -1067,6 +1150,31 @@
},
"components": {
"schemas": {
"Pagination": {
"type": "object",
"properties": {
"total_items": {
"description": "Total number of items.",
"type": "integer",
"example": 42
},
"total_pages": {
"description": "Total number of pages.",
"type": "integer",
"example": 97
},
"current_page": {
"description": "Current_page page number.",
"type": "integer",
"example": 1
},
"page_size": {
"description": "Number of items per page.",
"type": "integer",
"example": 25
}
}
},
"TaskStepsListResponse": {
"description": "A list of step IDs for the task",
"type": "array",
Expand Down Expand Up @@ -1280,7 +1388,8 @@
"input": {
"description": "Input prompt for the step.",
"type": "string",
"example": "Write the words you receive to the file 'output.txt'."
"example": "Write the words you receive to the file 'output.txt'.",
"nullable": true
},
"additional_input": {
"description": "Input parameters for the task step. Any value is allowed.",
Expand All @@ -1298,7 +1407,8 @@
"input": {
"description": "Input prompt for the step.",
"type": "string",
"example": "Write the words you receive to the file 'output.txt'."
"example": "Write the words you receive to the file 'output.txt'.",
"nullable": true
},
"additional_input": {
"description": "Input parameters for the task step. Any value is allowed.",
Expand Down
81 changes: 81 additions & 0 deletions schemas/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,27 @@ paths:
get:
operationId: listAgentTasksIDs
summary: List all tasks that have been created for the agent.
parameters:
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned list of agent's task IDs.
Expand Down Expand Up @@ -94,6 +115,26 @@ paths:
x-postman-variables:
- type: load
name: task_id
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned list of agent's steps for the specified task.
Expand Down Expand Up @@ -200,6 +241,26 @@ paths:
x-postman-variables:
- type: load
name: task_id
- name: current_page
in: query
description: Page number
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 2
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
format: int32
default: 10
minimum: 1
example: 25
responses:
'200':
description: Returned the list of artifacts for the task.
Expand Down Expand Up @@ -283,6 +344,25 @@ paths:
- agent
components:
schemas:
Pagination:
type: object
properties:
total_items:
description: Total number of items.
type: integer
example: 42
total_pages:
description: Total number of pages.
type: integer
example: 97
current_page:
description: Current_page page number.
type: integer
example: 1
page_size:
description: Number of items per page.
type: integer
example: 25
TaskStepsListResponse:
description: A list of step IDs for the task
type: array
Expand Down Expand Up @@ -399,6 +479,7 @@ components:
description: Input prompt for the step.
type: string
example: Write the words you receive to the file 'output.txt'.
nullable: true
Copy link
Collaborator Author

@waynehamadi waynehamadi Aug 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't want to add an RFC just for that: people don't necessarilly want to put an input here, so let's make it clear when something is nullable or not.

additional_input:
$ref: '#/components/schemas/StepInput'
Step:
Expand Down