Skip to content

A platform for community discussion. Free, open, simple.

DEV: Tidy plugin API key scope resource names (#38640)

Samf8666b60b0fe
diff --git a/app/controllers/admin/api_controller.rb b/app/controllers/admin/api_controller.rb
index acb48730665..b4c36533676 100644
--- a/app/controllers/admin/api_controller.rb
+++ b/app/controllers/admin/api_controller.rb
@@ -35,6 +35,7 @@ class Admin::ApiController < Admin::AdminController
scopes =
ApiKeyScope
.scope_mappings
+ .sort_by { |resource, _| resource.to_s }
.reduce({}) do |memo, (resource, actions)|
memo.tap do |m|
m[resource] = actions.map do |k, v|
diff --git a/app/models/api_key_scope.rb b/app/models/api_key_scope.rb
index 97af146ab83..adfaaf40da0 100644
--- a/app/models/api_key_scope.rb
+++ b/app/models/api_key_scope.rb
@@ -339,6 +339,8 @@ class ApiKeyScope < ActiveRecord::Base
end
def permits?(env)
+ return false if mapping.nil?
+
RouteMatcher.new(**mapping.except(:urls), allowed_param_values: allowed_parameters).match?(
env: env,
)
diff --git a/app/serializers/api_key_scope_serializer.rb b/app/serializers/api_key_scope_serializer.rb
index 3386ab387a4..a677ab71125 100644
--- a/app/serializers/api_key_scope_serializer.rb
+++ b/app/serializers/api_key_scope_serializer.rb
@@ -4,11 +4,11 @@ class ApiKeyScopeSerializer < ApplicationSerializer
attributes :resource, :action, :parameters, :urls, :allowed_parameters, :key
def parameters
- ApiKeyScope.scope_mappings.dig(object.resource.to_sym, object.action.to_sym, :params).to_a
+ ApiKeyScope.scope_mappings.dig(object.resource.to_sym, object.action.to_sym)&.dig(:params).to_a
end
def urls
- ApiKeyScope.scope_mappings.dig(object.resource.to_sym, object.action.to_sym, :urls).to_a
+ ApiKeyScope.scope_mappings.dig(object.resource.to_sym, object.action.to_sym)&.dig(:urls).to_a
end
def action
diff --git a/frontend/discourse/admin/components/admin-config-areas/api-keys-new.gjs b/frontend/discourse/admin/components/admin-config-areas/api-keys-new.gjs
index 3391b0efd1f..631dd197f86 100644
--- a/frontend/discourse/admin/components/admin-config-areas/api-keys-new.gjs
+++ b/frontend/discourse/admin/components/admin-config-areas/api-keys-new.gjs
@@ -195,7 +195,7 @@ export default class AdminConfigAreasApiKeysNew extends Component {
@action
scopesDataKeys(scopesData) {
- return Object.keys(scopesData);
+ return Object.keys(scopesData).sort();
}
<template>
diff --git a/plugins/automation/config/locales/client.en.yml b/plugins/automation/config/locales/client.en.yml
index f9b9cf95b47..56c3b1b610a 100644
--- a/plugins/automation/config/locales/client.en.yml
+++ b/plugins/automation/config/locales/client.en.yml
@@ -1,4 +1,11 @@
en:
+ admin_js:
+ admin:
+ api:
+ scopes:
+ descriptions:
+ automation:
+ trigger_automation: "Trigger an automation via the API"
js:
admin:
logs:
diff --git a/plugins/automation/db/migrate/20260316071735_rename_automation_api_key_scope_resource.rb b/plugins/automation/db/migrate/20260316071735_rename_automation_api_key_scope_resource.rb
new file mode 100644
index 00000000000..a2aaee3a1c2
--- /dev/null
+++ b/plugins/automation/db/migrate/20260316071735_rename_automation_api_key_scope_resource.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class RenameAutomationApiKeyScopeResource < ActiveRecord::Migration[8.0]
+ def up
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'automation'
+ WHERE resource = 'automations_trigger'
+ SQL
+
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET action = 'trigger_automation'
+ WHERE resource = 'automation' AND action = 'post'
+ SQL
+ end
+
+ def down
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET action = 'post'
+ WHERE resource = 'automation' AND action = 'trigger_automation'
+ SQL
+
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'automations_trigger'
+ WHERE resource = 'automation'
+ SQL
+ end
+end
diff --git a/plugins/automation/plugin.rb b/plugins/automation/plugin.rb
index 176a055667e..ba669dd9ce9 100644
--- a/plugins/automation/plugin.rb
+++ b/plugins/automation/plugin.rb
@@ -58,9 +58,9 @@ after_initialize do
add_admin_route "discourse_automation.title", "automation", use_new_show_route: true
add_api_key_scope(
- :automations_trigger,
+ :automation,
{
- post: {
+ trigger_automation: {
actions: %w[discourse_automation/automations#trigger],
params: %i[context],
formats: :json,
diff --git a/plugins/discourse-ai/config/locales/client.en.yml b/plugins/discourse-ai/config/locales/client.en.yml
index 76fabd9ca00..8080fd7b8f9 100644
--- a/plugins/discourse-ai/config/locales/client.en.yml
+++ b/plugins/discourse-ai/config/locales/client.en.yml
@@ -4,7 +4,7 @@ en:
api:
scopes:
descriptions:
- discourse_ai:
+ ai:
search: "Allows AI search"
stream_completion: "Allows streaming AI agent completions"
update_agents: "Allows updating AI agents"
diff --git a/plugins/discourse-ai/db/migrate/20260316071736_rename_ai_api_key_scope_resource.rb b/plugins/discourse-ai/db/migrate/20260316071736_rename_ai_api_key_scope_resource.rb
new file mode 100644
index 00000000000..7f8ae257e57
--- /dev/null
+++ b/plugins/discourse-ai/db/migrate/20260316071736_rename_ai_api_key_scope_resource.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class RenameAiApiKeyScopeResource < ActiveRecord::Migration[8.0]
+ def up
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'ai'
+ WHERE resource = 'discourse_ai'
+ SQL
+ end
+
+ def down
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'discourse_ai'
+ WHERE resource = 'ai'
+ SQL
+ end
+end
diff --git a/plugins/discourse-ai/lib/ai_bot/entry_point.rb b/plugins/discourse-ai/lib/ai_bot/entry_point.rb
index 0dd34b765b2..ea25bb41908 100644
--- a/plugins/discourse-ai/lib/ai_bot/entry_point.rb
+++ b/plugins/discourse-ai/lib/ai_bot/entry_point.rb
@@ -236,7 +236,7 @@ module DiscourseAi
plugin.register_editable_topic_custom_field(:ai_agent_id)
plugin.add_api_key_scope(
- :discourse_ai,
+ :ai,
{ stream_completion: { actions: %w[discourse_ai/admin/ai_agents#stream_reply] } },
)
diff --git a/plugins/discourse-ai/lib/embeddings/entry_point.rb b/plugins/discourse-ai/lib/embeddings/entry_point.rb
index c93b78929fe..1c625ee1577 100644
--- a/plugins/discourse-ai/lib/embeddings/entry_point.rb
+++ b/plugins/discourse-ai/lib/embeddings/entry_point.rb
@@ -69,7 +69,7 @@ module DiscourseAi
plugin.on(:post_edited, &callback)
plugin.add_api_key_scope(
- :discourse_ai,
+ :ai,
{ search: { actions: %w[discourse_ai/embeddings/embeddings#search] } },
)
diff --git a/plugins/discourse-ai/plugin.rb b/plugins/discourse-ai/plugin.rb
index 2c637934087..1005cb48886 100644
--- a/plugins/discourse-ai/plugin.rb
+++ b/plugins/discourse-ai/plugin.rb
@@ -134,13 +134,10 @@ after_initialize do
end
end
- add_api_key_scope(
- :discourse_ai,
- { update_agents: { actions: %w[discourse_ai/admin/ai_agents#update] } },
- )
+ add_api_key_scope(:ai, { update_agents: { actions: %w[discourse_ai/admin/ai_agents#update] } })
add_api_key_scope(
- :discourse_ai,
+ :ai,
{
manage_artifacts: {
actions: %w[
diff --git a/plugins/discourse-ai/spec/integration/custom_api_key_scopes_spec.rb b/plugins/discourse-ai/spec/integration/custom_api_key_scopes_spec.rb
index 7bdad2df278..a205ecb22bc 100644
--- a/plugins/discourse-ai/spec/integration/custom_api_key_scopes_spec.rb
+++ b/plugins/discourse-ai/spec/integration/custom_api_key_scopes_spec.rb
@@ -1,6 +1,6 @@
# frozen_string_literal: true
-describe "API keys scoped to discourse_ai#manage_artifacts" do
+describe "API keys scoped to ai#manage_artifacts" do
before { SiteSetting.discourse_ai_enabled = true }
fab!(:admin)
@@ -9,7 +9,7 @@ describe "API keys scoped to discourse_ai#manage_artifacts" do
let(:api_key) do
key = ApiKey.create!
- ApiKeyScope.create!(resource: "discourse_ai", action: "manage_artifacts", api_key_id: key.id)
+ ApiKeyScope.create!(resource: "ai", action: "manage_artifacts", api_key_id: key.id)
key
end
diff --git a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
index 87ee8b8e3a8..d6891933a3d 100644
--- a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
+++ b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
@@ -320,7 +320,7 @@ RSpec.describe DiscourseAi::Admin::AiAgentsController do
scope =
ApiKeyScope.create!(
- resource: "discourse_ai",
+ resource: "ai",
action: "update_agents",
api_key_id: api_key.id,
allowed_parameters: {
diff --git a/plugins/discourse-ai/spec/requests/embeddings/embeddings_controller_spec.rb b/plugins/discourse-ai/spec/requests/embeddings/embeddings_controller_spec.rb
index fddac16a5b9..3f0b8bdb0d3 100644
--- a/plugins/discourse-ai/spec/requests/embeddings/embeddings_controller_spec.rb
+++ b/plugins/discourse-ai/spec/requests/embeddings/embeddings_controller_spec.rb
@@ -44,7 +44,7 @@ describe DiscourseAi::Embeddings::EmbeddingsController do
def create_api_key(user)
key = ApiKey.create!(user: user)
- ApiKeyScope.create!(resource: "discourse_ai", action: "search", api_key_id: key.id)
+ ApiKeyScope.create!(resource: "ai", action: "search", api_key_id: key.id)
key
end
diff --git a/plugins/discourse-data-explorer/config/locales/client.en.yml b/plugins/discourse-data-explorer/config/locales/client.en.yml
index cb8ba055cc0..dace49b86c6 100644
--- a/plugins/discourse-data-explorer/config/locales/client.en.yml
+++ b/plugins/discourse-data-explorer/config/locales/client.en.yml
@@ -107,7 +107,7 @@ en:
api:
scopes:
descriptions:
- discourse_data_explorer:
+ data_explorer:
run_queries: "Run Data Explorer queries. Restrict the API key to a set of queries by specifying queries IDs."
discourse_automation:
scriptables:
diff --git a/plugins/discourse-data-explorer/db/migrate/20260316071737_rename_data_explorer_api_key_scope_resource.rb b/plugins/discourse-data-explorer/db/migrate/20260316071737_rename_data_explorer_api_key_scope_resource.rb
new file mode 100644
index 00000000000..e450b356098
--- /dev/null
+++ b/plugins/discourse-data-explorer/db/migrate/20260316071737_rename_data_explorer_api_key_scope_resource.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class RenameDataExplorerApiKeyScopeResource < ActiveRecord::Migration[8.0]
+ def up
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'data_explorer'
+ WHERE resource = 'discourse_data_explorer'
+ SQL
+ end
+
+ def down
+ execute <<~SQL
+ UPDATE api_key_scopes
+ SET resource = 'discourse_data_explorer'
+ WHERE resource = 'data_explorer'
+ SQL
+ end
+end
diff --git a/plugins/discourse-data-explorer/plugin.rb b/plugins/discourse-data-explorer/plugin.rb
index 06f6794c9f5..3b395e09bc0 100644
--- a/plugins/discourse-data-explorer/plugin.rb
+++ b/plugins/discourse-data-explorer/plugin.rb
@@ -68,7 +68,7 @@ after_initialize do
register_bookmarkable(DiscourseDataExplorer::QueryGroupBookmarkable)
add_api_key_scope(
- :discourse_data_explorer,
+ :data_explorer,
{
run_queries: {
actions: %w[discourse_data_explorer/query#run discourse_data_explorer/query#public_run],
diff --git a/plugins/discourse-data-explorer/spec/integration/custom_api_key_scopes_spec.rb b/plugins/discourse-data-explorer/spec/integration/custom_api_key_scopes_spec.rb
index e7fdffb798c..4883cd9e6bc 100644
--- a/plugins/discourse-data-explorer/spec/integration/custom_api_key_scopes_spec.rb
+++ b/plugins/discourse-data-explorer/spec/integration/custom_api_key_scopes_spec.rb
@@ -13,18 +13,14 @@ describe "API keys scoped to query#run" do
let(:all_queries_api_key) do
key = ApiKey.create!
- ApiKeyScope.create!(
- resource: "discourse_data_explorer",
- action: "run_queries",
- api_key_id: key.id,
- )
+ ApiKeyScope.create!(resource: "data_explorer", action: "run_queries", api_key_id: key.id)
key
end
let(:single_query_api_key) do
key = ApiKey.create!
ApiKeyScope.create!(
- resource: "discourse_data_explorer",
+ resource: "data_explorer",
action: "run_queries",
api_key_id: key.id,
allowed_parameters: {