guardian / guardian/content-api-models

Add minimal docs to the NPM library

Open
#235 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Scala
Stars
4
Forks
6
Avg merge
1h 15m
Merged PRs (30d)
1

Description

It could [help adoption by JS consumers](https://github.com/guardian/guardian-engineering-site/pull/213#issuecomment-1934225159).

---

> So this is how one use the models from content-api-models https://github.com/guardian/dotcom-rendering/blob/8c46c6b669b600b439c5585f99678fee75a7a451/apps-rendering/src/capi.ts#L6
>
> Basically you just import the model you would like
>
> The elements you can find are in the thrift file
https://github.com/guardian/content-api-models/blob/main/models/src/main/thrift/content/v1.thrift#L1897

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.