guardian/content-api-models

Content-api thrift models

Content API Thrift models

Version Info

17.0.0

• This release imports the sbt-scrooge-typescript 1.4.0 sbt plugin which has the potential to introduce some breaking changes for generated typescript mappings via thrift 0.13.0, specifically related to the handling of Int64 data.

Publishing a new release

This repo uses gha-scala-library-release-workflow to automate publishing releases (both full & preview releases) - see Making a Release.

Information about built bundles

The content-api-models project builds the following bundles:

• content-api-models-scala - A jar containing Scrooge generated class files based on the Thrift definitions of the content api models found in the content-api-models dependency.

• content-api-models-json - A jar containing Json serializers and deserializers. Used internally by the content api and also by the content-api-scala-client to convert from Elasticsearch returned json to the Scrooge-generated Thrift classes. As a client you should never need to depend on this explicitly, although you may have a transitive dependency on it if using the content-api-scala-client.

• content-api-models - A jar containing the Thrift definitions of the content api models only. As a client it is unlikely that you should ever need to depend on this but rather use the content-api-models-scala dependency instead.

• @guardian/content-api-models - An npm package containing the generated models and their type definitions.

Publishing locally

To publish a snapshot version locally.

sbt +publishLocal

content-api-models's Issues

Add minimal docs to the NPM library

It could help adoption by JS consumers.

---

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

Fixing StackOverflow errors on release

Set the following in your /usr/local/etc/sbtopts:

# set memory options
#
-mem   4000

and

# extra arguments to try to fix broken sbt release on models
-J-XX:MaxMetaspaceSize=1G

# sets the stack size
-J-Xss2M

Wrong type for `Content.asset`

There’s an issue in the asset type in @guardian/content-api-models/v1/content. The type is declared as an enum, when in fact it is a string that can be "image".

@Fweddi and I discovered this while building the-guesser: https://github.com/guardian/the-guesser/blob/3396e20149eb737492ae0cd8646a7adab1425ed8/vite-project/src/logic/extractors/extractMasterImageFile.ts#L8-L9