yap.app.json reference
Stub. See the Market & Apps spec § 3 for the canonical schema while this page is being filled in.
A single JSON file at the root of your app’s repo. The CLI publishes this file plus its referenced bundle.
Required fields
| Field | Type | Notes |
|---|---|---|
id | string | Globally unique. Reverse-DNS recommended. |
name | string | Human display name. |
slug | string | URL slug for /market/<slug>. |
version | semver string | Semantic version. |
publisher | string | Your publisher handle. |
category | enum | health, pm, reading, productivity, dev, other. |
tagline | string | ≤ 120 chars. |
description | string | Markdown body shown on the detail page. |
scopes | string[] | OAuth scopes the app requests at install. |
Example
{
"id": "fitness-app",
"name": "Fitness",
"slug": "fitness",
"version": "1.2.3",
"publisher": "lift-co",
"category": "health",
"tagline": "Track workouts, PRs, and routines as yaps.",
"scopes": ["yaps:read", "yaps:write", "tags:write", "goals:read", "goals:write", "routines:read"],
"pricing": { "model": "free" }
}