fusion-help-api

Name: fusion-help-api
Author: equinor

github.com/equinor開発915 回インストール

リポジトリ

fusion-help-api について

Fusion Help REST API でヘルプコンテンツを読み取り、検索、管理する開発者や管理者向けのガイドです。認証、権限、バージョン付きエンドポイント、連携例を扱い、アプリ内ヘルプや管理の自動化に役立ちます。

主な機能

01記事、FAQ、リリースノートの取得
02ヘルプコンテンツの検索と提案
03コンテンツの作成・更新・削除
04アセットと変更履歴の管理
05認証、権限、エンドポイントの確認

活用シーン

01Fusion アプリでヘルプを表示
02コンテンツ管理 CLI の構築
03ヘルプ文書の管理を自動化
04アプリへのヘルプ検索の追加

MCP 対応

Fusion Help REST API の呼び出し方法を説明します。入力には MCP 連携の記載はありません。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/equinor/fusion-skills --skill fusion-help-api

インストール後、Claude Code で/fusion-help-apiを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

CHANGELOG.md

references/

api-endpoints.md

api-quick-reference.md

authentication.md

integration-patterns.md

response-models.md

詳細

Fusion Help API

開発者や管理者が、ヘルプコンテンツの閲覧、カスタムツールの構築、コンテンツ管理の自動化などを目的として、Fusion Help REST API と直接やり取りする必要がある場合に使用します。

使用する場面

Fusion アプリ内にヘルプ記事、FAQ、リリースノートを表示する
ヘルプコンテンツを管理するカスタム CLI や自動化を構築する
ヘルプドキュメントをプログラムで作成、更新、削除する
アプリケーションからヘルプコンテンツを検索または提案する
Help API のエンドポイント、認証、データモデルについて理解する
別のシステムのヘルプコンテンツを読む

使用しない場面

fhelp CLI を使用して Markdown ドキュメントを同期する → fusion-help-docs を使用してください
Fusion.Services.Help バックエンドサービスのコードを変更する
Help に関係しない一般的な REST API に関する質問

必要な入力

入力	必須	説明
ユースケース	はい	コンテンツの閲覧、管理、検索
アプリキー	範囲を限定したクエリの場合	ヘルプの閲覧または管理対象となる Fusion アプリのキー
対象環境	はい	`ci`、`fqa`、`tr`、または `fprd`
認証コンテキスト	はい	ユーザートークン（対話型）またはサービスプリンシパル（自動化）

手順

1. Help API のベース URL を特定する

URL を動的に解決するか、既知のパターンを使用します。

環境	ベース URL
`ci`	`https://help.ci.api.fusion-dev.net`
`fqa`	`https://help.fqa.api.fusion-dev.net`
`fprd`	`https://help.api.fusion.equinor.com`

動的な検出（本番環境のツールで推奨）：

GET https://discovery.fusion.equinor.com/service-registry/environments/{env}/services

応答から key: "help" のサービスを探します。ベース URL として uri フィールドを使用します。

2. 認証

すべてのエンドポイントで、有効な Azure AD ベアラートークンが必要です。フロントエンド、バックエンド、CLI 向けのトークンオーディエンスとコードサンプルは、references/authentication.md にあります。

クイックリファレンス — トークンオーディエンス：

環境	リソース ID（オーディエンス）
`ci`、`fqa`、`tr`	`5a842df8-3238-415d-b168-9f16a6a6031b/.default`
`fprd`	`97978493-9777-4d48-b38a-67b0b9cd88d2/.default`

3. 認可レベル

操作	実行できるユーザー
記事、FAQ、リリースノートの閲覧、検索	認証済みの Fusion ユーザー
記事、FAQ、リリースノートの作成／更新／削除	アプリ管理者、信頼済みアプリ、または `Fusion.Help.FullControl`
アセット（画像）のアップロード	アプリ管理者、信頼済みアプリ、または `Fusion.Help.FullControl`
変更履歴の表示（全体）	`Fusion.Help.FullControl` のみ
変更履歴の表示（アプリごと）	アプリ管理者または `Fusion.Help.FullControl`

4. API を呼び出す

エンドポイントにはバージョンが指定されているため、?api-version=1.0 を含めます。リソース：記事、FAQ、リリースノート、アセット、検索／提案、変更履歴。

CRUD の詳細、リクエスト／レスポンスの本文、OData フィルター、検証ルールについては、references/api-endpoints.md を参照してください。

エンドポイントの簡潔な一覧と OData チートシートについては、references/api-quick-reference.md を参照してください。

レスポンスモデルのスキーマについては、references/response-models.md を参照してください。

5. 統合パターン

すぐに使えるコードサンプル（React コンポーネント、リリースノートバナー、FAQ 検索、C# バックエンドの自動化、Python スクリプト）は、references/integration-patterns.md にあります。

想定される出力

認証して Help API を呼び出すための動作するコード
ユースケースに合った正しいエンドポイント URL とクエリパラメーター
レスポンスモデルと OData クエリオプションについての理解
管理者向けのユースケースの場合：作成／更新／削除に適したリクエスト本文
統合パターンの場合：該当する言語／フレームワークのサンプルコード

安全性と制約

読み取り専用のエンドポイントは、認証済みユーザーであれば誰でも安全に使用できます。管理者権限は不要です。
書き込み操作には、アプリ管理者、信頼されたアプリ、または Fusion.Help.FullControl が必要です。
削除された記事／FAQ／リリースノートは論理削除されます。スラッグは再利用できません。
sourceSystem は、どのツールがレコードを作成したかを追跡します。同じスラッグに異なるソースシステムを混在させると、fhelp CLI は更新を拒否します（--no-validation を使用した場合を除く）。
fprd を対象にする前に、必ず ci でテストしてください。
ベアラートークンをハードコードしないでください。DefaultAzureCredential または同等の方法を使用してください。
画像のアップロード形式は PNG である必要があります。API は配信用に画像を WebP に変換します。

Markdown 対応

ログインしてコメント

基本情報

作者: equinor
リポジトリ: equinor/fusion-skills
カテゴリ: 開発
インストール数: 915

問題を報告

おすすめの Skills

すべての Skills

remotion-render

github.com/inference-sh

1.6M

inference.sh を介して React/Remotion コンポーネントコードから動画をレンダリングします。TSX コードを渡すと MP4 を取得できます。useCurrentFrame、useVideoConfig、spring、interpolate、AbsoluteFill、Sequence など、すべての Remotion API に対応します。解像度、FPS、長さ、コーデックを設定できます。用途：プログラムによる動画生成、アニメーショングラフィック、モーションデザイン、データ駆動型動画、React アニメーションの動画化。トリガー：remotion、render video from code、tsx to video、react video、programmatic video、remotion render、code to video、animated video、motion graphics code、react animation video

improve-codebase-architecture

github.com/mattpocock

1.2M

コードベースをスキャンして改善の機会を探し、ビジュアル HTML レポートとして提示し、選択したものを詳しく掘り下げる。

design-mobile-apps

github.com/designed-by-ai

1.1M

Sleek でモバイルアプリの画面をデザインし、Sleek プロジェクトを編集して、React Native または HTML でデザインを実装します。

vercel-react-best-practices

github.com/vercel-labs

848.6k

Vercel Engineering の React および Next.js パフォーマンス最適化ガイドライン。React / Next.js コードを記述、レビュー、またはリファクタリングするときに、最適なパフォーマンスパターンを確保するため、このスキルを使用する必要があります。React コンポーネント、Next.js ページ、データ取得、バンドル最適化、またはパフォーマンス改善を含むタスクで発火します。