Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/activities/{index}/{source}/{id}/ai_assistance
title: Retrieve Event AI Assistance
---
---

import PermissionReadAll from '/snippets/permission-read-all.mdx'

<PermissionReadAll />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/activities/
title: Retrieve Event
---

import PermissionReadAll from '/snippets/permission-read-all.mdx'

<PermissionReadAll />

This response changes based on the event type, for more information the various possible responses, see
[Event Types <Icon icon="book" size={16} />](/event-types/overview).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi delete /firework/v2/assets/{asset_id}/alerts/{alert_id}
title: Delete Identifier Alerts
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi delete /firework/v2/assets/{asset_id}
title: Delete Identifier
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/identifiers/\{identifier_id\} <Icon icon="code" size={16} />](/api-reference/v4/endpoints/delete-identifier)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi delete /firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}
title: Delete Identifier Group Alert
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi delete /firework/v2/assets/groups/{assets_group_id}
title: Delete Identifier Group
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/assets/{asset_id}/alerts
title: List Identifier Alerts
---
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/assets/{asset_id}/feed
title: List Identifier Events
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/events/identifiers/\{identifier_id\}/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/identifier-feed)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id}
title: Retrieve Identifier Group
---
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id}/alerts
title: List Identifier Group Alerts
---
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id}/fe
title: List Identifier Groups Events
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/events/identifier_groups/\{identifier_group_id\}/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/identifier-group-feed)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/assets/groups/
title: List Identifier Groups
---
---

import PermissionReadTenant from '/snippets/permission-read-tenant.mdx'

<PermissionReadTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/assets/{asset_id}/alerts
title: Create Identifier Alert
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi post /firework/v2/assets/{asset_id}/toggle
title: Enable/Disable Identifier
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/identifiers/\{identifier_id\} <Icon icon="code" size={16} />](/api-reference/v4/endpoints/update-identifier)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi post /firework/v2/assets/
title: Create Identifier
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/identifiers/ <Icon icon="code" size={16} />](/api-reference/v4/endpoints/create-identifier)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/assets/groups/{assets_group_id}/alerts
title: Create Identifier Group Alerts
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/assets/groups/
title: Create Identifier Groups
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi put /firework/v2/assets/{asset_id}/alerts/{alert_id}
title: Update Identifier Alert
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi put /firework/v2/assets/{asset_id}
title: Update Identifier
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/identifiers/\{identifier_id\} <Icon icon="code" size={16} />](/api-reference/v4/endpoints/update-identifier)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi put /firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id}
title: Update Identifier Group Alert
---
---

import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx'

<PermissionWriteTenant />
4 changes: 4 additions & 0 deletions docs/api-reference/v2/endpoints/me/get-fireworkv2mefeed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/me/feed
title: List Tenant Events
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />

<Warning>
**DEPRECATED:** This endpoint should be replaced by
[/firework/v4/events/tenant/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/current-tenant-feed)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@ openapi: firework-v2-openapi get /firework/v2/me/feed/credentials
title: List Tenant Credentials
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />

This endpoint will list all credentials that match the current tenant's monitored identifiers.
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/me/profile
title: Retrieve User Profile
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/me/tenants
title: List User Tenants
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi put /firework/v2/me/profile
title: Update User Profile
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would expect a PUT to require WRITE, but a READ is required instead to allow regular users to edit their profile settings


<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members/{user_id}
title: Retrieve Organization Member
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members/{user_id}/tenants
title: List Organization Member Tenants
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members
title: List Organization Members
---
---

import PermissionReadOrganization from '/snippets/permission-read-organization.mdx'

<PermissionReadOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/tenants
title: List Organization Tenants
---
---

import PermissionReadOrganizationAdmin from '/snippets/permission-read-organization-admin.mdx'

<PermissionReadOrganizationAdmin />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/disable
title: Disable Organization Member
---
---

import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx'

<PermissionWriteOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/enable
title: Enable Organization Member
---
---

import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx'

<PermissionWriteOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/permissions
title: Update Organization Member Permissions
---
---

import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx'

<PermissionWriteOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members
title: Create Organization Member
---
---

import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx'

<PermissionWriteOrganization />
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/tenants
title: Create Organization Tenant
---
---

import PermissionWriteOrganizationAdmin from '/snippets/permission-write-organization-admin.mdx'

<PermissionWriteOrganizationAdmin />
Loading
Loading