Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,21 @@ If you're looking to contribute to the developer documentation itself, see https
1. `npm install` on first usage
2. `git submodule update --init` to install submodules
3. `npm start` to open in dev mode

### Ads API reference

The V2 Ads API reference is generated from the commit-pinned `openapi.json` in
`Dolby-OptiView/optiview-ads`. The generated MDX pages are committed, but the
fetched spec is not. Private GitHub fetches require `ADS_OPENAPI_TOKEN`,
`GITHUB_TOKEN`, or `GH_TOKEN` with `contents:read` access to `optiview-ads`.

To refresh the published contract, update `DEFAULT_SPEC_REF` in
`scripts/fetch-ads-openapi.mjs`, then run:

```bash
npm run refresh-ads-api-docs
npm run build
```

Use `ADS_OPENAPI_REF` to validate another remote commit or branch, or
`ADS_OPENAPI_SPEC_URL=/path/to/openapi.json` for a local checkout.
Loading
Loading