Begin APID

TBD54566975 · Jun 13, 2024 · 78bd6eb · 78bd6eb
1 parent c5c234e
commit 78bd6eb
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/docs/API_DESIGN.md b/docs/API_DESIGN.md
diff --git a/docs/rfc-0001/README.md b/docs/rfc-0001/README.md
@@ -0,0 +1,52 @@
+# tbDEX API Design (APID) <!-- omit in toc -->
+
+**Last Updated:** June 13, 2024
+
+**Custom DSL Version:** 0.1.0
+
+- [Resources](#resources)
+  - [`Resource`](#resource)
+  - [`ResourceMetadata`](#resourcemetadata)
+  - [Offering](#offering)
+    - [`OfferingData`](#offeringdata)
+- [Messages](#messages)
+
+# Resources
+
+## `Resource`
+
+```pseudocode!
+INTERFACE Resource
+  METHOD sign(bearer_did: BearerDid)
+  METHOD verify(): bool
+```
+
+## `ResourceMetadata`
+
+```pseudocode!
+CLASS ResourceMetadata
+  PUBLIC DATA kind: string
+  /// 🚧 more members
+```
+
+## Offering
+
+```pseudocode!
+CLASS Offering IMPLEMENTS Resource
+  CONSTRUCTOR(from: string, data: OfferingData, protocol: string)
+  CONSTRUCTOR(json: string)
+  METHOD sign(bearer_did: BearerDid)
+  METHOD verify(): bool
+```
+
+### `OfferingData`
+
+```pseudocode!
+CLASS OfferingData
+  PUBLIC DATA description: string
+  /// 🚧 more members
+```
+
+# Messages
+
+...