Generate a JSON schema from sample

publicación /groups/{groupId}/apps/{appId}/services/{serviceId}/commands/generate_schema

Token auth

Sample a subset of documents in a collection to generate a JSON schema.

Parámetros de path

ID del grupo string Requerido

An Atlas Project/Group ID.
appId string Requerido

El ObjectID de tu aplicación. La sección de ID de Proyecto y ID de la aplicación de App Services API muestra cómo encontrar este valor.
serviceId string Requerido

The unique _id value of a service.

aplicación/json

Cuerpo Requerido

nombre_de_la_base_de_datos string Requerido

El nombre de la base de datos que contiene la colección.
nombre_colección string Requerido

The name of the collection to sample and generate a schema for.
limit entero Requerido

The maximum number of documents to include in the sample.

Respuestas

200 aplicación/json

Successfully generated schema
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- esquema Objeto
  
  The generated JSON schema

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}'

Solicitar ejemplos

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

Ejemplos de respuestas (200)

{
  "schema": {}
}