docs(schema): add Schema#paths docs to public API docs

Fix #8340
Automattic · Nov 16, 2019 · a821c30 · a821c30
1 parent 10bb6ed
commit a821c30
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/lib/schema.js b/lib/schema.js
@@ -235,15 +235,17 @@ Object.defineProperty(Schema.prototype, 'childSchemas', {
 Schema.prototype.obj;
 
 /**
- * Schema as flat paths
+ * The paths defined on this schema. The keys are the top-level paths
+ * in this schema, and the values are instances of the SchemaType class.
  *
  * ####Example:
- *     {
- *         '_id'        : SchemaType,
- *       , 'nested.key' : SchemaType,
- *     }
+ *     const schema = new Schema({ name: String }, { _id: false });
+ *     schema.paths; // { name: SchemaString { ... } }
+ * 
+ *     schema.add({ age: Number });
+ *     schema.paths; // { name: SchemaString { ... }, age: SchemaNumber { ... } }
  *
- * @api private
+ * @api public
  * @property paths
  * @memberOf Schema
  * @instance