forgejo 0.1.0 → 0.2.1

data/docs/ActivitypubApi.md

@@ -4,12 +4,145 @@ All URIs are relative to */api/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**activitypub_instance_actor**](ActivitypubApi.md#activitypub_instance_actor) | **GET** /activitypub/actor | Returns the instance's Actor |
+| [**activitypub_instance_actor_inbox**](ActivitypubApi.md#activitypub_instance_actor_inbox) | **POST** /activitypub/actor/inbox | Send to the inbox |
 | [**activitypub_person**](ActivitypubApi.md#activitypub_person) | **GET** /activitypub/user-id/{user-id} | Returns the Person actor for a user |
 | [**activitypub_person_inbox**](ActivitypubApi.md#activitypub_person_inbox) | **POST** /activitypub/user-id/{user-id}/inbox | Send to the inbox |
 | [**activitypub_repository**](ActivitypubApi.md#activitypub_repository) | **GET** /activitypub/repository-id/{repository-id} | Returns the Repository actor for a repo |
 | [**activitypub_repository_inbox**](ActivitypubApi.md#activitypub_repository_inbox) | **POST** /activitypub/repository-id/{repository-id}/inbox | Send to the inbox |
 
 
+## activitypub_instance_actor
+
+> <ActivityPub> activitypub_instance_actor
+
+Returns the instance's Actor
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::ActivitypubApi.new
+
+begin
+  # Returns the instance's Actor
+  result = api_instance.activitypub_instance_actor
+  p result
+rescue Forgejo::ApiError => e
+  puts "Error when calling ActivitypubApi->activitypub_instance_actor: #{e}"
+end
+```
+
+#### Using the activitypub_instance_actor_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ActivityPub>, Integer, Hash)> activitypub_instance_actor_with_http_info
+
+```ruby
+begin
+  # Returns the instance's Actor
+  data, status_code, headers = api_instance.activitypub_instance_actor_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ActivityPub>
+rescue Forgejo::ApiError => e
+  puts "Error when calling ActivitypubApi->activitypub_instance_actor_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ActivityPub**](ActivityPub.md)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## activitypub_instance_actor_inbox
+
+> activitypub_instance_actor_inbox
+
+Send to the inbox
+
+### Examples
+
+```ruby
+require 'time'
+require 'forgejo'
+# setup authorization
+Forgejo.configure do |config|
+  # Configure API key authorization: AuthorizationHeaderToken
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Forgejo::ActivitypubApi.new
+
+begin
+  # Send to the inbox
+  api_instance.activitypub_instance_actor_inbox
+rescue Forgejo::ApiError => e
+  puts "Error when calling ActivitypubApi->activitypub_instance_actor_inbox: #{e}"
+end
+```
+
+#### Using the activitypub_instance_actor_inbox_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> activitypub_instance_actor_inbox_with_http_info
+
+```ruby
+begin
+  # Send to the inbox
+  data, status_code, headers = api_instance.activitypub_instance_actor_inbox_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Forgejo::ApiError => e
+  puts "Error when calling ActivitypubApi->activitypub_instance_actor_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## activitypub_person
 
 > <ActivityPub> activitypub_person(user_id)