注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
入力のAPI名
入力のAPI名は、公開 Marketplace API で製品の入力を識別するための名前です。呼び出し元は、これらの安定した名前を使って入力を見つけ、インストールやアップグレードの値を指定し、インストールの現在の入力を確認します。詳細については、Marketplace インストール API リファレンスを参照してください。
各入力のAPI名は表示タイトルとは別で、製品のバージョンが変わっても保持されます。製品のバージョンに入力がある場合は、Foundry API を通じてインストールできるように公開する前に、API名の生成を有効にしてください。
API名を有効にする
製品を作成するときや新しいバージョンを準備するときに名前を生成するには、次の手順を実行します。
- 製品のドラフトで設定を開きます。
- Foundry API 設定を見つけ、入力のAPI名を有効にするを有効にします。
DevOps は入力のタイトルに基づいて自動的に名前を割り当てます。たとえば、「ソースデータセット」というタイトルの入力には、sourceDataset というAPI名が割り当てられることがあります。
名前を確認してカスタマイズする
入力値テーブルで入力を選択して詳細パネルを開き、API名の値を選択して編集します。呼び出し元が理解できる、わかりやすい名前を選びます。
名前をカスタマイズするときは、次のルールに従ってください。
- 1～100文字を使用します。
- 先頭は文字またはアンダースコアとし、その後は文字、数字、またはアンダースコアを使用します。Unicode 識別子がサポートされており、NFKC 正規化を使用する必要があります。
- 大文字と小文字を問わず、予約済みキーワードの
y、n、yes、no、true、false、on、off、nullは使用しません。 - 最上位の入力同士、および同じ親を持つネストされた入力同士には、それぞれ異なる名前を使用します。
公開 API は、親の名前を含むドット区切りの名前を使って、ネストされた入力を参照します。たとえば、sourceDataset 配下の customerId 列は、sourceDataset.customerId として参照されます。列自体のAPI名は customerId に設定します。親の名前は API が追加します。
複数の名前をまとめて編集するには、複数の入力を選択し、{N}個のAPI名を設定を選択します。{N} は選択した入力の数です。変更内容を確認し、保存を選択します。
オントロジーのAPI名
入力のAPI名は、製品内の入力を識別します。入力プリセットで使用されるオントロジーリソースのAPI名は、それらの入力に指定されるリソースを識別します。
API名の安定性
新しい製品バージョンでは、以前に公開された入力のAPI名が保持されるため、呼び出し元は既存の入力マップを引き続き使用できます。
公開済みの入力のAPI名を変更したり、入力のAPI名を有効にするを無効にしたりすると、既存のワークフローが動作しなくなる可能性があります。生成を無効にすると、ドラフトバージョンに割り当てられたすべての名前がクリアされます。
いずれかの変更を行った場合、公開ダイアログでは、続行する前に潜在的な影響を了承する必要があります。呼び出し元が動作しなくなるのを避けるには、公開前に以前の名前に戻すか、生成を再度有効にしてください。
