Skip to content

Sync OpenAPI Schema (18994) #496

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

Open
fingerprint-dx-team-actions-runner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Sync OpenAPI Schema (18994) #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions schemas/paths/event.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ patch:
When an event is created, it can be assigned `linked_id` and `tags` submitted through the JS agent parameters.
This information might not have been available on the client initially, so the Server API permits updating these attributes after the fact.

**Warning** It's not possible to update events older than one month.
**Warning** You can only update events created within the last 10 days. Updating an older event returns HTTP 400 with the message `event is too old to be updated (> 10 days)`, even if your plan retains events for longer.

**Warning** Events created by the Automation Intelligence API (`POST /edge`) cannot be updated. Updating them returns HTTP 400.

**Warning** Trying to update an event immediately after creation may temporarily result in an
error (HTTP 409 Conflict. The event is not mutable yet.) as the event is fully propagated across our systems. In such a case, simply retry the request.
Expand All @@ -154,7 +156,7 @@ patch:
'200':
description: OK.
'400':
description: Bad request. The request payload is not valid.
description: Bad request. The request payload is not valid, the event is older than 10 days, or the event cannot be updated.
content:
application/json:
schema:
Expand All @@ -163,6 +165,12 @@ patch:
example:
summary: Error response when the specified request payload is not valid and cannot be parsed.
externalValue: examples/errors/400_request_body_invalid.json
400-event-too-old:
summary: Error response when the event was created more than 10 days ago.
externalValue: examples/errors/400_event_too_old.json
400-edge-event-not-updatable:
summary: Error response when the event was created by the Automation Intelligence API and cannot be updated.
externalValue: examples/errors/400_edge_event_not_updatable.json
'403':
description: Forbidden. Access to this API is denied.
content:
Expand Down
6 changes: 6 additions & 0 deletions schemas/paths/examples/errors/400_edge_event_not_updatable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"error": {
"code": "failed",
"message": "edge events cannot be updated"
}
}
6 changes: 6 additions & 0 deletions schemas/paths/examples/errors/400_event_too_old.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"error": {
"code": "failed",
"message": "event is too old to be updated (> 10 days)"
}
}
Loading