Skip to content

docs: align schema URL/requirements and validation guidance; bump to … #5

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.

Sign up for GitHub

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

Merged
osmandkitay merged 1 commit into from
Jan 19, 2026
Merged

docs: align schema URL/requirements and validation guidance; bump to … #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 14 additions & 12 deletions MANIFEST_VALIDATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,29 @@ AURA manifest validation ensures your `aura.json` file:

```bash
# Install AURA protocol package
npm install -g @aura/protocol
npm install aura-protocol

# Validate local manifest
aura-validate .well-known/aura.json
npx -y -p aura-protocol aura-validate .well-known/aura.json

# Validate remote manifest
aura-validate --url https://example.com/.well-known/aura.json
# Note: Remote URL validation (--url) is currently disabled.
# Download the manifest first, then validate locally:
curl -fsSL https://example.com/.well-known/aura.json -o aura.json
npx -y -p aura-protocol aura-validate aura.json

# Detailed validation
aura-validate --verbose .well-known/aura.json
npx -y -p aura-protocol aura-validate --verbose .well-known/aura.json

# Machine-readable output
aura-validate --json .well-known/aura.json
npx -y -p aura-protocol aura-validate --json .well-known/aura.json
```

### Programmatic Validation

```typescript
import Ajv from 'ajv';
import addFormats from 'ajv-formats';
import { AuraManifest } from '@aura/protocol';
import { AuraManifest } from 'aura-protocol';

// Setup validator
const ajv = new Ajv({ allErrors: true, strict: false });
Expand All @@ -54,7 +56,7 @@ function validateManifest(manifest: any): { valid: boolean; errors: any[] } {
### Core Manifest Structure

**Required Fields:**
- [ ] `$schema`: Schema URL (`https://aura.dev/schemas/v1.0.json`)
- [ ] `$schema`: Schema URL (use `https://unpkg.com/aura-protocol@1.0.4/dist/aura-v1.0.schema.json` or bundled schema)
- [ ] `protocol`: Must be `"AURA"`
- [ ] `version`: Must be `"1.0"`
- [ ] `site`: Site information object
Expand Down Expand Up @@ -106,7 +108,7 @@ Each capability must have:
**Solution:**
```json
{
"$schema": "https://aura.dev/schemas/v1.0.json",
"$schema": "https://unpkg.com/aura-protocol@1.0.4/dist/aura-v1.0.schema.json",
"protocol": "AURA",
"version": "1.0"
}
Expand Down Expand Up @@ -237,12 +239,12 @@ jobs:
node-version: '18'

- name: Install dependencies
run: npm install -g @aura/protocol
run: npm install aura-protocol

- name: Validate manifest
run: |
aura-validate public/.well-known/aura.json
aura-validate --verbose public/.well-known/aura.json
npx -y -p aura-protocol aura-validate public/.well-known/aura.json
npx -y -p aura-protocol aura-validate --verbose public/.well-known/aura.json
```

## 🔧 Advanced Validation
Expand Down
Loading