greatape/greataped/README.md

Note

⚠️ This project is under heavy development and should not be used in production yet.

APIs:

1. Echo
2. Signup
3. Verify
4. Login
5. GetProfileByUser
6. UpdateProfileByUser
7. Logout
8. Webfinger
9. GetActor
10. FollowActor
11. AuthorizeInteraction
12. GetFollowers
13. GetFollowing
14. PostToOutbox

---

Echo

Request:
    Document document

Result:
    Document document

Back to List

Signup

Request:
    string username
    string email
    // Should be at least 7 characters including upper and lowercase, digits and symbols
    string password

Result:
    string token
    string code

Back to List

Verify

Request:
    string email
    string token
    string code

Result:
    string token

Back to List

Login

Request:
    string email
    string password

Result:
    string username
    string token

Back to List

Get Profile By User

Request:

Result:
    string username
    string displayName
    string avatar
    string banner
    string summary
    string github

Back to List

Update Profile By User

Request:
    string displayName
    string avatar
    string banner
    string summary
    string github

Result:
    string displayName
    string avatar
    string banner
    string summary
    string github

Back to List

Logout

Request:

Result:

Back to List

Webfinger

Request:
    string resource

Result:
    repeated string aliases
    repeated ActivityPubLink links
    string subject

Back to List

Get Actor

Request:
    string username

Result:
    repeated string @context
    string id
    string followers
    string following
    string inbox
    string outbox
    string name
    string preferredUsername
    string type
    string url
    ActivityPubMedia icon
    ActivityPubMedia image
    ActivityPubPublicKey publicKey
    string summary
    string published

Back to List

Follow Actor

Request:
    string username
    string acct

Result:
    string url

Back to List

Authorize Interaction

Request:
    string uri

Result:
    string uri
    bool success

Back to List

Get Followers

Request:
    string username

Result:
    string @context
    string id
    string type
    int32 totalItems
    repeated string orderedItems
    string first

Back to List

Get Following

Request:
    string username

Result:
    string @context
    string id
    string type
    int32 totalItems
    repeated string orderedItems
    string first

Back to List

Post To Outbox

Request:
    string username
    string @context
    string type
    string to
    string attributedTo
    string inReplyTo
    string content

Result:

Back to List