superbee 0.4.3-pre.9 → 0.4.4-pre.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/SKILL.md +2 -2
- package/dist/portable-export.mjs +2 -0
- package/dist/publication-bridge.mjs +839 -458
- package/dist/publication.mjs +774 -422
- package/dist/superbee.mjs +102961 -89239
- package/package.json +1 -2
- package/references/author-an-integration.md +192 -0
- package/references/hosted-checkout.md +68 -8
- package/references/integrations/rest-json-authoring/README.md +24 -0
- package/references/integrations/rest-json-authoring/fixture/fixture.json +2466 -0
- package/references/integrations/rest-json-authoring/recipe/connectors/tickets.md +42 -0
- package/references/integrations/rest-json-authoring/recipe/conventions/ticket.md +15 -0
- package/references/integrations/rest-json-authoring/recipe/recipe.md +13 -0
- package/references/modeling-and-delivery.md +3 -0
- package/references/sample-bundle/references/okf-spec.md +8 -2
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: Connector
|
|
3
|
+
title: Recorded ticket board
|
|
4
|
+
auth:
|
|
5
|
+
kind: none
|
|
6
|
+
domains:
|
|
7
|
+
- tickets.example.org
|
|
8
|
+
record_sources:
|
|
9
|
+
- name: tickets
|
|
10
|
+
profile: rest-json
|
|
11
|
+
target_kind: Ticket
|
|
12
|
+
mode: overlay
|
|
13
|
+
identity:
|
|
14
|
+
resource: https://tickets.example.org/boards/{board}
|
|
15
|
+
id: '{id}'
|
|
16
|
+
fields:
|
|
17
|
+
title: title
|
|
18
|
+
state:
|
|
19
|
+
from: status
|
|
20
|
+
values: { OPEN: open, DONE: closed }
|
|
21
|
+
unmapped: keep
|
|
22
|
+
priority:
|
|
23
|
+
from: priority
|
|
24
|
+
values: { low: low, high: high }
|
|
25
|
+
url: html_url
|
|
26
|
+
completeness: complete
|
|
27
|
+
request:
|
|
28
|
+
host: tickets.example.org
|
|
29
|
+
method: GET
|
|
30
|
+
path: /boards/{board}/items
|
|
31
|
+
query:
|
|
32
|
+
after: '{cursor}'
|
|
33
|
+
items: items
|
|
34
|
+
paging:
|
|
35
|
+
kind: cursor
|
|
36
|
+
cursor_path: next
|
|
37
|
+
complete: always
|
|
38
|
+
---
|
|
39
|
+
# Recorded ticket board
|
|
40
|
+
|
|
41
|
+
All provider responses are synthetic. This declaration selects the shipped public rest-json
|
|
42
|
+
profile, never executable code from this directory.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: Convention
|
|
3
|
+
title: Ticket
|
|
4
|
+
governs: Ticket
|
|
5
|
+
path: tickets/
|
|
6
|
+
fields:
|
|
7
|
+
required: [title, state]
|
|
8
|
+
optional: [priority, note, url]
|
|
9
|
+
values:
|
|
10
|
+
state: [open, closed]
|
|
11
|
+
priority: [low, high]
|
|
12
|
+
---
|
|
13
|
+
# Ticket
|
|
14
|
+
|
|
15
|
+
A synthetic issue from an example board. A person's notes stay outside the source-owned fields.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: Recipe
|
|
3
|
+
id: recorded-tickets
|
|
4
|
+
title: Recorded ticket integration
|
|
5
|
+
version: '1'
|
|
6
|
+
summary: An offline integration-authoring example over a synthetic ticket board.
|
|
7
|
+
content_policy: definitions-only
|
|
8
|
+
connectors:
|
|
9
|
+
- connectors/tickets.md
|
|
10
|
+
---
|
|
11
|
+
# Recorded tickets
|
|
12
|
+
|
|
13
|
+
A credential-free authoring example. Installation never fetches the synthetic provider.
|
|
@@ -54,6 +54,9 @@ Use `--body-file` for multiline Markdown. Use `superbee new "<Kind>" --help` for
|
|
|
54
54
|
of an installed Kind. Prefer semantic no-ops, actor attribution, and version-aware updates when the
|
|
55
55
|
CLI exposes them.
|
|
56
56
|
|
|
57
|
+
Put write-time guidance in a Kind's field or value descriptions, never its body: a write that
|
|
58
|
+
sets a described value returns that description as `guidance`.
|
|
59
|
+
|
|
57
60
|
## Evolve from use
|
|
58
61
|
|
|
59
62
|
Refine fields or relationships only after actual instances expose a recurring need. Package a
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
type: Reference
|
|
3
3
|
title: Open Knowledge Format v0.1 (Draft)
|
|
4
4
|
description: A version-scoped OKF v0.1 interop reference, not Superbee's cross-edition authority.
|
|
5
|
-
resource: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/
|
|
5
|
+
resource: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/ee67a5ca27044ebe7c38385f5b6cffc2305a9c1a/okf/SPEC.md
|
|
6
6
|
tags: [okf, spec, reference]
|
|
7
7
|
timestamp: 2026-08-23T17:47:52Z
|
|
8
8
|
---
|
|
@@ -17,6 +17,11 @@ file is a Concept whose ID is its path minus `.md`. The only required
|
|
|
17
17
|
frontmatter field is `type`. This document mirrors the external spec as a
|
|
18
18
|
first-class concept (§8) so citations resolve inside the graph.
|
|
19
19
|
|
|
20
|
+
OKF has since moved to its own repository,
|
|
21
|
+
`GoogleCloudPlatform/open-knowledge-format`, which publishes v0.2. The
|
|
22
|
+
`knowledge-catalog` copy is a frozen snapshot, so the v0.1 citation below is a
|
|
23
|
+
permalink to the commit that published v0.1.
|
|
24
|
+
|
|
20
25
|
# Key sections
|
|
21
26
|
|
|
22
27
|
* §3 bundle structure and reserved filenames (`index.md`, `log.md`).
|
|
@@ -26,4 +31,5 @@ first-class concept (§8) so citations resolve inside the graph.
|
|
|
26
31
|
|
|
27
32
|
# Citations
|
|
28
33
|
|
|
29
|
-
1. [OKF SPEC.md](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/
|
|
34
|
+
1. [OKF v0.1 SPEC.md](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/ee67a5ca27044ebe7c38385f5b6cffc2305a9c1a/okf/SPEC.md)
|
|
35
|
+
2. [Open Knowledge Format repository](https://github.com/GoogleCloudPlatform/open-knowledge-format)
|