diff --git a/docs/legacy/fixtures/v1.0.0.tar.gz b/docs/legacy/fixtures/v1.0.0.tar.gz new file mode 100644 index 00000000..253abdf0 Binary files /dev/null and b/docs/legacy/fixtures/v1.0.0.tar.gz differ diff --git a/docs/legacy/inventories/v1.0.0.json b/docs/legacy/inventories/v1.0.0.json new file mode 100644 index 00000000..0ca6d756 --- /dev/null +++ b/docs/legacy/inventories/v1.0.0.json @@ -0,0 +1,800 @@ +{ + "version": "1.0.0", + "canonical_prefix": "v1.0.0", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "./usage/basic_usage.md", + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 25, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + } + ], + "api_anchors": [ + "messages", + "messages.Message" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.1.json b/docs/legacy/inventories/v1.0.1.json new file mode 100644 index 00000000..f689326b --- /dev/null +++ b/docs/legacy/inventories/v1.0.1.json @@ -0,0 +1,806 @@ +{ + "version": "1.0.1", + "canonical_prefix": "v1.0.1", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + } + ], + "api_anchors": [ + "messages", + "messages.Message" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.10.json b/docs/legacy/inventories/v1.0.10.json new file mode 100644 index 00000000..7c40e87a --- /dev/null +++ b/docs/legacy/inventories/v1.0.10.json @@ -0,0 +1,817 @@ +{ + "version": "1.0.10", + "canonical_prefix": "v1.0.10", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.11.json b/docs/legacy/inventories/v1.0.11.json new file mode 100644 index 00000000..d3e5eb79 --- /dev/null +++ b/docs/legacy/inventories/v1.0.11.json @@ -0,0 +1,817 @@ +{ + "version": "1.0.11", + "canonical_prefix": "v1.0.11", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.12.json b/docs/legacy/inventories/v1.0.12.json new file mode 100644 index 00000000..933d22d0 --- /dev/null +++ b/docs/legacy/inventories/v1.0.12.json @@ -0,0 +1,828 @@ +{ + "version": "1.0.12", + "canonical_prefix": "v1.0.12", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.13.json b/docs/legacy/inventories/v1.0.13.json new file mode 100644 index 00000000..3bddd1cd --- /dev/null +++ b/docs/legacy/inventories/v1.0.13.json @@ -0,0 +1,828 @@ +{ + "version": "1.0.13", + "canonical_prefix": "v1.0.13", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.14.json b/docs/legacy/inventories/v1.0.14.json new file mode 100644 index 00000000..2b398d67 --- /dev/null +++ b/docs/legacy/inventories/v1.0.14.json @@ -0,0 +1,828 @@ +{ + "version": "1.0.14", + "canonical_prefix": "v1.0.14", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.15.json b/docs/legacy/inventories/v1.0.15.json new file mode 100644 index 00000000..6c28ef13 --- /dev/null +++ b/docs/legacy/inventories/v1.0.15.json @@ -0,0 +1,828 @@ +{ + "version": "1.0.15", + "canonical_prefix": "v1.0.15", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.16.json b/docs/legacy/inventories/v1.0.16.json new file mode 100644 index 00000000..4e197992 --- /dev/null +++ b/docs/legacy/inventories/v1.0.16.json @@ -0,0 +1,828 @@ +{ + "version": "1.0.16", + "canonical_prefix": "v1.0.16", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.2.json b/docs/legacy/inventories/v1.0.2.json new file mode 100644 index 00000000..2e3c241e --- /dev/null +++ b/docs/legacy/inventories/v1.0.2.json @@ -0,0 +1,806 @@ +{ + "version": "1.0.2", + "canonical_prefix": "v1.0.2", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + } + ], + "api_anchors": [ + "messages", + "messages.Message" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.3.json b/docs/legacy/inventories/v1.0.3.json new file mode 100644 index 00000000..cfd07895 --- /dev/null +++ b/docs/legacy/inventories/v1.0.3.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.3", + "canonical_prefix": "v1.0.3", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.5.json b/docs/legacy/inventories/v1.0.5.json new file mode 100644 index 00000000..f23b6666 --- /dev/null +++ b/docs/legacy/inventories/v1.0.5.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.5", + "canonical_prefix": "v1.0.5", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.6.json b/docs/legacy/inventories/v1.0.6.json new file mode 100644 index 00000000..cbfff543 --- /dev/null +++ b/docs/legacy/inventories/v1.0.6.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.6", + "canonical_prefix": "v1.0.6", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.7.json b/docs/legacy/inventories/v1.0.7.json new file mode 100644 index 00000000..b2255688 --- /dev/null +++ b/docs/legacy/inventories/v1.0.7.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.7", + "canonical_prefix": "v1.0.7", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.8.json b/docs/legacy/inventories/v1.0.8.json new file mode 100644 index 00000000..119af3bc --- /dev/null +++ b/docs/legacy/inventories/v1.0.8.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.8", + "canonical_prefix": "v1.0.8", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/reference/blocks", + "/reference/blocks/#blocks.DividerBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/elements", + "/reference/messages/", + "/reference/objects", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConversationFilter", + "/reference/objects/#objects.Option", + "/reference/objects/#objects.OptionGroup", + "/reference/objects/#objects.SlackFile", + "/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/reference/attachments/#attachments.Attachment", + "/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/reference/blocks/#blocks.RichTextBlock", + "/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "../../reference/rich_text", + "/reference/blocks/#blocks.SectionBlock", + "/reference/elements", + "/reference/rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.0.9.json b/docs/legacy/inventories/v1.0.9.json new file mode 100644 index 00000000..f4d70375 --- /dev/null +++ b/docs/legacy/inventories/v1.0.9.json @@ -0,0 +1,818 @@ +{ + "version": "1.0.9", + "canonical_prefix": "v1.0.9", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 13, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../blocks/#blocks.RichTextBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.1.1.json b/docs/legacy/inventories/v1.1.1.json new file mode 100644 index 00000000..74ffc1da --- /dev/null +++ b/docs/legacy/inventories/v1.1.1.json @@ -0,0 +1,840 @@ +{ + "version": "1.1.1", + "canonical_prefix": "v1.1.1", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock" + ], + "code_block_count": 9, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 14, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + } + ], + "api_anchors": [], + "code_block_count": 18, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.2.2.json b/docs/legacy/inventories/v1.2.2.json new file mode 100644 index 00000000..6b1ea609 --- /dev/null +++ b/docs/legacy/inventories/v1.2.2.json @@ -0,0 +1,870 @@ +{ + "version": "1.2.2", + "canonical_prefix": "v1.2.2", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + }, + { + "level": 3, + "id": "blocks.TableBlock", + "text": "TableBlock" + }, + { + "level": 4, + "id": "blocks.TableBlock._resolve_cell", + "text": "_resolve_cell" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock", + "blocks.TableBlock", + "blocks.TableBlock._resolve_cell" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.ColumnSettings", + "text": "ColumnSettings" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.RawText", + "text": "RawText" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.ColumnSettings", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.RawText", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 16, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + }, + { + "level": 2, + "id": "table-block", + "text": "Table Block" + } + ], + "api_anchors": [], + "code_block_count": 20, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png", + "../../img/usage/table.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.2.3.json b/docs/legacy/inventories/v1.2.3.json new file mode 100644 index 00000000..8d9118ca --- /dev/null +++ b/docs/legacy/inventories/v1.2.3.json @@ -0,0 +1,870 @@ +{ + "version": "1.2.3", + "canonical_prefix": "v1.2.3", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + }, + { + "level": 3, + "id": "blocks.TableBlock", + "text": "TableBlock" + }, + { + "level": 4, + "id": "blocks.TableBlock._resolve_cell", + "text": "_resolve_cell" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock", + "blocks.TableBlock", + "blocks.TableBlock._resolve_cell" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.ColumnSettings", + "text": "ColumnSettings" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.RawText", + "text": "RawText" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.ColumnSettings", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.RawText", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 16, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + }, + { + "level": 2, + "id": "table-block", + "text": "Table Block" + } + ], + "api_anchors": [], + "code_block_count": 20, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png", + "../../img/usage/table.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.2.4.json b/docs/legacy/inventories/v1.2.4.json new file mode 100644 index 00000000..0416f44b --- /dev/null +++ b/docs/legacy/inventories/v1.2.4.json @@ -0,0 +1,870 @@ +{ + "version": "1.2.4", + "canonical_prefix": "v1.2.4", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 0, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "/elements/#elements.CheckboxGroup", + "/latest/reference/blocks", + "/latest/reference/blocks/#blocks.DividerBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/elements", + "/latest/reference/messages/", + "/latest/reference/objects", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.Text", + "reference/views/", + "usage/installation/", + "usage/sending_messages/", + "usage/using_blocks/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + }, + { + "level": 3, + "id": "blocks.TableBlock", + "text": "TableBlock" + }, + { + "level": 4, + "id": "blocks.TableBlock._resolve_cell", + "text": "_resolve_cell" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock", + "blocks.TableBlock", + "blocks.TableBlock._resolve_cell" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.ColumnSettings", + "text": "ColumnSettings" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.RawText", + "text": "RawText" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.ColumnSettings", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.RawText", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 16, + "images": [], + "internal_links": [ + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Installation" + }, + { + "level": 2, + "id": "installing-slackblocks", + "text": "Installing slackblocks" + }, + { + "level": 2, + "id": "uninstalling-slackblocks", + "text": "Uninstalling slackblocks" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Sending Messages" + }, + { + "level": 3, + "id": "sending-a-message-with-the-modern-slack-sdk-library", + "text": "Sending a Message with the (Modern) slack-sdk Library" + }, + { + "level": 3, + "id": "sending-a-message-with-the-legacy-slackclient-library", + "text": "Sending a Message with the (Legacy) slackclient Library" + } + ], + "api_anchors": [], + "code_block_count": 6, + "images": [ + "../../img/hello_world.png", + "../../img/hello_world.png" + ], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + }, + { + "level": 2, + "id": "table-block", + "text": "Table Block" + } + ], + "api_anchors": [], + "code_block_count": 20, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/divider.png", + "../../img/usage/actions.png", + "../../img/usage/table.png" + ], + "internal_links": [ + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v1.2.5.json b/docs/legacy/inventories/v1.2.5.json new file mode 100644 index 00000000..8495c3e2 --- /dev/null +++ b/docs/legacy/inventories/v1.2.5.json @@ -0,0 +1,1194 @@ +{ + "version": "1.2.5", + "canonical_prefix": "v1.2.5", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "quickstart", + "text": "Quickstart" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 2, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "contributing/", + "reference/blocks/", + "reference/blocks/#blocks.ActionsBlock", + "reference/blocks/#blocks.ContextBlock", + "reference/blocks/#blocks.DividerBlock", + "reference/blocks/#blocks.FileBlock", + "reference/blocks/#blocks.HeaderBlock", + "reference/blocks/#blocks.ImageBlock", + "reference/blocks/#blocks.InputBlock", + "reference/blocks/#blocks.RichTextBlock", + "reference/blocks/#blocks.SectionBlock", + "reference/blocks/#blocks.TableBlock", + "reference/elements/", + "reference/elements/#elements.CheckboxGroup", + "reference/messages/", + "reference/messages/#messages.Message", + "reference/messages/#messages.MessageResponse", + "reference/messages/#messages.WebhookMessage", + "reference/objects/", + "reference/objects/#objects.Confirm", + "reference/objects/#objects.Option", + "reference/objects/#objects.Text", + "reference/views/", + "usage/cookbook/", + "usage/installation/", + "usage/sending_messages/", + "usage/troubleshooting/", + "usage/using_blocks/" + ] + }, + { + "route": "/contributing", + "published_title": "Contributing - slackblocks", + "headings": [ + { + "level": 1, + "id": "contributing", + "text": "Contributing" + }, + { + "level": 2, + "id": "where-to-start", + "text": "Where to start" + }, + { + "level": 2, + "id": "local-development-setup", + "text": "Local development setup" + }, + { + "level": 3, + "id": "python-version", + "text": "Python version" + }, + { + "level": 2, + "id": "running-checks", + "text": "Running checks" + }, + { + "level": 3, + "id": "unit-tests", + "text": "Unit tests" + }, + { + "level": 3, + "id": "black-formatting", + "text": "Black formatting" + }, + { + "level": 3, + "id": "flake8-linting", + "text": "flake8 linting" + }, + { + "level": 3, + "id": "mypy-type-checking", + "text": "mypy type checking" + }, + { + "level": 3, + "id": "twine-package-check", + "text": "twine package check" + }, + { + "level": 3, + "id": "run-everything-in-one-go", + "text": "Run everything in one go" + }, + { + "level": 2, + "id": "working-on-the-docs", + "text": "Working on the docs" + }, + { + "level": 3, + "id": "updating-docstrings", + "text": "Updating docstrings" + }, + { + "level": 3, + "id": "versioned-docs", + "text": "Versioned docs" + }, + { + "level": 2, + "id": "validation-in-the-library", + "text": "Validation in the library" + }, + { + "level": 2, + "id": "pull-request-checklist", + "text": "Pull request checklist" + }, + { + "level": 2, + "id": "project-layout", + "text": "Project layout" + }, + { + "level": 2, + "id": "releases", + "text": "Releases" + }, + { + "level": 2, + "id": "questions", + "text": "Questions?" + } + ], + "api_anchors": [], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../usage/cookbook/", + "../usage/troubleshooting/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "../../usage/cookbook/#deprecated-colored-bar-attachment", + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + }, + { + "level": 3, + "id": "blocks.TableBlock", + "text": "TableBlock" + }, + { + "level": 4, + "id": "blocks.TableBlock._resolve_cell", + "text": "_resolve_cell" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ContextBlock", + "blocks.DividerBlock", + "blocks.FileBlock", + "blocks.HeaderBlock", + "blocks.ImageBlock", + "blocks.InputBlock", + "blocks.RichTextBlock", + "blocks.SectionBlock", + "blocks.TableBlock", + "blocks.TableBlock._resolve_cell" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../../usage/using_blocks/", + "../elements/", + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "../blocks/#blocks.ActionsBlock", + "../blocks/#blocks.InputBlock", + "../blocks/#blocks.SectionBlock", + "../objects/", + "../objects/#objects.ConfirmationDialogue", + "../objects/#objects.Option", + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.MessageResponse", + "text": "MessageResponse" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.MessageResponse", + "messages.ResponseType", + "messages.WebhookMessage" + ], + "code_block_count": 4, + "images": [], + "internal_links": [ + "../../usage/sending_messages/", + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "../../usage/cookbook/#confirmation-modal", + "../views/#views.ModalView", + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.ColumnSettings", + "text": "ColumnSettings" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 3, + "id": "objects.RawText", + "text": "RawText" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + } + ], + "api_anchors": [ + "objects", + "objects.ColumnSettings", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConversationFilter", + "objects.DispatchActionConfiguration", + "objects.InputParameter", + "objects.Option", + "objects.OptionGroup", + "objects.RawText", + "objects.SlackFile", + "objects.Text", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Workflow" + ], + "code_block_count": 16, + "images": [], + "internal_links": [ + "../blocks/", + "../elements/", + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../../usage/cookbook/#rich-formatted-alert", + "../blocks/#blocks.RichTextBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 6, + "images": [], + "internal_links": [] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/cookbook", + "published_title": "Cookbook - slackblocks", + "headings": [ + { + "level": 1, + "id": "cookbook", + "text": "Cookbook" + }, + { + "level": 2, + "id": "build-status-notification", + "text": "Build status notification" + }, + { + "level": 2, + "id": "approval-request-with-action-buttons", + "text": "Approval request with action buttons" + }, + { + "level": 2, + "id": "rich-formatted-alert", + "text": "Rich-formatted alert" + }, + { + "level": 2, + "id": "confirmation-modal", + "text": "Confirmation modal" + }, + { + "level": 2, + "id": "threaded-reply", + "text": "Threaded reply" + }, + { + "level": 2, + "id": "ephemeral-slash-command-response", + "text": "Ephemeral slash-command response" + }, + { + "level": 2, + "id": "multi-column-status-report-table", + "text": "Multi-column status report (table)" + }, + { + "level": 2, + "id": "deprecated-colored-bar-attachment", + "text": "Deprecated: colored-bar attachment" + } + ], + "api_anchors": [], + "code_block_count": 8, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "installation", + "text": "Installation" + }, + { + "level": 2, + "id": "requirements", + "text": "Requirements" + }, + { + "level": 2, + "id": "verifying-your-installation", + "text": "Verifying your installation" + }, + { + "level": 2, + "id": "version-pinning", + "text": "Version pinning" + }, + { + "level": 2, + "id": "uninstalling", + "text": "Uninstalling" + } + ], + "api_anchors": [], + "code_block_count": 11, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "sending-messages", + "text": "Sending Messages" + }, + { + "level": 2, + "id": "with-the-modern-slack-sdk", + "text": "With the modern slack-sdk" + }, + { + "level": 2, + "id": "with-the-legacy-slackclient", + "text": "With the legacy slackclient" + }, + { + "level": 2, + "id": "other-delivery-surfaces", + "text": "Other delivery surfaces" + }, + { + "level": 3, + "id": "incoming-webhooks", + "text": "Incoming webhooks" + }, + { + "level": 3, + "id": "slash-command-interaction-responses", + "text": "Slash command / interaction responses" + }, + { + "level": 3, + "id": "modals-home-tabs", + "text": "Modals & home tabs" + }, + { + "level": 2, + "id": "sending-without-an-sdk", + "text": "Sending without an SDK" + } + ], + "api_anchors": [], + "code_block_count": 8, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [ + "../../reference/modals/", + "../../reference/views/" + ] + }, + { + "route": "/usage/troubleshooting", + "published_title": "Troubleshooting & FAQ - slackblocks", + "headings": [ + { + "level": 1, + "id": "troubleshooting-faq", + "text": "Troubleshooting & FAQ" + }, + { + "level": 2, + "id": "why-is-my-message-body-coming-through-with-literal-asterisks-instead-of-bold", + "text": "Why is my message body coming through with literal *asterisks* instead of bold?" + }, + { + "level": 2, + "id": "why-does-my-message-say-text-is-required", + "text": "Why does my message say text is required?" + }, + { + "level": 2, + "id": "what-is-block_id-for-should-i-set-it", + "text": "What is block_id for? Should I set it?" + }, + { + "level": 2, + "id": "what-does-invalidusageerror-exceeds-limit-of-n-characters-mean", + "text": "What does InvalidUsageError: ... exceeds limit of N characters mean?" + }, + { + "level": 2, + "id": "how-many-blocks-can-a-single-message-have", + "text": "How many blocks can a single message have?" + }, + { + "level": 2, + "id": "my-buttons-selects-dont-do-anything-when-clicked", + "text": "My buttons / selects don't do anything when clicked." + }, + { + "level": 2, + "id": "why-doesnt-markdown-work-inside-a-headerblock", + "text": "Why doesn't markdown work inside a HeaderBlock?" + }, + { + "level": 2, + "id": "how-do-i-preview-a-message-without-actually-sending-it", + "text": "How do I preview a message without actually sending it?" + }, + { + "level": 2, + "id": "how-do-i-send-a-slackblocksmessage-with-requests", + "text": "How do I send a slackblocks.Message with requests?" + }, + { + "level": 2, + "id": "can-i-use-slackblocks-with-async-code", + "text": "Can I use slackblocks with async code?" + }, + { + "level": 2, + "id": "how-does-slackblocks-compare-to-the-block-classes-in-slack-sdk", + "text": "How does slackblocks compare to the block classes in slack-sdk?" + }, + { + "level": 2, + "id": "im-getting-a-pytest-error-from-a-python-deprecationwarning", + "text": "I'm getting a pytest error from a Python DeprecationWarning." + }, + { + "level": 2, + "id": "where-do-i-report-bugs-request-features", + "text": "Where do I report bugs / request features?" + } + ], + "api_anchors": [], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "using-blocks", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + }, + { + "level": 2, + "id": "table-block", + "text": "Table Block" + } + ], + "api_anchors": [], + "code_block_count": 20, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/context.png", + "../../img/usage/actions.png", + "../../img/usage/table.png" + ], + "internal_links": [ + "../../reference/blocks/", + "../../reference/elements/", + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/inventories/v2.0.0.json b/docs/legacy/inventories/v2.0.0.json new file mode 100644 index 00000000..62e4970e --- /dev/null +++ b/docs/legacy/inventories/v2.0.0.json @@ -0,0 +1,1639 @@ +{ + "version": "2.0.0", + "canonical_prefix": "v2.0.0", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "pages": [ + { + "route": "/", + "published_title": "slackblocks", + "headings": [ + { + "level": 1, + "id": "welcome-to-slackblocks", + "text": "Welcome to slackblocks!" + }, + { + "level": 2, + "id": "quickstart", + "text": "Quickstart" + }, + { + "level": 2, + "id": "components", + "text": "Components" + }, + { + "level": 3, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 2, + "id": "guides", + "text": "Guides" + } + ], + "api_anchors": [], + "code_block_count": 2, + "images": [ + "./img/sb.png" + ], + "internal_links": [ + "contributing/", + "reference/blocks/", + "reference/blocks/#blocks.ActionsBlock", + "reference/blocks/#blocks.Block.from_dict", + "reference/blocks/#blocks.ContextBlock", + "reference/blocks/#blocks.DividerBlock", + "reference/blocks/#blocks.FileBlock", + "reference/blocks/#blocks.HeaderBlock", + "reference/blocks/#blocks.ImageBlock", + "reference/blocks/#blocks.InputBlock", + "reference/blocks/#blocks.MarkdownBlock", + "reference/blocks/#blocks.RichTextBlock", + "reference/blocks/#blocks.SectionBlock", + "reference/blocks/#blocks.TableBlock", + "reference/blocks/#blocks.VideoBlock", + "reference/elements/", + "reference/elements/#elements.CheckboxGroup", + "reference/messages/", + "reference/messages/#messages.Message", + "reference/messages/#messages.MessageResponse", + "reference/messages/#messages.WebhookMessage", + "reference/objects/", + "reference/objects/#objects.Confirm", + "reference/objects/#objects.Markdown", + "reference/objects/#objects.Option", + "reference/objects/#objects.PlainText", + "reference/objects/#objects.Text", + "reference/utils/#builder.block_kit_builder_url", + "reference/views/", + "usage/compatibility/", + "usage/cookbook/", + "usage/installation/", + "usage/migration/", + "usage/sending_messages/", + "usage/troubleshooting/", + "usage/using_blocks/" + ] + }, + { + "route": "/contributing", + "published_title": "Contributing - slackblocks", + "headings": [ + { + "level": 1, + "id": "contributing", + "text": "Contributing" + }, + { + "level": 2, + "id": "where-to-start", + "text": "Where to start" + }, + { + "level": 2, + "id": "local-development-setup", + "text": "Local development setup" + }, + { + "level": 3, + "id": "python-version", + "text": "Python version" + }, + { + "level": 2, + "id": "running-checks", + "text": "Running checks" + }, + { + "level": 3, + "id": "unit-tests", + "text": "Unit tests" + }, + { + "level": 3, + "id": "black-formatting", + "text": "Black formatting" + }, + { + "level": 3, + "id": "flake8-linting", + "text": "flake8 linting" + }, + { + "level": 3, + "id": "mypy-type-checking", + "text": "mypy type checking" + }, + { + "level": 3, + "id": "twine-package-check", + "text": "twine package check" + }, + { + "level": 3, + "id": "run-everything-in-one-go", + "text": "Run everything in one go" + }, + { + "level": 2, + "id": "working-on-the-docs", + "text": "Working on the docs" + }, + { + "level": 3, + "id": "updating-docstrings", + "text": "Updating docstrings" + }, + { + "level": 3, + "id": "versioned-docs", + "text": "Versioned docs" + }, + { + "level": 2, + "id": "validation-in-the-library", + "text": "Validation in the library" + }, + { + "level": 2, + "id": "pull-request-checklist", + "text": "Pull request checklist" + }, + { + "level": 2, + "id": "project-layout", + "text": "Project layout" + }, + { + "level": 2, + "id": "releases", + "text": "Releases" + }, + { + "level": 2, + "id": "questions", + "text": "Questions?" + } + ], + "api_anchors": [], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../usage/cookbook/", + "../usage/troubleshooting/" + ] + }, + { + "route": "/reference/attachments", + "published_title": "Attachments - slackblocks", + "headings": [ + { + "level": 1, + "id": "attachments", + "text": "Attachments" + }, + { + "level": 3, + "id": "attachments.Attachment", + "text": "Attachment" + }, + { + "level": 3, + "id": "attachments.Color", + "text": "Color" + }, + { + "level": 3, + "id": "attachments.Field", + "text": "Field" + } + ], + "api_anchors": [ + "attachments", + "attachments.Attachment", + "attachments.Color", + "attachments.Field" + ], + "code_block_count": 3, + "images": [], + "internal_links": [ + "../../usage/cookbook/#deprecated-colored-bar-attachment", + "/latest/reference/attachments/#attachments.Attachment" + ] + }, + { + "route": "/reference/blocks", + "published_title": "Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "blocks", + "text": "Blocks" + }, + { + "level": 3, + "id": "blocks.ActionsBlock", + "text": "ActionsBlock" + }, + { + "level": 4, + "id": "blocks.ActionsBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.Block", + "text": "Block" + }, + { + "level": 4, + "id": "blocks.Block.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.ContextBlock", + "text": "ContextBlock" + }, + { + "level": 4, + "id": "blocks.ContextBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.DividerBlock", + "text": "DividerBlock" + }, + { + "level": 4, + "id": "blocks.DividerBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.FileBlock", + "text": "FileBlock" + }, + { + "level": 4, + "id": "blocks.FileBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.HeaderBlock", + "text": "HeaderBlock" + }, + { + "level": 4, + "id": "blocks.HeaderBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.ImageBlock", + "text": "ImageBlock" + }, + { + "level": 4, + "id": "blocks.ImageBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.InputBlock", + "text": "InputBlock" + }, + { + "level": 4, + "id": "blocks.InputBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.MarkdownBlock", + "text": "MarkdownBlock" + }, + { + "level": 4, + "id": "blocks.MarkdownBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.RichTextBlock", + "text": "RichTextBlock" + }, + { + "level": 4, + "id": "blocks.RichTextBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.SectionBlock", + "text": "SectionBlock" + }, + { + "level": 4, + "id": "blocks.SectionBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.TableBlock", + "text": "TableBlock" + }, + { + "level": 4, + "id": "blocks.TableBlock._resolve_cell", + "text": "_resolve_cell" + }, + { + "level": 4, + "id": "blocks.TableBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "blocks.VideoBlock", + "text": "VideoBlock" + }, + { + "level": 4, + "id": "blocks.VideoBlock.from_dict", + "text": "from_dict classmethod" + } + ], + "api_anchors": [ + "blocks", + "blocks.ActionsBlock", + "blocks.ActionsBlock.from_dict", + "blocks.Block", + "blocks.Block.from_dict", + "blocks.ContextBlock", + "blocks.ContextBlock.from_dict", + "blocks.DividerBlock", + "blocks.DividerBlock.from_dict", + "blocks.FileBlock", + "blocks.FileBlock.from_dict", + "blocks.HeaderBlock", + "blocks.HeaderBlock.from_dict", + "blocks.ImageBlock", + "blocks.ImageBlock.from_dict", + "blocks.InputBlock", + "blocks.InputBlock.from_dict", + "blocks.MarkdownBlock", + "blocks.MarkdownBlock.from_dict", + "blocks.RichTextBlock", + "blocks.RichTextBlock.from_dict", + "blocks.SectionBlock", + "blocks.SectionBlock.from_dict", + "blocks.TableBlock", + "blocks.TableBlock._resolve_cell", + "blocks.TableBlock.from_dict", + "blocks.VideoBlock", + "blocks.VideoBlock.from_dict" + ], + "code_block_count": 27, + "images": [], + "internal_links": [ + "../../usage/using_blocks/", + "../elements/", + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + }, + { + "route": "/reference/elements", + "published_title": "Elements - slackblocks", + "headings": [ + { + "level": 1, + "id": "elements", + "text": "Elements" + }, + { + "level": 3, + "id": "elements.ButtonStyleName", + "text": "ButtonStyleName module-attribute" + }, + { + "level": 3, + "id": "elements.Button", + "text": "Button" + }, + { + "level": 3, + "id": "elements.ButtonStyle", + "text": "ButtonStyle" + }, + { + "level": 3, + "id": "elements.ChannelMultiSelectMenu", + "text": "ChannelMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ChannelSelectMenu", + "text": "ChannelSelectMenu" + }, + { + "level": 3, + "id": "elements.CheckboxGroup", + "text": "CheckboxGroup" + }, + { + "level": 3, + "id": "elements.ConversationMultiSelectMenu", + "text": "ConversationMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ConversationSelectMenu", + "text": "ConversationSelectMenu" + }, + { + "level": 3, + "id": "elements.DatePicker", + "text": "DatePicker" + }, + { + "level": 3, + "id": "elements.DateTimePicker", + "text": "DateTimePicker" + }, + { + "level": 3, + "id": "elements.EmailInput", + "text": "EmailInput" + }, + { + "level": 3, + "id": "elements.ExternalMultiSelectMenu", + "text": "ExternalMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.ExternalSelectMenu", + "text": "ExternalSelectMenu" + }, + { + "level": 3, + "id": "elements.FileInput", + "text": "FileInput" + }, + { + "level": 3, + "id": "elements.Image", + "text": "Image" + }, + { + "level": 3, + "id": "elements.NumberInput", + "text": "NumberInput" + }, + { + "level": 3, + "id": "elements.OverflowMenu", + "text": "OverflowMenu" + }, + { + "level": 3, + "id": "elements.PlainTextInput", + "text": "PlainTextInput" + }, + { + "level": 3, + "id": "elements.RadioButtonGroup", + "text": "RadioButtonGroup" + }, + { + "level": 3, + "id": "elements.RichTextInput", + "text": "RichTextInput" + }, + { + "level": 3, + "id": "elements.StaticMultiSelectMenu", + "text": "StaticMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.StaticSelectMenu", + "text": "StaticSelectMenu" + }, + { + "level": 3, + "id": "elements.TimePicker", + "text": "TimePicker" + }, + { + "level": 3, + "id": "elements.URLInput", + "text": "URLInput" + }, + { + "level": 3, + "id": "elements.UserMultiSelectMenu", + "text": "UserMultiSelectMenu" + }, + { + "level": 3, + "id": "elements.UserSelectMenu", + "text": "UserSelectMenu" + }, + { + "level": 3, + "id": "elements.WorkflowButton", + "text": "WorkflowButton" + } + ], + "api_anchors": [ + "elements", + "elements.ButtonStyleName", + "elements.Button", + "elements.ButtonStyle", + "elements.ChannelMultiSelectMenu", + "elements.ChannelSelectMenu", + "elements.CheckboxGroup", + "elements.ConversationMultiSelectMenu", + "elements.ConversationSelectMenu", + "elements.DatePicker", + "elements.DateTimePicker", + "elements.EmailInput", + "elements.ExternalMultiSelectMenu", + "elements.ExternalSelectMenu", + "elements.FileInput", + "elements.Image", + "elements.NumberInput", + "elements.OverflowMenu", + "elements.PlainTextInput", + "elements.RadioButtonGroup", + "elements.RichTextInput", + "elements.StaticMultiSelectMenu", + "elements.StaticSelectMenu", + "elements.TimePicker", + "elements.URLInput", + "elements.UserMultiSelectMenu", + "elements.UserSelectMenu", + "elements.WorkflowButton" + ], + "code_block_count": 26, + "images": [], + "internal_links": [ + "../blocks/#blocks.ActionsBlock", + "../blocks/#blocks.InputBlock", + "../blocks/#blocks.SectionBlock", + "../objects/", + "../objects/#objects.ConfirmationDialogue", + "../objects/#objects.Option", + "/latest/reference/objects/#objects.ConversationFilter", + "/latest/reference/objects/#objects.Option", + "/latest/reference/objects/#objects.OptionGroup", + "/latest/reference/objects/#objects.SlackFile", + "/latest/reference/objects/#objects.Workflow" + ] + }, + { + "route": "/reference/messages", + "published_title": "Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "messages", + "text": "Messages" + }, + { + "level": 3, + "id": "messages.Message", + "text": "Message" + }, + { + "level": 3, + "id": "messages.MessageResponse", + "text": "MessageResponse" + }, + { + "level": 3, + "id": "messages.ResponseType", + "text": "ResponseType" + }, + { + "level": 3, + "id": "messages.WebhookMessage", + "text": "WebhookMessage" + }, + { + "level": 3, + "id": "messages._MessagePayloadMixin", + "text": "_MessagePayloadMixin" + } + ], + "api_anchors": [ + "messages", + "messages.Message", + "messages.MessageResponse", + "messages.ResponseType", + "messages.WebhookMessage", + "messages._MessagePayloadMixin" + ], + "code_block_count": 5, + "images": [], + "internal_links": [ + "../../usage/sending_messages/", + "/latest/reference/attachments/#attachments.Attachment", + "/latest/reference/blocks" + ] + }, + { + "route": "/reference/modals", + "published_title": "Modals - slackblocks", + "headings": [ + { + "level": 1, + "id": "modals", + "text": "Modals" + }, + { + "level": 3, + "id": "modals.Modal", + "text": "Modal" + } + ], + "api_anchors": [ + "modals", + "modals.Modal" + ], + "code_block_count": 1, + "images": [], + "internal_links": [ + "../../usage/cookbook/#confirmation-modal", + "../views/#views.ModalView", + "/latest/reference/views/#views.ModalView" + ] + }, + { + "route": "/reference/objects", + "published_title": "Objects - slackblocks", + "headings": [ + { + "level": 1, + "id": "objects", + "text": "Objects" + }, + { + "level": 3, + "id": "objects.ColumnAlignment", + "text": "ColumnAlignment module-attribute" + }, + { + "level": 3, + "id": "objects.ConversationType", + "text": "ConversationType module-attribute" + }, + { + "level": 3, + "id": "objects.ColumnSettings", + "text": "ColumnSettings" + }, + { + "level": 3, + "id": "objects.Confirm", + "text": "Confirm" + }, + { + "level": 3, + "id": "objects.ConfirmationDialogue", + "text": "ConfirmationDialogue" + }, + { + "level": 4, + "id": "objects.ConfirmationDialogue.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.ConversationFilter", + "text": "ConversationFilter" + }, + { + "level": 4, + "id": "objects.ConversationFilter.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.DispatchActionConfiguration", + "text": "DispatchActionConfiguration" + }, + { + "level": 4, + "id": "objects.DispatchActionConfiguration.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.InputParameter", + "text": "InputParameter" + }, + { + "level": 4, + "id": "objects.InputParameter.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.Markdown", + "text": "Markdown" + }, + { + "level": 3, + "id": "objects.Option", + "text": "Option" + }, + { + "level": 4, + "id": "objects.Option.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.OptionGroup", + "text": "OptionGroup" + }, + { + "level": 4, + "id": "objects.OptionGroup.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.PlainText", + "text": "PlainText" + }, + { + "level": 3, + "id": "objects.RawText", + "text": "RawText" + }, + { + "level": 3, + "id": "objects.SlackFile", + "text": "SlackFile" + }, + { + "level": 4, + "id": "objects.SlackFile.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.Text", + "text": "Text" + }, + { + "level": 4, + "id": "objects.Text.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text", + "text": "to_text staticmethod" + }, + { + "level": 4, + "id": "objects.Text.to_text_nonnull", + "text": "to_text_nonnull staticmethod" + }, + { + "level": 3, + "id": "objects.TextType", + "text": "TextType" + }, + { + "level": 3, + "id": "objects.Trigger", + "text": "Trigger" + }, + { + "level": 4, + "id": "objects.Trigger.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 3, + "id": "objects.Workflow", + "text": "Workflow" + }, + { + "level": 4, + "id": "objects.Workflow.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 4, + "id": "objects.Workflow.from_url", + "text": "from_url classmethod" + } + ], + "api_anchors": [ + "objects", + "objects.ColumnAlignment", + "objects.ConversationType", + "objects.ColumnSettings", + "objects.Confirm", + "objects.ConfirmationDialogue", + "objects.ConfirmationDialogue.from_dict", + "objects.ConversationFilter", + "objects.ConversationFilter.from_dict", + "objects.DispatchActionConfiguration", + "objects.DispatchActionConfiguration.from_dict", + "objects.InputParameter", + "objects.InputParameter.from_dict", + "objects.Markdown", + "objects.Option", + "objects.Option.from_dict", + "objects.OptionGroup", + "objects.OptionGroup.from_dict", + "objects.PlainText", + "objects.RawText", + "objects.SlackFile", + "objects.SlackFile.from_dict", + "objects.Text", + "objects.Text.from_dict", + "objects.Text.to_text", + "objects.Text.to_text_nonnull", + "objects.TextType", + "objects.Trigger", + "objects.Trigger.from_dict", + "objects.Workflow", + "objects.Workflow.from_dict", + "objects.Workflow.from_url" + ], + "code_block_count": 29, + "images": [], + "internal_links": [ + "../blocks/", + "../elements/", + "/latest/reference/objects/#objects.ConfirmationDialogue" + ] + }, + { + "route": "/reference/rich_text", + "published_title": "Rich Text - slackblocks", + "headings": [ + { + "level": 1, + "id": "rich-text", + "text": "Rich Text" + }, + { + "level": 2, + "id": "rich-text-elements-primitives", + "text": "Rich Text Elements (Primitives)" + }, + { + "level": 3, + "id": "rich_text.elements.RichText", + "text": "RichText" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextChannel", + "text": "RichTextChannel" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextEmoji", + "text": "RichTextEmoji" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextLink", + "text": "RichTextLink" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUser", + "text": "RichTextUser" + }, + { + "level": 3, + "id": "rich_text.elements.RichTextUserGroup", + "text": "RichTextUserGroup" + }, + { + "level": 3, + "id": "rich_text.elements._style_dict", + "text": "_style_dict" + }, + { + "level": 2, + "id": "rich-text-objects-containers", + "text": "Rich Text Objects (Containers)" + }, + { + "level": 3, + "id": "rich_text.objects.ListType", + "text": "ListType" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextCodeBlock", + "text": "RichTextCodeBlock" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextList", + "text": "RichTextList" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextQuote", + "text": "RichTextQuote" + }, + { + "level": 3, + "id": "rich_text.objects.RichTextSection", + "text": "RichTextSection" + } + ], + "api_anchors": [ + "rich-text", + "rich-text-elements-primitives", + "rich_text.elements.RichText", + "rich_text.elements.RichTextChannel", + "rich_text.elements.RichTextEmoji", + "rich_text.elements.RichTextLink", + "rich_text.elements.RichTextUser", + "rich_text.elements.RichTextUserGroup", + "rich_text.elements._style_dict", + "rich-text-objects-containers", + "rich_text.objects.ListType", + "rich_text.objects.RichTextCodeBlock", + "rich_text.objects.RichTextList", + "rich_text.objects.RichTextQuote", + "rich_text.objects.RichTextSection" + ], + "code_block_count": 12, + "images": [], + "internal_links": [ + "../../usage/cookbook/#rich-formatted-alert", + "../blocks/#blocks.RichTextBlock", + "/latest/reference/blocks/#blocks.RichTextBlock", + "/latest/reference/rich_text/#rich_text.RichText", + "/reference/blocks/#blocks.RichTextBlock" + ] + }, + { + "route": "/reference/utils", + "published_title": "Utilities - slackblocks", + "headings": [ + { + "level": 1, + "id": "utilities", + "text": "Utilities" + }, + { + "level": 2, + "id": "block-kit-builder-url", + "text": "Block Kit Builder URL" + }, + { + "level": 3, + "id": "builder.block_kit_builder_url", + "text": "block_kit_builder_url" + }, + { + "level": 2, + "id": "validation-helpers", + "text": "Validation helpers" + }, + { + "level": 3, + "id": "utils.coerce_to_list", + "text": "coerce_to_list" + }, + { + "level": 3, + "id": "utils.coerce_to_list_nonnull", + "text": "coerce_to_list_nonnull" + }, + { + "level": 3, + "id": "utils.is_hex", + "text": "is_hex" + }, + { + "level": 3, + "id": "utils.validate_action_id", + "text": "validate_action_id" + }, + { + "level": 3, + "id": "utils.validate_int", + "text": "validate_int" + }, + { + "level": 3, + "id": "utils.validate_string", + "text": "validate_string" + } + ], + "api_anchors": [ + "utilities", + "block-kit-builder-url", + "builder.block_kit_builder_url", + "validation-helpers", + "utils.coerce_to_list", + "utils.coerce_to_list_nonnull", + "utils.is_hex", + "utils.validate_action_id", + "utils.validate_int", + "utils.validate_string" + ], + "code_block_count": 7, + "images": [], + "internal_links": [ + "../blocks/", + "../messages/", + "../views/" + ] + }, + { + "route": "/reference/views", + "published_title": "Views - slackblocks", + "headings": [ + { + "level": 1, + "id": "views", + "text": "Views" + }, + { + "level": 3, + "id": "views.HomeTabView", + "text": "HomeTabView" + }, + { + "level": 3, + "id": "views.ModalView", + "text": "ModalView" + } + ], + "api_anchors": [ + "views", + "views.HomeTabView", + "views.ModalView" + ], + "code_block_count": 2, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/compatibility", + "published_title": "Compatibility - slackblocks", + "headings": [ + { + "level": 1, + "id": "compatibility", + "text": "Compatibility" + }, + { + "level": 2, + "id": "support-matrix", + "text": "Support matrix" + }, + { + "level": 2, + "id": "why-we-move-forward", + "text": "Why we move forward" + }, + { + "level": 2, + "id": "choosing-a-version", + "text": "Choosing a version" + } + ], + "api_anchors": [], + "code_block_count": 3, + "images": [], + "internal_links": [ + "../migration/" + ] + }, + { + "route": "/usage/cookbook", + "published_title": "Cookbook - slackblocks", + "headings": [ + { + "level": 1, + "id": "cookbook", + "text": "Cookbook" + }, + { + "level": 2, + "id": "build-status-notification", + "text": "Build status notification" + }, + { + "level": 2, + "id": "approval-request-with-action-buttons", + "text": "Approval request with action buttons" + }, + { + "level": 2, + "id": "rich-formatted-alert", + "text": "Rich-formatted alert" + }, + { + "level": 2, + "id": "confirmation-modal", + "text": "Confirmation modal" + }, + { + "level": 2, + "id": "threaded-reply", + "text": "Threaded reply" + }, + { + "level": 2, + "id": "ephemeral-slash-command-response", + "text": "Ephemeral slash-command response" + }, + { + "level": 2, + "id": "multi-column-status-report-table", + "text": "Multi-column status report (table)" + }, + { + "level": 2, + "id": "deprecated-colored-bar-attachment", + "text": "Deprecated: colored-bar attachment" + }, + { + "level": 2, + "id": "preview-a-message-in-the-browser", + "text": "Preview a message in the browser" + }, + { + "level": 2, + "id": "parse-incoming-slack-json", + "text": "Parse incoming Slack JSON" + }, + { + "level": 2, + "id": "one-line-workflow-trigger", + "text": "One-line workflow trigger" + }, + { + "level": 2, + "id": "typed-exception-handling", + "text": "Typed exception handling" + } + ], + "api_anchors": [], + "code_block_count": 12, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/installation", + "published_title": "Installation - slackblocks", + "headings": [ + { + "level": 1, + "id": "installation", + "text": "Installation" + }, + { + "level": 2, + "id": "requirements", + "text": "Requirements" + }, + { + "level": 2, + "id": "verifying-your-installation", + "text": "Verifying your installation" + }, + { + "level": 2, + "id": "version-pinning", + "text": "Version pinning" + }, + { + "level": 2, + "id": "uninstalling", + "text": "Uninstalling" + } + ], + "api_anchors": [], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../compatibility/" + ] + }, + { + "route": "/usage/migration", + "published_title": "Migrating from 1.x - slackblocks", + "headings": [ + { + "level": 1, + "id": "migrating-from-1x-to-2x", + "text": "Migrating from 1.x to 2.x" + }, + { + "level": 2, + "id": "quick-checklist", + "text": "Quick checklist" + }, + { + "level": 2, + "id": "truly-breaking-changes", + "text": "Truly breaking changes" + }, + { + "level": 3, + "id": "python-38-and-39-are-no-longer-supported", + "text": "Python 3.8 and 3.9 are no longer supported" + }, + { + "level": 2, + "id": "whats-not-breaking-but-worth-adopting", + "text": "What's not breaking, but worth adopting" + }, + { + "level": 3, + "id": "plaintext-and-markdown-instead-of-texttype_", + "text": "PlainText and Markdown instead of Text(type_=...)" + }, + { + "level": 3, + "id": "workflowfrom_url-instead-of-nested-workflowtriggertrigger", + "text": "Workflow.from_url(...) instead of nested Workflow(trigger=Trigger(...))" + }, + { + "level": 3, + "id": "block_kit_builder_url-for-browser-preview", + "text": "block_kit_builder_url(...) for browser preview" + }, + { + "level": 3, + "id": "typed-exceptions-for-finer-grained-error-handling", + "text": "Typed exceptions for finer-grained error handling" + }, + { + "level": 3, + "id": "round-tripping-incoming-slack-json-with-from_dict", + "text": "Round-tripping incoming Slack JSON with from_dict" + }, + { + "level": 3, + "id": "two-new-block-types", + "text": "Two new block types" + }, + { + "level": 2, + "id": "type-checking-improvements", + "text": "Type-checking improvements" + }, + { + "level": 2, + "id": "internal-changes-you-might-notice", + "text": "Internal changes you might notice" + }, + { + "level": 2, + "id": "reporting-issues", + "text": "Reporting issues" + } + ], + "api_anchors": [], + "code_block_count": 11, + "images": [], + "internal_links": [ + "../compatibility/" + ] + }, + { + "route": "/usage/sending_messages", + "published_title": "Sending Messages - slackblocks", + "headings": [ + { + "level": 1, + "id": "sending-messages", + "text": "Sending Messages" + }, + { + "level": 2, + "id": "with-the-modern-slack-sdk", + "text": "With the modern slack-sdk" + }, + { + "level": 2, + "id": "with-the-legacy-slackclient", + "text": "With the legacy slackclient" + }, + { + "level": 2, + "id": "other-delivery-surfaces", + "text": "Other delivery surfaces" + }, + { + "level": 3, + "id": "incoming-webhooks", + "text": "Incoming webhooks" + }, + { + "level": 3, + "id": "slash-command-interaction-responses", + "text": "Slash command / interaction responses" + }, + { + "level": 3, + "id": "modals-home-tabs", + "text": "Modals & home tabs" + }, + { + "level": 2, + "id": "sending-without-an-sdk", + "text": "Sending without an SDK" + } + ], + "api_anchors": [], + "code_block_count": 8, + "images": [ + "../../img/hello_world.png" + ], + "internal_links": [ + "../../reference/modals/", + "../../reference/views/" + ] + }, + { + "route": "/usage/troubleshooting", + "published_title": "Troubleshooting & FAQ - slackblocks", + "headings": [ + { + "level": 1, + "id": "troubleshooting-faq", + "text": "Troubleshooting & FAQ" + }, + { + "level": 2, + "id": "why-is-my-message-body-coming-through-with-literal-asterisks-instead-of-bold", + "text": "Why is my message body coming through with literal *asterisks* instead of bold?" + }, + { + "level": 2, + "id": "why-does-my-message-say-text-is-required", + "text": "Why does my message say text is required?" + }, + { + "level": 2, + "id": "what-is-block_id-for-should-i-set-it", + "text": "What is block_id for? Should I set it?" + }, + { + "level": 2, + "id": "what-does-invalidusageerror-exceeds-limit-of-n-characters-mean", + "text": "What does InvalidUsageError: ... exceeds limit of N characters mean?" + }, + { + "level": 2, + "id": "how-many-blocks-can-a-single-message-have", + "text": "How many blocks can a single message have?" + }, + { + "level": 2, + "id": "my-buttons-selects-dont-do-anything-when-clicked", + "text": "My buttons / selects don't do anything when clicked." + }, + { + "level": 2, + "id": "why-doesnt-markdown-work-inside-a-headerblock", + "text": "Why doesn't markdown work inside a HeaderBlock?" + }, + { + "level": 2, + "id": "how-do-i-preview-a-message-without-actually-sending-it", + "text": "How do I preview a message without actually sending it?" + }, + { + "level": 2, + "id": "how-do-i-send-a-slackblocksmessage-with-requests", + "text": "How do I send a slackblocks.Message with requests?" + }, + { + "level": 2, + "id": "can-i-use-slackblocks-with-async-code", + "text": "Can I use slackblocks with async code?" + }, + { + "level": 2, + "id": "how-does-slackblocks-compare-to-the-block-classes-in-slack-sdk", + "text": "How does slackblocks compare to the block classes in slack-sdk?" + }, + { + "level": 2, + "id": "im-getting-a-pytest-error-from-a-python-deprecationwarning", + "text": "I'm getting a pytest error from a Python DeprecationWarning." + }, + { + "level": 2, + "id": "where-do-i-report-bugs-request-features", + "text": "Where do I report bugs / request features?" + } + ], + "api_anchors": [], + "code_block_count": 5, + "images": [], + "internal_links": [] + }, + { + "route": "/usage/using_blocks", + "published_title": "Using Blocks - slackblocks", + "headings": [ + { + "level": 1, + "id": "using-blocks", + "text": "Using Blocks" + }, + { + "level": 2, + "id": "section-block", + "text": "Section Block" + }, + { + "level": 3, + "id": "blocks.SectionBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "rich-text-block", + "text": "Rich Text Block" + }, + { + "level": 3, + "id": "blocks.RichTextBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "header-block", + "text": "Header Block" + }, + { + "level": 3, + "id": "blocks.HeaderBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "markdown-block", + "text": "Markdown Block" + }, + { + "level": 3, + "id": "blocks.MarkdownBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "image-block", + "text": "Image Block" + }, + { + "level": 3, + "id": "blocks.ImageBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "input-block", + "text": "Input Block" + }, + { + "level": 3, + "id": "blocks.InputBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "divider-block", + "text": "Divider Block" + }, + { + "level": 3, + "id": "blocks.DividerBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "file-block", + "text": "File Block" + }, + { + "level": 3, + "id": "blocks.FileBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "context-block", + "text": "Context Block" + }, + { + "level": 3, + "id": "blocks.ContextBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "actions-block", + "text": "Actions Block" + }, + { + "level": 3, + "id": "blocks.ActionsBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "table-block", + "text": "Table Block" + }, + { + "level": 3, + "id": "blocks.TableBlock.from_dict", + "text": "from_dict classmethod" + }, + { + "level": 2, + "id": "video-block", + "text": "Video Block" + }, + { + "level": 3, + "id": "blocks.VideoBlock.from_dict", + "text": "from_dict classmethod" + } + ], + "api_anchors": [], + "code_block_count": 24, + "images": [ + "../../img/usage/section.png", + "../../img/usage/rich_text.png", + "../../img/usage/header.png", + "../../img/usage/image.png", + "../../img/usage/input.png", + "../../img/usage/divider.png", + "https://a.slack-edge.com/f156a3/img/api/file_upload_remote_file.png", + "../../img/usage/context.png", + "../../img/usage/actions.png", + "../../img/usage/table.png" + ], + "internal_links": [ + "../../reference/blocks/", + "../../reference/elements/", + "/latest/reference/blocks/#blocks.SectionBlock", + "/latest/reference/elements", + "/latest/reference/rich_text", + "rich_text" + ] + } + ] +} diff --git a/docs/legacy/manifest.json b/docs/legacy/manifest.json new file mode 100644 index 00000000..e6e3961b --- /dev/null +++ b/docs/legacy/manifest.json @@ -0,0 +1,692 @@ +{ + "schema_version": 1, + "migration": { + "tool_version": "1", + "generated_at": "2026-08-13T17:45:54+00:00", + "gh_pages_ref": "origin/gh-pages", + "gh_pages_commit": "747ca39861503fbece849e375c9843641f87684c", + "aliases_enabled": false + }, + "versions": [ + { + "version": "2.0.0", + "tag": "v2.0.0", + "tag_commit": "ab4d7f0208fff3167819ec2464ddd38f91ceb401", + "canonical_prefix": "v2.0.0", + "old_alias_prefixes": [], + "expected_routes": [ + "/", + "/contributing", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/compatibility", + "/usage/cookbook", + "/usage/installation", + "/usage/migration", + "/usage/sending_messages", + "/usage/troubleshooting", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "081da8626e0988b4a2683f4ed6644eb01e32569c", + "python_source_tree_hash": "7f4672cccbd20726d0e20c7f821e2505c781eff1", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v2.0.0.json" + }, + { + "version": "1.2.5", + "tag": "v1.2.5", + "tag_commit": "d226d745169891f79b1a767ebbc64dc51143d178", + "canonical_prefix": "v1.2.5", + "old_alias_prefixes": [], + "expected_routes": [ + "/", + "/contributing", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/cookbook", + "/usage/installation", + "/usage/sending_messages", + "/usage/troubleshooting", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "954e28666ca3228b9565e54afeb0b9a6c920fbfb", + "python_source_tree_hash": "3d9777b442a8c4fa639d8c43e3543c70dbf501f6", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.2.5.json" + }, + { + "version": "1.2.4", + "tag": "v1.2.4", + "tag_commit": "58f4e8a3f6e9861b39da46dbd731f322ab36f687", + "canonical_prefix": "v1.2.4", + "old_alias_prefixes": [], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "f613d296b3dc96ed962849b58452013f010dfb2b", + "python_source_tree_hash": "338a87ad17ed1d5a2425edcee848030839d74d61", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.2.4.json" + }, + { + "version": "1.2.3", + "tag": "v1.2.3", + "tag_commit": "76a0e4ad441263841f1d952881c3bd48dcadef14", + "canonical_prefix": "v1.2.3", + "old_alias_prefixes": [], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "f613d296b3dc96ed962849b58452013f010dfb2b", + "python_source_tree_hash": "2ef8734f106326f48b592f86778bde73de054d32", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.2.3.json" + }, + { + "version": "1.2.2", + "tag": "v1.2.2", + "tag_commit": "9bbad5983b7404468b0061492bc72334988fe6a4", + "canonical_prefix": "v1.2.2", + "old_alias_prefixes": [], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "f613d296b3dc96ed962849b58452013f010dfb2b", + "python_source_tree_hash": "f8c05d08726172c1f41f1a0e5a20694cafcb8d1b", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.2.2.json" + }, + { + "version": "1.1.1", + "tag": "v1.1.1", + "tag_commit": "f441be2d308a3086b085334c65cc7f6adc8fa4ee", + "canonical_prefix": "v1.1.1", + "old_alias_prefixes": [ + "1.1.1" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "c8e3bfbb77115d06e15881dfc59b8075403ce592", + "python_source_tree_hash": "1ada03ea31ef22a66fa805cbe0bfc6f818540c02", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.1.1.json" + }, + { + "version": "1.0.16", + "tag": "v1.0.16", + "tag_commit": "8777332763b7b126ab06cfecb2dfa1b55dc186dc", + "canonical_prefix": "v1.0.16", + "old_alias_prefixes": [ + "1.0.16" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "c8e3bfbb77115d06e15881dfc59b8075403ce592", + "python_source_tree_hash": "0d1a034561defb0d7d2299b77bd732c71bb62483", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.16.json" + }, + { + "version": "1.0.15", + "tag": "v1.0.15", + "tag_commit": "5ae341375d30f850dac6042852cd67673122af74", + "canonical_prefix": "v1.0.15", + "old_alias_prefixes": [ + "1.0.15" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "c8e3bfbb77115d06e15881dfc59b8075403ce592", + "python_source_tree_hash": "7886d89da6ace48ca633f8fc3c1ae460faddf0fc", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.15.json" + }, + { + "version": "1.0.14", + "tag": "v1.0.14", + "tag_commit": "9f68ec706b974804305f714315a2d97396b08199", + "canonical_prefix": "v1.0.14", + "old_alias_prefixes": [ + "1.0.14" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "c8e3bfbb77115d06e15881dfc59b8075403ce592", + "python_source_tree_hash": "370f4a140a16e08631404a17e768a715bab728a4", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.14.json" + }, + { + "version": "1.0.13", + "tag": "v1.0.13", + "tag_commit": "27778577e50498916046a65bd1def17d4e6db229", + "canonical_prefix": "v1.0.13", + "old_alias_prefixes": [ + "1.0.13" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "c8e3bfbb77115d06e15881dfc59b8075403ce592", + "python_source_tree_hash": "ca894261c12660381db5ef47eb9c37ff67bfea5d", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.13.json" + }, + { + "version": "1.0.12", + "tag": "v1.0.12", + "tag_commit": "1c37da3242a42069dda91b17d6f0a93128671333", + "canonical_prefix": "v1.0.12", + "old_alias_prefixes": [ + "1.0.12" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "7751d0e10ca2072f4ca8191c4b507ae26fba7ed9", + "python_source_tree_hash": "ca894261c12660381db5ef47eb9c37ff67bfea5d", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.12.json" + }, + { + "version": "1.0.11", + "tag": "v1.0.11", + "tag_commit": "6668ed78fc55f53cd5dd7ff57f0ae06dd3594393", + "canonical_prefix": "v1.0.11", + "old_alias_prefixes": [ + "1.0.11" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "7751d0e10ca2072f4ca8191c4b507ae26fba7ed9", + "python_source_tree_hash": "0814754839b266123a488a45491aa64eb5d263de", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.11.json" + }, + { + "version": "1.0.10", + "tag": "v1.0.10", + "tag_commit": "bd600f1f49290e485331e387bd9f007af780207a", + "canonical_prefix": "v1.0.10", + "old_alias_prefixes": [ + "1.0.10" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "7751d0e10ca2072f4ca8191c4b507ae26fba7ed9", + "python_source_tree_hash": "5dba9958fb30a3525ed64cd1efd9737c3109233f", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.10.json" + }, + { + "version": "1.0.9", + "tag": "v1.0.9", + "tag_commit": "8a18c368ce33865db073d2c37d274fee60de4a68", + "canonical_prefix": "v1.0.9", + "old_alias_prefixes": [ + "1.0.9" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "7751d0e10ca2072f4ca8191c4b507ae26fba7ed9", + "python_source_tree_hash": "5a514e8537ac11cfeb2e64fb7714ee6a43d8c741", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.9.json" + }, + { + "version": "1.0.8", + "tag": "v1.0.8", + "tag_commit": "c31d8842c6f3c17dd6a89dff9938c2afea9a0f3f", + "canonical_prefix": "v1.0.8", + "old_alias_prefixes": [ + "1.0.8" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "8d258df992c057612bb577a6b85af8369ab8696e", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.8.json" + }, + { + "version": "1.0.7", + "tag": "v1.0.7", + "tag_commit": "19b941911a961831550d9fabd2d27bc2fa773329", + "canonical_prefix": "v1.0.7", + "old_alias_prefixes": [ + "1.0.7" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "b0a644717df97eaf8f01ae1cf4d94301656ea45e", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.7.json" + }, + { + "version": "1.0.6", + "tag": "v1.0.6", + "tag_commit": "03a28f787496cbdc2f23113c6cd6ebde87f96c27", + "canonical_prefix": "v1.0.6", + "old_alias_prefixes": [ + "1.0.6" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "f025bd96188afc4f509f45ae74d51a440669f7cd", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.6.json" + }, + { + "version": "1.0.5", + "tag": "v1.0.5", + "tag_commit": "309d01367cd48c52edd41498daad568d41fda907", + "canonical_prefix": "v1.0.5", + "old_alias_prefixes": [ + "1.0.5" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "0192bf8492d6a2590eb30f3d4581a8ac8e9c1dae", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.5.json" + }, + { + "version": "1.0.3", + "tag": "v1.0.3", + "tag_commit": "045f0d6acb865497ea1a5b2ad5d7cbde0f1b13c2", + "canonical_prefix": "v1.0.3", + "old_alias_prefixes": [ + "1.0.3" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "23baf8a7e0ae981892224fd102de7e9609d45512", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.3.json" + }, + { + "version": "1.0.2", + "tag": "v1.0.2", + "tag_commit": "8e5f26d5b5a82da0d919e68542c2e5abd0c71a5e", + "canonical_prefix": "v1.0.2", + "old_alias_prefixes": [ + "1.0.2" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "182494b433653293f7a76171e54920d118c085c0", + "python_source_tree_hash": "2013f3c0e1799e619cf23ad7ca60f13d39088dd2", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.2.json" + }, + { + "version": "1.0.1", + "tag": "v1.0.1", + "tag_commit": "b57bf5af211dbe012560aa8fee8ea24b405b7ee4", + "canonical_prefix": "v1.0.1", + "old_alias_prefixes": [ + "1.0.1" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "e571b02afbd2c2af10a05d1d4cf23ef23b939f92", + "python_source_tree_hash": "4edd79293f28f578f94f81663d5412b17b74ea7b", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.1.json" + }, + { + "version": "1.0.0", + "tag": "v1.0.0", + "tag_commit": "3125e5c1e7bc33b5bfd5723806e01f14810511a6", + "canonical_prefix": "v1.0.0", + "old_alias_prefixes": [ + "1.0.0" + ], + "expected_routes": [ + "/", + "/reference/attachments", + "/reference/blocks", + "/reference/elements", + "/reference/messages", + "/reference/modals", + "/reference/objects", + "/reference/rich_text", + "/reference/utils", + "/reference/views", + "/usage/installation", + "/usage/sending_messages", + "/usage/using_blocks" + ], + "documentation_source_tree_hash": "e571b02afbd2c2af10a05d1d4cf23ef23b939f92", + "python_source_tree_hash": "76c77df266bcce849dba59c7014c6bacf01e1fb7", + "generated_snapshot_tree_hash": null, + "language_availability": [ + "python" + ], + "inventory": "inventories/v1.0.0.json" + } + ] +} diff --git a/docs/package.json b/docs/package.json index d7653aee..3565258c 100644 --- a/docs/package.json +++ b/docs/package.json @@ -4,13 +4,16 @@ "private": true, "scripts": { "generate:python": "UV_CACHE_DIR=../.uv-cache uv run --project ../python --group docs python scripts/generate_python_reference.py", + "generate:legacy": "UV_CACHE_DIR=../.uv-cache uv run --project ../python --group docs python scripts/port_legacy_docs.py generate", "check:typescript-api": "node scripts/check_typescript_api_docs.mjs", "check:typescript-api-rendering": "node scripts/check_typescript_api_rendering.mjs", + "check:legacy-contract": "node scripts/check_legacy_docs.mjs", + "test:legacy-fixture": "UV_CACHE_DIR=../.uv-cache uv run --project ../python --group docs python scripts/port_legacy_docs.py fixture", "generate": "pnpm generate:python && pnpm check:typescript-api", "start": "pnpm generate && docusaurus start", "build": "pnpm generate && docusaurus build && pnpm check:typescript-api-rendering", "typecheck": "tsc --noEmit", - "test": "pnpm typecheck" + "test": "pnpm typecheck && pnpm check:legacy-contract" }, "dependencies": { "@docusaurus/core": "^3.10.2", diff --git a/docs/scripts/check_legacy_docs.mjs b/docs/scripts/check_legacy_docs.mjs new file mode 100644 index 00000000..899879ae --- /dev/null +++ b/docs/scripts/check_legacy_docs.mjs @@ -0,0 +1,93 @@ +#!/usr/bin/env node + +import { existsSync, readFileSync } from "node:fs"; +import { join, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; + +const docsRoot = resolve(fileURLToPath(new URL("..", import.meta.url))); +const manifest = JSON.parse( + readFileSync(join(docsRoot, "legacy", "manifest.json"), "utf8"), +); +const versions = manifest.versions; + +function fail(message) { + throw new Error(message); +} + +if (versions.length !== 22) fail(`Expected 22 published versions, found ${versions.length}`); +if (versions.some(({ version }) => version === "1.0.4" || version === "1.2.1")) { + fail("Unpublished documentation versions are present"); +} +const canonicalRouteCount = versions.reduce( + (total, version) => total + version.expected_routes.length, + 0, +); +if (canonicalRouteCount !== 294) { + fail(`Expected 294 canonical routes, found ${canonicalRouteCount}`); +} + +for (const version of versions) { + if (JSON.stringify(version.language_availability) !== JSON.stringify(["python"])) { + fail(`${version.tag} is not marked Python-only`); + } + const inventory = JSON.parse( + readFileSync(join(docsRoot, "legacy", version.inventory), "utf8"), + ); + if (inventory.gh_pages_commit !== manifest.migration.gh_pages_commit) { + fail(`${version.tag} inventory does not match the manifest gh-pages commit`); + } + const inventoryRoutes = inventory.pages.map(({ route }) => route); + if (JSON.stringify(inventoryRoutes) !== JSON.stringify(version.expected_routes)) { + fail(`${version.tag} inventory routes differ from its manifest entry`); + } +} + +const registered = versions.filter(({ generated_snapshot_tree_hash: hash }) => hash); +const versionsFile = JSON.parse(readFileSync(join(docsRoot, "versions.json"), "utf8")); +if (registered.length > 0) { + const expectedVersions = registered.map(({ version }) => version); + if (JSON.stringify(versionsFile) !== JSON.stringify(expectedVersions)) { + fail("docs/versions.json is not generated from the registered manifest entries"); + } +} + +function routeFile(buildRoot, prefix, route) { + const suffix = route === "/" ? "" : route; + const path = `${prefix}${suffix}`.replace(/^\//, ""); + const candidates = [ + join(buildRoot, `${path}.html`), + join(buildRoot, path, "index.html"), + ]; + return candidates.find(existsSync); +} + +const buildArgument = process.argv.indexOf("--build-dir"); +if (buildArgument >= 0) { + const buildRoot = resolve(process.cwd(), process.argv[buildArgument + 1]); + if (!existsSync(buildRoot)) fail(`Build directory does not exist: ${buildRoot}`); + for (const version of registered) { + for (const route of version.expected_routes) { + const output = routeFile(buildRoot, version.canonical_prefix, route); + if (!output) fail(`Missing built route ${version.canonical_prefix}${route}`); + const rendered = readFileSync(output, "utf8"); + if (/reference\/typescript/.test(rendered)) { + fail(`${version.canonical_prefix}${route} contains a TypeScript reference route`); + } + if (route.startsWith("/reference/")) { + const inventory = JSON.parse( + readFileSync(join(docsRoot, "legacy", version.inventory), "utf8"), + ); + const page = inventory.pages.find((candidate) => candidate.route === route); + for (const anchor of page.api_anchors) { + if (!rendered.includes(`id="${anchor}"`)) { + fail(`${version.canonical_prefix}${route} is missing historical anchor ${anchor}`); + } + } + } + } + } +} + +console.log( + `Legacy documentation contract covers ${versions.length} versions and ${canonicalRouteCount} routes; ${registered.length} snapshots are registered.`, +); diff --git a/docs/scripts/port_legacy_docs.py b/docs/scripts/port_legacy_docs.py new file mode 100644 index 00000000..45604fc7 --- /dev/null +++ b/docs/scripts/port_legacy_docs.py @@ -0,0 +1,913 @@ +#!/usr/bin/env python3 +"""Inventory and deterministically port the published MkDocs documentation.""" + +from __future__ import annotations + +import argparse +import hashlib +import html +import json +import re +import shutil +import subprocess +import tarfile +import tempfile +from datetime import datetime, timezone +from pathlib import Path +from typing import TYPE_CHECKING, Any + +import griffe + +if TYPE_CHECKING: + from collections.abc import Iterable, Sequence + +TOOL_VERSION = "1" +DOCS_ROOT = Path(__file__).resolve().parents[1] +REPO_ROOT = DOCS_ROOT.parent +LEGACY_ROOT = DOCS_ROOT / "legacy" +MANIFEST_PATH = LEGACY_ROOT / "manifest.json" +INVENTORY_ROOT = LEGACY_ROOT / "inventories" +FIXTURE_ARCHIVE = LEGACY_ROOT / "fixtures" / "v1.0.0.tar.gz" +VERSIONS_PATH = DOCS_ROOT / "versions.json" + +REFERENCE_PAGES = ( + "attachments", + "blocks", + "elements", + "messages", + "modals", + "objects", + "rich_text", + "views", + "utils", +) + +PAGE_TITLES = { + "index": "Welcome", + "contributing": "Contributing", + "usage/installation": "Installation", + "usage/using_blocks": "Using Blocks", + "usage/sending_messages": "Sending Messages", + "usage/cookbook": "Recipe Book", + "usage/troubleshooting": "Troubleshooting & FAQ", + "usage/compatibility": "Compatibility", + "usage/migration": "Migrating from 1.x to 2.x", + "reference/attachments": "Attachments", + "reference/blocks": "Blocks", + "reference/elements": "Elements", + "reference/messages": "Messages", + "reference/modals": "Modals", + "reference/objects": "Objects", + "reference/rich_text": "Rich Text", + "reference/views": "Views", + "reference/utils": "Utilities", +} + +HEADING_RE = re.compile( + r"[1-6])(?P[^>]*)>(?P.*?)", + re.IGNORECASE | re.DOTALL, +) +ATTRIBUTE_RE = re.compile(r'(?P[\w:-]+)="(?P[^"]*)"') +TAG_RE = re.compile(r"<[^>]+>") +ARTICLE_RE = re.compile(r"]*>(?P.*?)", re.IGNORECASE | re.DOTALL) +TAB_HEADER_RE = re.compile(r'^===\s+"(?P