Lib.rs

› Web programming
#api-client #openapi-generator #generated #openapitools #version #github #com

memos-api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

by OpenAPI Generator team and contributors. Owned by Paul van der Meijs.

2 unstable releases

0.3.0 Oct 13, 2024
0.1.0 Oct 5, 2024

#384 in Web programming

Download history 127/week @ 2024-09-30 107/week @ 2024-10-07 137/week @ 2024-10-14 7/week @ 2024-10-21 7/week @ 2024-11-04

220 downloads per month
Used in 2 crates

Unlicense

290KB
4.5K SLoC

Rust API client for memos-api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 0.1.0
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named memos-api and add the following to Cargo.toml under [dependencies]:

memos-api = { path = "./memos-api" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActivityServiceApi activity_service_get_activity GET /api/v1/{name} GetActivity returns the activity with the given id.
AuthServiceApi auth_service_get_auth_status POST /api/v1/auth/status GetAuthStatus returns the current auth status of the user.
AuthServiceApi auth_service_sign_in POST /api/v1/auth/signin SignIn signs in the user with the given username and password.
AuthServiceApi auth_service_sign_in_with_sso POST /api/v1/auth/signin/sso SignInWithSSO signs in the user with the given SSO code.
AuthServiceApi auth_service_sign_out POST /api/v1/auth/signout SignOut signs out the user.
AuthServiceApi auth_service_sign_up POST /api/v1/auth/signup SignUp signs up the user with the given username and password.
IdentityProviderServiceApi identity_provider_service_create_identity_provider POST /api/v1/identityProviders CreateIdentityProvider creates an identity provider.
IdentityProviderServiceApi identity_provider_service_delete_identity_provider DELETE /api/v1/{name_1} DeleteIdentityProvider deletes an identity provider.
IdentityProviderServiceApi identity_provider_service_get_identity_provider GET /api/v1/{name_2} GetIdentityProvider gets an identity provider.
IdentityProviderServiceApi identity_provider_service_list_identity_providers GET /api/v1/identityProviders ListIdentityProviders lists identity providers.
IdentityProviderServiceApi identity_provider_service_update_identity_provider PATCH /api/v1/{identityProvider_name} UpdateIdentityProvider updates an identity provider.
InboxServiceApi inbox_service_delete_inbox DELETE /api/v1/{name_2} DeleteInbox deletes an inbox.
InboxServiceApi inbox_service_list_inboxes GET /api/v1/inboxes ListInboxes lists inboxes for a user.
InboxServiceApi inbox_service_update_inbox PATCH /api/v1/{inbox_name} UpdateInbox updates an inbox.
MarkdownServiceApi markdown_service_get_link_metadata GET /api/v1/markdown/link:metadata GetLinkMetadata returns metadata for a given link.
MarkdownServiceApi markdown_service_parse_markdown POST /api/v1/markdown:parse ParseMarkdown parses the given markdown content and returns a list of nodes.
MarkdownServiceApi markdown_service_restore_markdown_nodes POST /api/v1/markdown/node:restore RestoreMarkdownNodes restores the given nodes to markdown content.
MarkdownServiceApi markdown_service_stringify_markdown_nodes POST /api/v1/markdown/node:stringify StringifyMarkdownNodes stringify the given nodes to plain text content.
MemoServiceApi memo_service_create_memo POST /api/v1/memos CreateMemo creates a memo.
MemoServiceApi memo_service_create_memo_comment POST /api/v1/{name}/comments CreateMemoComment creates a comment for a memo.
MemoServiceApi memo_service_delete_memo DELETE /api/v1/{name_4} DeleteMemo deletes a memo.
MemoServiceApi memo_service_delete_memo_reaction DELETE /api/v1/reactions/{reactionId} DeleteMemoReaction deletes a reaction for a memo.
MemoServiceApi memo_service_delete_memo_tag DELETE /api/v1/{parent}/tags/{tag} DeleteMemoTag deletes a tag for a memo.
MemoServiceApi memo_service_get_memo GET /api/v1/{name_4} GetMemo gets a memo.
MemoServiceApi memo_service_get_memo_by_uid GET /api/v1/memos:by-uid/{uid} GetMemoByUid gets a memo by uid
MemoServiceApi memo_service_list_memo_comments GET /api/v1/{name}/comments ListMemoComments lists comments for a memo.
MemoServiceApi memo_service_list_memo_properties GET /api/v1/{name}/properties ListMemoProperties lists memo properties.
MemoServiceApi memo_service_list_memo_reactions GET /api/v1/{name}/reactions ListMemoReactions lists reactions for a memo.
MemoServiceApi memo_service_list_memo_relations GET /api/v1/{name}/relations ListMemoRelations lists relations for a memo.
MemoServiceApi memo_service_list_memo_resources GET /api/v1/{name}/resources ListMemoResources lists resources for a memo.
MemoServiceApi memo_service_list_memo_tags GET /api/v1/{parent}/tags ListMemoTags lists tags for a memo.
MemoServiceApi memo_service_list_memos GET /api/v1/memos ListMemos lists memos with pagination and filter.
MemoServiceApi memo_service_rebuild_memo_property POST /api/v1/{name}/properties:rebuild RebuildMemoProperty rebuilds a memo property.
MemoServiceApi memo_service_rename_memo_tag PATCH /api/v1/{parent}/tags:rename RenameMemoTag renames a tag for a memo.
MemoServiceApi memo_service_set_memo_relations PATCH /api/v1/{name}/relations SetMemoRelations sets relations for a memo.
MemoServiceApi memo_service_set_memo_resources PATCH /api/v1/{name}/resources SetMemoResources sets resources for a memo.
MemoServiceApi memo_service_update_memo PATCH /api/v1/{memo_name} UpdateMemo updates a memo.
MemoServiceApi memo_service_upsert_memo_reaction POST /api/v1/{name}/reactions UpsertMemoReaction upserts a reaction for a memo.
ResourceServiceApi resource_service_create_resource POST /api/v1/resources CreateResource creates a new resource.
ResourceServiceApi resource_service_delete_resource DELETE /api/v1/{name_3} DeleteResource deletes a resource by name.
ResourceServiceApi resource_service_get_resource GET /api/v1/{name_3} GetResource returns a resource by name.
ResourceServiceApi resource_service_get_resource_binary GET /file/{name}/{filename} GetResourceBinary returns a resource binary by name.
ResourceServiceApi resource_service_get_resource_by_uid GET /api/v1/resources:by-uid/{uid} GetResourceByUid returns a resource by uid.
ResourceServiceApi resource_service_list_resources GET /api/v1/resources ListResources lists all resources.
ResourceServiceApi resource_service_update_resource PATCH /api/v1/{resource_name} UpdateResource updates a resource.
UserServiceApi user_service_create_user POST /api/v1/users CreateUser creates a new user.
UserServiceApi user_service_create_user_access_token POST /api/v1/{name}/access_tokens CreateUserAccessToken creates a new access token for a user.
UserServiceApi user_service_delete_user DELETE /api/v1/{name} DeleteUser deletes a user.
UserServiceApi user_service_delete_user_access_token DELETE /api/v1/{name}/access_tokens/{accessToken} DeleteUserAccessToken deletes an access token for a user.
UserServiceApi user_service_get_user GET /api/v1/{name_1} GetUser gets a user by name.
UserServiceApi user_service_get_user_avatar_binary GET /file/{name}/avatar GetUserAvatarBinary gets the avatar of a user.
UserServiceApi user_service_get_user_setting GET /api/v1/{name}/setting GetUserSetting gets the setting of a user.
UserServiceApi user_service_list_user_access_tokens GET /api/v1/{name}/access_tokens ListUserAccessTokens returns a list of access tokens for a user.
UserServiceApi user_service_list_users GET /api/v1/users ListUsers returns a list of users.
UserServiceApi user_service_search_users GET /api/v1/users:search SearchUsers searches users by filter.
UserServiceApi user_service_update_user PATCH /api/v1/{user_name} UpdateUser updates a user.
UserServiceApi user_service_update_user_setting PATCH /api/v1/{setting_name} UpdateUserSetting updates the setting of a user.
WebhookServiceApi webhook_service_create_webhook POST /api/v1/webhooks CreateWebhook creates a new webhook.
WebhookServiceApi webhook_service_delete_webhook DELETE /api/v1/webhooks/{id} DeleteWebhook deletes a webhook by id.
WebhookServiceApi webhook_service_get_webhook GET /api/v1/webhooks/{id} GetWebhook returns a webhook by id.
WebhookServiceApi webhook_service_list_webhooks GET /api/v1/webhooks ListWebhooks returns a list of webhooks.
WebhookServiceApi webhook_service_update_webhook PATCH /api/v1/webhooks/{webhook_id} UpdateWebhook updates a webhook.
WorkspaceServiceApi workspace_service_get_workspace_profile GET /api/v1/workspace/profile GetWorkspaceProfile returns the workspace profile.
WorkspaceSettingServiceApi workspace_setting_service_get_workspace_setting GET /api/v1/workspace/{name} GetWorkspaceSetting returns the setting by name.
WorkspaceSettingServiceApi workspace_setting_service_set_workspace_setting PATCH /api/v1/workspace/{setting_name} SetWorkspaceSetting updates the setting.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~8–19MB
~268K SLoC