|
| 1 | +# ActivitypubApi |
| 2 | + |
| 3 | +All URIs are relative to *http://localhost/api/v1* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**activitypubPerson**](ActivitypubApi.md#activitypubPerson) | **GET** /activitypub/user/{username} | Returns the Person actor for a user |
| 8 | +[**activitypubPersonInbox**](ActivitypubApi.md#activitypubPersonInbox) | **POST** /activitypub/user/{username}/inbox | Send to the inbox |
| 9 | + |
| 10 | + |
| 11 | +<a name="activitypubPerson"></a> |
| 12 | +# **activitypubPerson** |
| 13 | +> ActivityPub activitypubPerson(username) |
| 14 | +
|
| 15 | +Returns the Person actor for a user |
| 16 | + |
| 17 | +### Example |
| 18 | +```java |
| 19 | +// Import classes: |
| 20 | +//import io.gitea.ApiClient; |
| 21 | +//import io.gitea.ApiException; |
| 22 | +//import io.gitea.Configuration; |
| 23 | +//import io.gitea.auth.*; |
| 24 | +//import io.gitea.api.ActivitypubApi; |
| 25 | + |
| 26 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 27 | + |
| 28 | +// Configure API key authorization: AccessToken |
| 29 | +ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); |
| 30 | +AccessToken.setApiKey("YOUR API KEY"); |
| 31 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 32 | +//AccessToken.setApiKeyPrefix("Token"); |
| 33 | + |
| 34 | +// Configure API key authorization: AuthorizationHeaderToken |
| 35 | +ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); |
| 36 | +AuthorizationHeaderToken.setApiKey("YOUR API KEY"); |
| 37 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 38 | +//AuthorizationHeaderToken.setApiKeyPrefix("Token"); |
| 39 | + |
| 40 | +// Configure HTTP basic authorization: BasicAuth |
| 41 | +HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); |
| 42 | +BasicAuth.setUsername("YOUR USERNAME"); |
| 43 | +BasicAuth.setPassword("YOUR PASSWORD"); |
| 44 | + |
| 45 | +// Configure API key authorization: SudoHeader |
| 46 | +ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); |
| 47 | +SudoHeader.setApiKey("YOUR API KEY"); |
| 48 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 49 | +//SudoHeader.setApiKeyPrefix("Token"); |
| 50 | + |
| 51 | +// Configure API key authorization: SudoParam |
| 52 | +ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); |
| 53 | +SudoParam.setApiKey("YOUR API KEY"); |
| 54 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 55 | +//SudoParam.setApiKeyPrefix("Token"); |
| 56 | + |
| 57 | +// Configure API key authorization: TOTPHeader |
| 58 | +ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); |
| 59 | +TOTPHeader.setApiKey("YOUR API KEY"); |
| 60 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 61 | +//TOTPHeader.setApiKeyPrefix("Token"); |
| 62 | + |
| 63 | +// Configure API key authorization: Token |
| 64 | +ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); |
| 65 | +Token.setApiKey("YOUR API KEY"); |
| 66 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 67 | +//Token.setApiKeyPrefix("Token"); |
| 68 | + |
| 69 | +ActivitypubApi apiInstance = new ActivitypubApi(); |
| 70 | +String username = "username_example"; // String | username of the user |
| 71 | +try { |
| 72 | + ActivityPub result = apiInstance.activitypubPerson(username); |
| 73 | + System.out.println(result); |
| 74 | +} catch (ApiException e) { |
| 75 | + System.err.println("Exception when calling ActivitypubApi#activitypubPerson"); |
| 76 | + e.printStackTrace(); |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +### Parameters |
| 81 | + |
| 82 | +Name | Type | Description | Notes |
| 83 | +------------- | ------------- | ------------- | ------------- |
| 84 | + **username** | **String**| username of the user | |
| 85 | + |
| 86 | +### Return type |
| 87 | + |
| 88 | +[**ActivityPub**](ActivityPub.md) |
| 89 | + |
| 90 | +### Authorization |
| 91 | + |
| 92 | +[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) |
| 93 | + |
| 94 | +### HTTP request headers |
| 95 | + |
| 96 | + - **Content-Type**: application/json, text/plain |
| 97 | + - **Accept**: application/json |
| 98 | + |
| 99 | +<a name="activitypubPersonInbox"></a> |
| 100 | +# **activitypubPersonInbox** |
| 101 | +> activitypubPersonInbox(username) |
| 102 | +
|
| 103 | +Send to the inbox |
| 104 | + |
| 105 | +### Example |
| 106 | +```java |
| 107 | +// Import classes: |
| 108 | +//import io.gitea.ApiClient; |
| 109 | +//import io.gitea.ApiException; |
| 110 | +//import io.gitea.Configuration; |
| 111 | +//import io.gitea.auth.*; |
| 112 | +//import io.gitea.api.ActivitypubApi; |
| 113 | + |
| 114 | +ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 115 | + |
| 116 | +// Configure API key authorization: AccessToken |
| 117 | +ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); |
| 118 | +AccessToken.setApiKey("YOUR API KEY"); |
| 119 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 120 | +//AccessToken.setApiKeyPrefix("Token"); |
| 121 | + |
| 122 | +// Configure API key authorization: AuthorizationHeaderToken |
| 123 | +ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); |
| 124 | +AuthorizationHeaderToken.setApiKey("YOUR API KEY"); |
| 125 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 126 | +//AuthorizationHeaderToken.setApiKeyPrefix("Token"); |
| 127 | + |
| 128 | +// Configure HTTP basic authorization: BasicAuth |
| 129 | +HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); |
| 130 | +BasicAuth.setUsername("YOUR USERNAME"); |
| 131 | +BasicAuth.setPassword("YOUR PASSWORD"); |
| 132 | + |
| 133 | +// Configure API key authorization: SudoHeader |
| 134 | +ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); |
| 135 | +SudoHeader.setApiKey("YOUR API KEY"); |
| 136 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 137 | +//SudoHeader.setApiKeyPrefix("Token"); |
| 138 | + |
| 139 | +// Configure API key authorization: SudoParam |
| 140 | +ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); |
| 141 | +SudoParam.setApiKey("YOUR API KEY"); |
| 142 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 143 | +//SudoParam.setApiKeyPrefix("Token"); |
| 144 | + |
| 145 | +// Configure API key authorization: TOTPHeader |
| 146 | +ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); |
| 147 | +TOTPHeader.setApiKey("YOUR API KEY"); |
| 148 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 149 | +//TOTPHeader.setApiKeyPrefix("Token"); |
| 150 | + |
| 151 | +// Configure API key authorization: Token |
| 152 | +ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); |
| 153 | +Token.setApiKey("YOUR API KEY"); |
| 154 | +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 155 | +//Token.setApiKeyPrefix("Token"); |
| 156 | + |
| 157 | +ActivitypubApi apiInstance = new ActivitypubApi(); |
| 158 | +String username = "username_example"; // String | username of the user |
| 159 | +try { |
| 160 | + apiInstance.activitypubPersonInbox(username); |
| 161 | +} catch (ApiException e) { |
| 162 | + System.err.println("Exception when calling ActivitypubApi#activitypubPersonInbox"); |
| 163 | + e.printStackTrace(); |
| 164 | +} |
| 165 | +``` |
| 166 | + |
| 167 | +### Parameters |
| 168 | + |
| 169 | +Name | Type | Description | Notes |
| 170 | +------------- | ------------- | ------------- | ------------- |
| 171 | + **username** | **String**| username of the user | |
| 172 | + |
| 173 | +### Return type |
| 174 | + |
| 175 | +null (empty response body) |
| 176 | + |
| 177 | +### Authorization |
| 178 | + |
| 179 | +[AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) |
| 180 | + |
| 181 | +### HTTP request headers |
| 182 | + |
| 183 | + - **Content-Type**: application/json, text/plain |
| 184 | + - **Accept**: application/json |
| 185 | + |
0 commit comments