Skip to content

Add SchemaObjectSnippet #6684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
magaldima opened this issue Apr 7, 2025 · 0 comments
Open

Add SchemaObjectSnippet #6684

magaldima opened this issue Apr 7, 2025 · 0 comments

Comments

@magaldima
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant