API Reference

Introduction

ContentSpace、Asset upload、Indexing、Direct Search の公開 schema-only 契約。認証済み主体から SecurityContext を解決する処理は Gateway runtime が担う。

Schema preview / 現在は一般提供されていません

17 operationはOpenAPIでschema-onlyとして公開されています。このReferenceからAPI requestは送信できません。

REST API

公開契約のversionは1.0です。環境別Base URLはheaderに表示されます。

P0 の公開 API key。credential は Gateway edge で消費し、backend へ転送しない。

Header名はX-Api-Keyです。詳細は認証と環境を参照してください。

各endpointページにOpenAPI由来の成功responseとerror responseを掲載します。request相関にはX-Request-Idを使用します。

v1PublicError

PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。

Field	Type	Description
code	string	code は公開 API で安定した machine-readable error code である。
message	string	message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。
requestId	string	request_id は response header の X-Request-Id と同じ要求相関 ID である。
docsUrl	string	docs_url は関連する公開文書が存在する場合だけ設定する URL である。
quotaExceeded	v1PublicQuotaExceeded	quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。