Skip to content

Commit 4a96e49

Browse files
fundthmcalculusfundthmcalculus
committed
doc updates
1 parent 0b782b3 commit 4a96e49

2 files changed

Lines changed: 276 additions & 8 deletions

File tree

‎docs/reference/go/okapi.md‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,55 @@
22

33
## Types
44

5-
### type [DidCommer](/DidComm.go#L7)
5+
### type [DidCommer](/didcomm.go#L8)
66

77
`type DidCommer interface { ... }`
88

9-
### type [DidError](/native.go#L25)
9+
DidCommer implements the DIDComm Messaging protocol
10+
11+
### type [DidError](/native.go#L27)
1012

1113
`type DidError struct { ... }`
1214

13-
#### func (*DidError) [Error](/native.go#L31)
15+
DidError indicates a DID protocol error
16+
17+
#### func (*DidError) [Error](/native.go#L33)
1418

1519
`func (d *DidError) Error() string`
1620

17-
### type [DidKeyer](/DidKey.go#L6)
21+
### type [DidKeyer](/didkey.go#L6)
1822

1923
`type DidKeyer interface { ... }`
2024

2125
DidKeyer is the interface that groups the did:key functions
2226

23-
### type [LdProofer](/LdProofs.go#L5)
27+
### type [Hasher](/hashing.go#L8)
28+
29+
`type Hasher interface { ... }`
30+
31+
Hasher implements Blake3 and Sha2 hash functions
32+
33+
### type [LdProofer](/ldproofs.go#L6)
2434

2535
`type LdProofer interface { ... }`
2636

27-
### type [NativeError](/native.go#L16)
37+
LdProofer implements Linked-Data Proofs
38+
39+
### type [NativeError](/native.go#L17)
2840

2941
`type NativeError struct { ... }`
3042

31-
#### func (NativeError) [Error](/native.go#L21)
43+
NativeError indicates a native protocol error
44+
45+
#### func (NativeError) [Error](/native.go#L22)
3246

3347
`func (o NativeError) Error() string`
3448

35-
### type [Oberoner](/Oberon.go#L5)
49+
### type [Oberoner](/oberon.go#L6)
3650

3751
`type Oberoner interface { ... }`
3852

