gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

CommunityService

Attributes
api_key_header_key: strapi_key_header_prefix: struser_id_header_key: str
Functions
create_community_agent @classmethod
version_file : CommunityAgentFileDTO
form_data : CommunityCreateAgentDTO
Return type : CommunityAgentVersionCreateResDTO
create_community_agent_version @classmethod
version_file : CommunityAgentFileDTO
agent_id : str
Return type : CommunityAgentVersionCreateResDTO
fork_community_agent @classmethod
version_file : CommunityAgentFileDTO
form_data : CommunityCreateAgentDTO
agent_version_id : str
Return type : CommunityAgentVersionCreateResDTO
get_all_community_tag_values @classmethod

Get all community tag values for a given key

key : str
Return type : List
get_available_community_tags @classmethod
spaces_filter : List
key_filter : str
label_filter : str
personal_only : bool
page : int
number_of_items_per_page : int
Return type : PageDTO[CommunityTagKeyDTO]
get_community_agent @classmethod

Get a community agent by comunity agent version id

agent_version_id : str
Return type : CommunityAgentDTO
get_community_agent_and_check_rights @classmethod

Get a community agent by comunity agent version id and check if the user has the right to edit it, if not return None

agent_version_id : str
Return type : Optional
get_community_agent_version @classmethod

Get a community by its id

agent_version_id : str
Return type : CommunityAgentVersionDTO
get_community_available_agents @classmethod
spaces_filter : List
title_filter : str
personal_only : bool
page : int
number_of_items_per_page : int
Return type : PageDTO[CommunityAgentDTO]
get_community_available_space @classmethod
Return type : Any
get_community_tag_key @classmethod

Get a community tag key by its technical name

key : str
Return type : Optional
get_community_tag_value @classmethod

Get a community tag value by its key and value id

key : str
value_id : str
Return type : Optional
get_community_tag_values @classmethod
community_tag_key : str
page : int
number_of_items_per_page : int
Return type : PageDTO[CommunityTagValueDTO]
send_app_stat @classmethod
app_url : str
send_process_run_stats @classmethod
run_stats : List
share_tag_to_community @classmethod

Share a tag key and its values to the community

tag_key : CommunityTagKeyDTO
tag_values : List
publish_mode : Literal
space_selected : Optional
Return type : CommunityTagKeyDTO