サンプルから JSON schema を生成する

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/commands/generate_schema

tokenAuth

コレクション内のドキュメントのサブセットをサンプリングして JSON スキーマを生成します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
serviceId string 必須

サービスのユニークな _id 値。

application/ JSON

body 必須

database_name string 必須

コレクションを含むデータベースの名前。
collection_name string 必須

サンプリングしてスキーマを生成するコレクションの名前。
limit integer 必須

サンプルに含めるドキュメントの最大数。

応答

200 application/ JSON

スキーマが正常に生成されました
応答属性を非表示応答属性の表示オブジェクト
- スキーマオブジェクト
  
  生成されたJSON スキーマ

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/commands/generate_schema

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/commands/generate_schema' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"database_name":"string","collection_name":"string","limit":42}'

リクエスト例

{
  "database_name": "string",
  "collection_name": "string",
  "limit": 42
}

応答の例（200）

{
  "schema": {}
}