clientapi_forgejo.MiscellaneousApi

All URIs are relative to /api/v1

Method	HTTP request	Description
get_gitignore_template_info	GET /gitignore/templates/{name}	Returns information about a gitignore template
get_label_template_info	GET /label/templates/{name}	Returns all labels in a template
get_license_template_info	GET /licenses/{name}	Returns information about a license template
get_node_info	GET /nodeinfo	Returns the nodeinfo of the Gitea application
get_signing_key	GET /signing-key.gpg	Get default signing-key.gpg
get_version	GET /version	Returns the version of the Gitea application
list_gitignores_templates	GET /gitignore/templates	Returns a list of all gitignore templates
list_label_templates	GET /label/templates	Returns a list of all label templates
list_license_templates	GET /licenses	Returns a list of all license templates
render_markdown	POST /markdown	Render a markdown document as HTML
render_markdown_raw	POST /markdown/raw	Render raw markdown as HTML
render_markup	POST /markup	Render a markup document as HTML

get_gitignore_template_info

GitignoreTemplateInfo get_gitignore_template_info(name)

Returns information about a gitignore template

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.gitignore_template_info import GitignoreTemplateInfo
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.MiscellaneousApi(api_client)
    name = 'name_example' # str | name of the template

    try:
        # Returns information about a gitignore template
        api_response = api_instance.get_gitignore_template_info(name)
        print("The response of MiscellaneousApi->get_gitignore_template_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_gitignore_template_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the template

Return type

GitignoreTemplateInfo

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	GitignoreTemplateInfo	-
404	APINotFound is a not found error response	-

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

get_label_template_info

List[LabelTemplate] get_label_template_info(name)

Returns all labels in a template

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.label_template import LabelTemplate
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.MiscellaneousApi(api_client)
    name = 'name_example' # str | name of the template

    try:
        # Returns all labels in a template
        api_response = api_instance.get_label_template_info(name)
        print("The response of MiscellaneousApi->get_label_template_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_label_template_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the template

Return type

List[LabelTemplate]

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	LabelTemplateInfo	-
404	APINotFound is a not found error response	-

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

get_license_template_info

LicenseTemplateInfo get_license_template_info(name)

Returns information about a license template

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.license_template_info import LicenseTemplateInfo
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.MiscellaneousApi(api_client)
    name = 'name_example' # str | name of the license

    try:
        # Returns information about a license template
        api_response = api_instance.get_license_template_info(name)
        print("The response of MiscellaneousApi->get_license_template_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_license_template_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the license

Return type

LicenseTemplateInfo

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	LicenseTemplateInfo	-
404	APINotFound is a not found error response	-

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

get_node_info

NodeInfo get_node_info()

Returns the nodeinfo of the Gitea application

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.node_info import NodeInfo
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.MiscellaneousApi(api_client)

    try:
        # Returns the nodeinfo of the Gitea application
        api_response = api_instance.get_node_info()
        print("The response of MiscellaneousApi->get_node_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_node_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NodeInfo

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	NodeInfo	-

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

get_signing_key

str get_signing_key()

Get default signing-key.gpg

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.MiscellaneousApi(api_client)

    try:
        # Get default signing-key.gpg
        api_response = api_instance.get_signing_key()
        print("The response of MiscellaneousApi->get_signing_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_signing_key: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

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

HTTP request headers

Content-Type: Not defined
Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	GPG armored public key	-

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

get_version

ServerVersion get_version()

Returns the version of the Gitea application

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.server_version import ServerVersion
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.MiscellaneousApi(api_client)

    try:
        # Returns the version of the Gitea application
        api_response = api_instance.get_version()
        print("The response of MiscellaneousApi->get_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->get_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ServerVersion

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	ServerVersion	-

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

list_gitignores_templates

List[str] list_gitignores_templates()

Returns a list of all gitignore templates

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.MiscellaneousApi(api_client)

    try:
        # Returns a list of all gitignore templates
        api_response = api_instance.list_gitignores_templates()
        print("The response of MiscellaneousApi->list_gitignores_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->list_gitignores_templates: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

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	GitignoreTemplateList	-

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

list_label_templates

List[str] list_label_templates()

Returns a list of all label templates

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.MiscellaneousApi(api_client)

    try:
        # Returns a list of all label templates
        api_response = api_instance.list_label_templates()
        print("The response of MiscellaneousApi->list_label_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->list_label_templates: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

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	LabelTemplateList	-

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

list_license_templates

List[LicensesTemplateListEntry] list_license_templates()

Returns a list of all license templates

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.licenses_template_list_entry import LicensesTemplateListEntry
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.MiscellaneousApi(api_client)

    try:
        # Returns a list of all license templates
        api_response = api_instance.list_license_templates()
        print("The response of MiscellaneousApi->list_license_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->list_license_templates: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[LicensesTemplateListEntry]

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	LicenseTemplateList	-

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

render_markdown

str render_markdown(body=body)

Render a markdown document as HTML

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.markdown_option import MarkdownOption
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.MiscellaneousApi(api_client)
    body = clientapi_forgejo.MarkdownOption() # MarkdownOption |  (optional)

    try:
        # Render a markdown document as HTML
        api_response = api_instance.render_markdown(body=body)
        print("The response of MiscellaneousApi->render_markdown:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->render_markdown: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	MarkdownOption		[optional]

Return type

str

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: text/html

HTTP response details

Status code	Description	Response headers
200	MarkdownRender is a rendered markdown document	-
422	APIValidationError is error format response related to input validation	-

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

render_markdown_raw

str render_markdown_raw(body)

Render raw markdown as HTML

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.MiscellaneousApi(api_client)
    body = 'body_example' # str | Request body to render

    try:
        # Render raw markdown as HTML
        api_response = api_instance.render_markdown_raw(body)
        print("The response of MiscellaneousApi->render_markdown_raw:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->render_markdown_raw: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	Request body to render

Return type

str

Authorization

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

HTTP request headers

Content-Type: text/plain
Accept: text/html

HTTP response details

Status code	Description	Response headers
200	MarkdownRender is a rendered markdown document	-
422	APIValidationError is error format response related to input validation	-

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

render_markup

str render_markup(body=body)

Render a markup document as HTML

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.markup_option import MarkupOption
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.MiscellaneousApi(api_client)
    body = clientapi_forgejo.MarkupOption() # MarkupOption |  (optional)

    try:
        # Render a markup document as HTML
        api_response = api_instance.render_markup(body=body)
        print("The response of MiscellaneousApi->render_markup:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MiscellaneousApi->render_markup: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	MarkupOption		[optional]

Return type

str

Authorization

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

HTTP request headers

Content-Type: application/json
Accept: text/html

HTTP response details

Status code	Description	Response headers
200	MarkupRender is a rendered markup document	-
422	APIValidationError is error format response related to input validation	-

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

FilesExpand file tree

MiscellaneousApi.md

Latest commit

History

MiscellaneousApi.md

File metadata and controls

clientapi_forgejo.MiscellaneousApi

get_gitignore_template_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_label_template_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_license_template_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_node_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_signing_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_gitignores_templates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_label_templates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_license_templates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

render_markdown

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

render_markdown_raw

Example

Parameters