clientapi_forgejo.ActivitypubApi

All URIs are relative to /api/v1

Method	HTTP request	Description
activitypub_instance_actor	GET /activitypub/actor	Returns the instance's Actor
activitypub_instance_actor_inbox	POST /activitypub/actor/inbox	Send to the inbox
activitypub_person	GET /activitypub/user-id/{user-id}	Returns the Person actor for a user
activitypub_person_inbox	POST /activitypub/user-id/{user-id}/inbox	Send to the inbox
activitypub_repository	GET /activitypub/repository-id/{repository-id}	Returns the Repository actor for a repo
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

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.activity_pub import ActivityPub
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)

    try:
        # Returns the instance's Actor
        api_response = api_instance.activitypub_instance_actor()
        print("The response of ActivitypubApi->activitypub_instance_actor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_instance_actor: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ActivityPub

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ActivityPub	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activitypub_instance_actor_inbox

activitypub_instance_actor_inbox()

Send to the inbox

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)

    try:
        # Send to the inbox
        api_instance.activitypub_instance_actor_inbox()
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_instance_actor_inbox: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	APIEmpty is an empty response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activitypub_person

ActivityPub activitypub_person(user_id)

Returns the Person actor for a user

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.activity_pub import ActivityPub
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)
    user_id = 56 # int | user ID of the user

    try:
        # Returns the Person actor for a user
        api_response = api_instance.activitypub_person(user_id)
        print("The response of ActivitypubApi->activitypub_person:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_person: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	user ID of the user

Return type

ActivityPub

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ActivityPub	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activitypub_person_inbox

activitypub_person_inbox(user_id)

Send to the inbox

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)
    user_id = 56 # int | user ID of the user

    try:
        # Send to the inbox
        api_instance.activitypub_person_inbox(user_id)
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_person_inbox: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	user ID of the user

Return type

void (empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	APIEmpty is an empty response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activitypub_repository

ActivityPub activitypub_repository(repository_id)

Returns the Repository actor for a repo

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.activity_pub import ActivityPub
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)
    repository_id = 56 # int | repository ID of the repo

    try:
        # Returns the Repository actor for a repo
        api_response = api_instance.activitypub_repository(repository_id)
        print("The response of ActivitypubApi->activitypub_repository:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_repository: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository_id	int	repository ID of the repo

Return type

ActivityPub

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ActivityPub	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

activitypub_repository_inbox

activitypub_repository_inbox(repository_id, body=body)

Send to the inbox

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.ActivitypubApi(api_client)
    repository_id = 56 # int | repository ID of the repo
    body = None # object |  (optional)

    try:
        # Send to the inbox
        api_instance.activitypub_repository_inbox(repository_id, body=body)
    except Exception as e:
        print("Exception when calling ActivitypubApi->activitypub_repository_inbox: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository_id	int	repository ID of the repo
body	object		[optional]

Return type

void (empty response body)

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: application/json, text/plain
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	APIEmpty is an empty response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ActivitypubApi.md

Latest commit

History

ActivitypubApi.md

File metadata and controls

clientapi_forgejo.ActivitypubApi

activitypub_instance_actor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

activitypub_instance_actor_inbox

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

activitypub_person

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

activitypub_person_inbox

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

activitypub_repository

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

activitypub_repository_inbox

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details