Browse Source

typos fixed in API spec

ENGINE-930
Volker Birk 2 months ago
parent
commit
5eaf20f2a7
3 changed files with 11 additions and 11 deletions
  1. +4
    -4
      api/basic_api.yml2
  2. +3
    -3
      api/message_api.yml2
  3. +4
    -4
      api/pEp.yml2

+ 4
- 4
api/basic_api.yml2 View File

@ -286,13 +286,13 @@ protocol session {
}
method mark_as_compromized doc="deprecated to fix misspelling. Please move to mark_as_compromised"
method mark_as_compromized doc="deprecated to fix misspelling. Please move to mark_as_compromised";
method import_key_with_fpr_return
doc="""
import keys from data, return optional list of fprs imported
""";
"""
{
// parms
@ -495,7 +495,7 @@ protocol session {
{
// exceptions
throws char* doc="path to actual per user directory";
throws char doc="path to actual per user directory";
throws NULL doc="on failure";
}
@ -504,7 +504,7 @@ protocol session {
{
// exceptions
throws char* doc="path to actual per machine directory";
throws char doc="path to actual per machine directory";
throws NULL doc="on failure";
}


+ 3
- 3
api/message_api.yml2 View File

@ -110,7 +110,7 @@ protocol session {
{
// parms
lend message src
supply message src
doc="""
message to encrypt - usually in-only, but can be in-out for
unencrypted messages; in that case, we may attach the key and
@ -267,7 +267,7 @@ protocol session {
{
// parms
lend message src
support message src
doc="""
message to decrypt.
The ownership of src remains with the caller - HOWEVER, the contents
@ -291,7 +291,7 @@ protocol session {
create message dst doc="pointer to new decrypted message or empty on failure";
lend hash_list keylist
supply hash_list keylist
doc="""
in: stringlist with additional keyids for reencryption if needed
(will be freed and replaced with output keylist)


+ 4
- 4
api/pEp.yml2 View File

@ -28,15 +28,15 @@ decl use @type @name (mode=use) alias parm;
// inout parm, ownership remains with caller
decl supply @type @name (mode=supply) alias parm;
// factory delivers this, ownership goes to caller
decl create @type @name (mode=create) alias parm;
// in parm, ownership goes to callee
decl provide @type @name (mode=provide) alias parm;
// out parm, ownership goes to callee
// out parm, ownership goes to caller
decl return @type @name (mode=return) alias parm;
// factory delivers this, ownership goes to caller
decl create @type @name (mode=create) alias parm;
decl throws @except;
decl caveat(mode=caveat) alias doc;


Loading…
Cancel
Save