Skip to content

Commit cdcd500

Browse files
authored
Fix Neo task entities (#16542)
* Fix Neo task entities * Call out PR entities
1 parent 44ebb31 commit cdcd500

File tree

1 file changed

+11
-7
lines changed
  • content/docs/reference/cloud-rest-api/neo

1 file changed

+11
-7
lines changed

content/docs/reference/cloud-rest-api/neo/_index.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ POST /api/preview/agents/{orgName}/tasks
6969
| `message.type` | string | Yes | Type of event (must be "user_message") |
7070
| `message.content` | string | Yes | The exact natural language instruction from the user |
7171
| `message.timestamp` | string (ISO 8601) | Yes | When the event occurred |
72-
| `message.entity_diff` | object | No | Entities to add or remove from the agent. See [Entity Types](#entity-types) for details |
72+
| `message.entity_diff` | object | No | Entities to add or remove from the agent. See [Entity Types](#entity-types) for details. Note: Pull request entities cannot be added via this API. |
7373

7474
### Example
7575

@@ -393,7 +393,7 @@ Send a user message event to provide additional instructions or responses to the
393393
| `type` | string | Yes | Must be "user_message" |
394394
| `content` | string | Yes | The user's response or additional instructions |
395395
| `timestamp` | string (ISO 8601) | Yes | When the event occurred |
396-
| `entity_diff` | object | No | Entities to add or remove from the agent context |
396+
| `entity_diff` | object | No | Entities to add or remove from the agent context. See [Entity Types](#entity-types) for details. Note: Pull request entities cannot be added via this API. |
397397

398398
### User Confirmation Event
399399

@@ -471,7 +471,7 @@ Represents a source code repository that the agent can analyze and work with.
471471
{
472472
"type": "repository",
473473
"name": "my-repo",
474-
"owner": "my-org",
474+
"org": "my-org",
475475
"forge": "github"
476476
}
477477
```
@@ -482,22 +482,25 @@ Represents a source code repository that the agent can analyze and work with.
482482
|-------|------|----------|-------------|
483483
| `type` | string | Yes | Must be "repository" |
484484
| `name` | string | Yes | The name of the repository |
485-
| `owner` | string | Yes | The owner of the repository |
485+
| `org` | string | Yes | The organization owning the repository |
486486
| `forge` | string | Yes | The forge/provider where the repository is hosted (e.g., "github") |
487487

488488
### Pull Request Entity
489489

490490
Represents a pull request that the agent can analyze and work with.
491491

492+
**Note**: Pull request entities cannot be added using the create task or respond to task APIs. They are managed by the system and associated with tasks through other mechanisms.
493+
492494
```json
493495
{
494496
"type": "pull_request",
495497
"number": 123,
496498
"repository": {
497499
"name": "my-repo",
498-
"owner": "my-org",
500+
"org": "my-org",
499501
"forge": "github"
500-
}
502+
},
503+
"merged": true
501504
}
502505
```
503506

@@ -507,9 +510,10 @@ Represents a pull request that the agent can analyze and work with.
507510
|-------|------|----------|-------------|
508511
| `type` | string | Yes | Must be "pull_request" |
509512
| `number` | integer | Yes | The pull request number |
513+
| `merged` | boolean | Yes | If the PR has been merged already |
510514
| `repository` | object | Yes | The repository information |
511515
| `repository.name` | string | Yes | The name of the repository |
512-
| `repository.owner` | string | Yes | The owner of the repository |
516+
| `repository.org` | string | Yes | The organization owning the repository |
513517
| `repository.forge` | string | Yes | The forge/provider where the repository is hosted |
514518

515519
### Policy Issue Entity

0 commit comments

Comments
 (0)