149 lines
4.5 KiB
Markdown
149 lines
4.5 KiB
Markdown
# memos.MarkdownServiceApi
|
|
|
|
All URIs are relative to */*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**markdown_service_get_link_metadata**](MarkdownServiceApi.md#markdown_service_get_link_metadata) | **GET** /api/v1/markdown/link:metadata | GetLinkMetadata returns metadata for a given link.
|
|
[**markdown_service_parse_markdown**](MarkdownServiceApi.md#markdown_service_parse_markdown) | **POST** /api/v1/markdown/parse | Parses the given markdown content and returns a list of nodes.
|
|
[**markdown_service_restore_markdown**](MarkdownServiceApi.md#markdown_service_restore_markdown) | **POST** /api/v1/markdown:restore | Restores the given nodes to markdown content.
|
|
|
|
# **markdown_service_get_link_metadata**
|
|
> V1LinkMetadata markdown_service_get_link_metadata(link=link)
|
|
|
|
GetLinkMetadata returns metadata for a given link.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MarkdownServiceApi()
|
|
link = 'link_example' # str | (optional)
|
|
|
|
try:
|
|
# GetLinkMetadata returns metadata for a given link.
|
|
api_response = api_instance.markdown_service_get_link_metadata(link=link)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MarkdownServiceApi->markdown_service_get_link_metadata: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**link** | **str**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1LinkMetadata**](V1LinkMetadata.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **markdown_service_parse_markdown**
|
|
> V1ParseMarkdownResponse markdown_service_parse_markdown(body)
|
|
|
|
Parses the given markdown content and returns a list of nodes.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MarkdownServiceApi()
|
|
body = memos.V1ParseMarkdownRequest() # V1ParseMarkdownRequest |
|
|
|
|
try:
|
|
# Parses the given markdown content and returns a list of nodes.
|
|
api_response = api_instance.markdown_service_parse_markdown(body)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MarkdownServiceApi->markdown_service_parse_markdown: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1ParseMarkdownRequest**](V1ParseMarkdownRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**V1ParseMarkdownResponse**](V1ParseMarkdownResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **markdown_service_restore_markdown**
|
|
> V1RestoreMarkdownResponse markdown_service_restore_markdown(body)
|
|
|
|
Restores the given nodes to markdown content.
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_function
|
|
import time
|
|
import memos
|
|
from memos.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# create an instance of the API class
|
|
api_instance = memos.MarkdownServiceApi()
|
|
body = memos.V1RestoreMarkdownRequest() # V1RestoreMarkdownRequest |
|
|
|
|
try:
|
|
# Restores the given nodes to markdown content.
|
|
api_response = api_instance.markdown_service_restore_markdown(body)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling MarkdownServiceApi->markdown_service_restore_markdown: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**V1RestoreMarkdownRequest**](V1RestoreMarkdownRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**V1RestoreMarkdownResponse**](V1RestoreMarkdownResponse.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|