fern icon indicating copy to clipboard operation
fern copied to clipboard

Add SchemaObjectSnippet

Open magaldima opened this issue 10 months ago • 0 comments

Which Fern component?

Fern Docs

How important is this?

P2 - Medium (Would be helpful)

What's the feature?

Add a built-in snippet that allows "embedding" a schema Object into an mdx file similar to how EndpointResponseSnippet works but just prints out object description along with all fields and corresponding descriptions/required, etc..

Ideally, the component can render both an example in an Aside component as well as a list of ParamField components that are built/derived from the OpenAPI's schema object definition.

Example: Image

Any alternatives?

Manually define markdown file that duplicates descriptions and properties of the OpenAPI schema:

An `Organization` represents an operating nonprofit or an operating sub-organization of a parent or sponsoring nonprofit legal entity.

<Aside>
```json
{
    "id": "org_01j8rs605a4gctmbm58d87mvsj",
}

Attributes

The unique identifier for the object. ```

Are you interested in contributing this feature?

Yes

magaldima avatar Apr 07 '25 16:04 magaldima