53+
Oberoner implements Oberon authentication
54+
3955
---
4056
Readme created from Go doc with [goreadme](https://github.com/posener/goreadme)

‎docs/reference/go/okapiproto.md‎

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ var (
7878
var File_okapi_examples_v1_examples_proto protoreflect.FileDescriptor
7979
```
8080

81+
```golang
82+
var File_okapi_hashing_v1_hashing_proto protoreflect.FileDescriptor
83+
```
84+
8185
```golang
8286
var File_okapi_keys_v1_keys_proto protoreflect.FileDescriptor
8387
```
@@ -130,6 +134,194 @@ Deprecated: Use BasicMessage.ProtoReflect.Descriptor instead.
130134

131135
`func (x *BasicMessage) String() string`
132136

137+
### type [Blake3DeriveKeyRequest](/hashing.pb.go#L219)
138+
139+
`type Blake3DeriveKeyRequest struct { ... }`
140+
141+
#### func (*Blake3DeriveKeyRequest) [Descriptor](/hashing.pb.go#L256)
142+
143+
`func (*Blake3DeriveKeyRequest) Descriptor() ([]byte, []int)`
144+
145+
Deprecated: Use Blake3DeriveKeyRequest.ProtoReflect.Descriptor instead.
146+
147+
#### func (*Blake3DeriveKeyRequest) [GetContext](/hashing.pb.go#L260)
148+
149+
`func (x *Blake3DeriveKeyRequest) GetContext() []byte`
150+
151+
#### func (*Blake3DeriveKeyRequest) [GetKeyMaterial](/hashing.pb.go#L267)
152+
153+
`func (x *Blake3DeriveKeyRequest) GetKeyMaterial() []byte`
154+
155+
#### func (*Blake3DeriveKeyRequest) [ProtoMessage](/hashing.pb.go#L241)
156+
157+
`func (*Blake3DeriveKeyRequest) ProtoMessage()`
158+
159+
#### func (*Blake3DeriveKeyRequest) [ProtoReflect](/hashing.pb.go#L243)
160+
161+
`func (x *Blake3DeriveKeyRequest) ProtoReflect() protoreflect.Message`
162+
163+
#### func (*Blake3DeriveKeyRequest) [Reset](/hashing.pb.go#L228)
164+
165+
`func (x *Blake3DeriveKeyRequest) Reset()`
166+
167+
#### func (*Blake3DeriveKeyRequest) [String](/hashing.pb.go#L237)
168+
169+
`func (x *Blake3DeriveKeyRequest) String() string`
170+
171+
### type [Blake3DeriveKeyResponse](/hashing.pb.go#L274)
172+
173+
`type Blake3DeriveKeyResponse struct { ... }`
174+
175+
#### func (*Blake3DeriveKeyResponse) [Descriptor](/hashing.pb.go#L310)
176+
177+
`func (*Blake3DeriveKeyResponse) Descriptor() ([]byte, []int)`
178+
179+
Deprecated: Use Blake3DeriveKeyResponse.ProtoReflect.Descriptor instead.
180+
181+
#### func (*Blake3DeriveKeyResponse) [GetDigest](/hashing.pb.go#L314)
182+
183+
`func (x *Blake3DeriveKeyResponse) GetDigest() []byte`
184+
185+
#### func (*Blake3DeriveKeyResponse) [ProtoMessage](/hashing.pb.go#L295)
186+
187+
`func (*Blake3DeriveKeyResponse) ProtoMessage()`
188+
189+
#### func (*Blake3DeriveKeyResponse) [ProtoReflect](/hashing.pb.go#L297)
190+
191+
`func (x *Blake3DeriveKeyResponse) ProtoReflect() protoreflect.Message`
192+
193+
#### func (*Blake3DeriveKeyResponse) [Reset](/hashing.pb.go#L282)
194+
195+
`func (x *Blake3DeriveKeyResponse) Reset()`
196+
197+
#### func (*Blake3DeriveKeyResponse) [String](/hashing.pb.go#L291)
198+
199+
`func (x *Blake3DeriveKeyResponse) String() string`
200+
201+
### type [Blake3HashRequest](/hashing.pb.go#L23)
202+
203+
`type Blake3HashRequest struct { ... }`
204+
205+
#### func (*Blake3HashRequest) [Descriptor](/hashing.pb.go#L59)
206+
207+
`func (*Blake3HashRequest) Descriptor() ([]byte, []int)`
208+
209+
Deprecated: Use Blake3HashRequest.ProtoReflect.Descriptor instead.
210+
211+
#### func (*Blake3HashRequest) [GetData](/hashing.pb.go#L63)
212+
213+
`func (x *Blake3HashRequest) GetData() []byte`
214+
215+
#### func (*Blake3HashRequest) [ProtoMessage](/hashing.pb.go#L44)
216+
217+
`func (*Blake3HashRequest) ProtoMessage()`
218+
219+
#### func (*Blake3HashRequest) [ProtoReflect](/hashing.pb.go#L46)
220+
221+
`func (x *Blake3HashRequest) ProtoReflect() protoreflect.Message`
222+
223+
#### func (*Blake3HashRequest) [Reset](/hashing.pb.go#L31)
224+
225+
`func (x *Blake3HashRequest) Reset()`
226+
227+
#### func (*Blake3HashRequest) [String](/hashing.pb.go#L40)
228+
229+
`func (x *Blake3HashRequest) String() string`
230+
231+
### type [Blake3HashResponse](/hashing.pb.go#L70)
232+
233+
`type Blake3HashResponse struct { ... }`
234+
235+
#### func (*Blake3HashResponse) [Descriptor](/hashing.pb.go#L106)
236+
237+
`func (*Blake3HashResponse) Descriptor() ([]byte, []int)`
238+
239+
Deprecated: Use Blake3HashResponse.ProtoReflect.Descriptor instead.
240+
241+
#### func (*Blake3HashResponse) [GetDigest](/hashing.pb.go#L110)
242+
243+
`func (x *Blake3HashResponse) GetDigest() []byte`
244+
245+
#### func (*Blake3HashResponse) [ProtoMessage](/hashing.pb.go#L91)
246+
247+
`func (*Blake3HashResponse) ProtoMessage()`
248+
249+
#### func (*Blake3HashResponse) [ProtoReflect](/hashing.pb.go#L93)
250+
251+
`func (x *Blake3HashResponse) ProtoReflect() protoreflect.Message`
252+
253+
#### func (*Blake3HashResponse) [Reset](/hashing.pb.go#L78)
254+
255+
`func (x *Blake3HashResponse) Reset()`
256+
257+
#### func (*Blake3HashResponse) [String](/hashing.pb.go#L87)
258+
259+
`func (x *Blake3HashResponse) String() string`
260+
261+
### type [Blake3KeyedHashRequest](/hashing.pb.go#L117)
262+
263+
`type Blake3KeyedHashRequest struct { ... }`
264+
265+
#### func (*Blake3KeyedHashRequest) [Descriptor](/hashing.pb.go#L154)
266+
267+
`func (*Blake3KeyedHashRequest) Descriptor() ([]byte, []int)`
268+
269+
Deprecated: Use Blake3KeyedHashRequest.ProtoReflect.Descriptor instead.
270+
271+
#### func (*Blake3KeyedHashRequest) [GetData](/hashing.pb.go#L158)
272+
273+
`func (x *Blake3KeyedHashRequest) GetData() []byte`
274+
275+
#### func (*Blake3KeyedHashRequest) [GetKey](/hashing.pb.go#L165)
276+
277+
`func (x *Blake3KeyedHashRequest) GetKey() []byte`
278+
279+
#### func (*Blake3KeyedHashRequest) [ProtoMessage](/hashing.pb.go#L139)
280+
281+
`func (*Blake3KeyedHashRequest) ProtoMessage()`
282+
283+
#### func (*Blake3KeyedHashRequest) [ProtoReflect](/hashing.pb.go#L141)
284+
285+
`func (x *Blake3KeyedHashRequest) ProtoReflect() protoreflect.Message`
286+
287+
#### func (*Blake3KeyedHashRequest) [Reset](/hashing.pb.go#L126)
288+
289+
`func (x *Blake3KeyedHashRequest) Reset()`
290+
291+
#### func (*Blake3KeyedHashRequest) [String](/hashing.pb.go#L135)
292+
293+
`func (x *Blake3KeyedHashRequest) String() string`
294+
295+
### type [Blake3KeyedHashResponse](/hashing.pb.go#L172)
296+
297+
`type Blake3KeyedHashResponse struct { ... }`
298+
299+
#### func (*Blake3KeyedHashResponse) [Descriptor](/hashing.pb.go#L208)
300+
301+
`func (*Blake3KeyedHashResponse) Descriptor() ([]byte, []int)`
302+
303+
Deprecated: Use Blake3KeyedHashResponse.ProtoReflect.Descriptor instead.
304+
305+
#### func (*Blake3KeyedHashResponse) [GetDigest](/hashing.pb.go#L212)
306+
307+
`func (x *Blake3KeyedHashResponse) GetDigest() []byte`
308+
309+
#### func (*Blake3KeyedHashResponse) [ProtoMessage](/hashing.pb.go#L193)
310+
311+
`func (*Blake3KeyedHashResponse) ProtoMessage()`
312+
313+
#### func (*Blake3KeyedHashResponse) [ProtoReflect](/hashing.pb.go#L195)
314+
315+
`func (x *Blake3KeyedHashResponse) ProtoReflect() protoreflect.Message`
316+
317+
#### func (*Blake3KeyedHashResponse) [Reset](/hashing.pb.go#L180)
318+
319+
`func (x *Blake3KeyedHashResponse) Reset()`
320+
321+
#### func (*Blake3KeyedHashResponse) [String](/hashing.pb.go#L189)
322+
323+
`func (x *Blake3KeyedHashResponse) String() string`
324+
133325
### type [BlindOberonTokenRequest](/security.pb.go#L483)
134326

135327
`type BlindOberonTokenRequest struct { ... }`
@@ -1040,6 +1232,66 @@ Deprecated: Use ResolveResponse.ProtoReflect.Descriptor instead.
10401232

10411233
`func (x *ResolveResponse) String() string`
10421234

1235+
### type [SHA256HashRequest](/hashing.pb.go#L321)
1236+
1237+
`type SHA256HashRequest struct { ... }`
1238+
1239+
#### func (*SHA256HashRequest) [Descriptor](/hashing.pb.go#L357)
1240+
1241+
`func (*SHA256HashRequest) Descriptor() ([]byte, []int)`
1242+
1243+
Deprecated: Use SHA256HashRequest.ProtoReflect.Descriptor instead.
1244+
1245+
#### func (*SHA256HashRequest) [GetData](/hashing.pb.go#L361)
1246+
1247+
`func (x *SHA256HashRequest) GetData() []byte`
1248+
1249+
#### func (*SHA256HashRequest) [ProtoMessage](/hashing.pb.go#L342)
1250+
1251+
`func (*SHA256HashRequest) ProtoMessage()`
1252+
1253+
#### func (*SHA256HashRequest) [ProtoReflect](/hashing.pb.go#L344)
1254+
1255+
`func (x *SHA256HashRequest) ProtoReflect() protoreflect.Message`
1256+
1257+
#### func (*SHA256HashRequest) [Reset](/hashing.pb.go#L329)
1258+
1259+
`func (x *SHA256HashRequest) Reset()`
1260+
1261+
#### func (*SHA256HashRequest) [String](/hashing.pb.go#L338)
1262+
1263+
`func (x *SHA256HashRequest) String() string`
1264+
1265+
### type [SHA256HashResponse](/hashing.pb.go#L368)
1266+
1267+
`type SHA256HashResponse struct { ... }`
1268+
1269+
#### func (*SHA256HashResponse) [Descriptor](/hashing.pb.go#L404)
1270+
1271+
`func (*SHA256HashResponse) Descriptor() ([]byte, []int)`
1272+
1273+
Deprecated: Use SHA256HashResponse.ProtoReflect.Descriptor instead.
1274+
1275+
#### func (*SHA256HashResponse) [GetDigest](/hashing.pb.go#L408)
1276+
1277+
`func (x *SHA256HashResponse) GetDigest() []byte`
1278+
1279+
#### func (*SHA256HashResponse) [ProtoMessage](/hashing.pb.go#L389)
1280+
1281+
`func (*SHA256HashResponse) ProtoMessage()`
1282+
1283+
#### func (*SHA256HashResponse) [ProtoReflect](/hashing.pb.go#L391)
1284+
1285+
`func (x *SHA256HashResponse) ProtoReflect() protoreflect.Message`
1286+
1287+
#### func (*SHA256HashResponse) [Reset](/hashing.pb.go#L376)
1288+
1289+
`func (x *SHA256HashResponse) Reset()`
1290+
1291+
#### func (*SHA256HashResponse) [String](/hashing.pb.go#L385)
1292+
1293+
`func (x *SHA256HashResponse) String() string`
1294+
10431295
### type [SignRequest](/transport.pb.go#L23)
10441296

10451297
`type SignRequest struct { ... }`

0 commit comments

Comments
 (0)