Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi

package

Go to main page

Versions in this module

v0

v0.0.10

Sep 2, 2025

v0.0.9

Apr 25, 2025

v0.0.8

Jan 19, 2025

v0.0.7

Jan 19, 2025

v0.0.6

Jan 19, 2025

v0.0.5

Jan 6, 2025

v0.0.4

Jan 3, 2025

Changes in this version

type MessageAPI

+ PostFormFileImage func(ctx context.Context, channelID string, m map[string]string, path string) (*dto.Message, error)

+ PostFormFileReaderImage func(ctx context.Context, channelID string, m map[string]string, filename string, ...) (*dto.Message, error)

v0.0.3

Dec 24, 2024

v0.0.2

Dec 22, 2024

v0.0.1

Dec 22, 2024

Changes in this version

+ const TraceIDKey

+ var VersionMapping = map[APIVersion]OpenAPI

+ func APIVersionString(version APIVersion) string

+ func DoReqFilterChains(req *http.Request, resp *http.Response) error

+ func DoRespFilterChains(req *http.Request, resp *http.Response) error

+ func IsSuccessStatus(code int) bool

+ func Register(version APIVersion, api OpenAPI)

+ func RegisterReqFilter(name string, filter HTTPFilter)

+ func RegisterRespFilter(name string, filter HTTPFilter)

+ type APIPermissionsAPI interface

+ GetAPIPermissions func(ctx context.Context, guildID string) (*dto.APIPermissions, error)

+ RequireAPIPermissions func(ctx context.Context, guildID string, demand *dto.APIPermissionDemandToCreate) (*dto.APIPermissionDemand, error)

+ type APIVersion = uint32

+ const APIv1

+ type AnnouncesAPI interface

+ CleanChannelAnnounces func(ctx context.Context, channelID string) error

+ CleanGuildAnnounces func(ctx context.Context, guildID string) error

+ CreateChannelAnnounces func(ctx context.Context, channelID string, announce *dto.ChannelAnnouncesToCreate) (*dto.Announces, error)

+ CreateGuildAnnounces func(ctx context.Context, guildID string, announce *dto.GuildAnnouncesToCreate) (*dto.Announces, error)

+ DeleteChannelAnnounces func(ctx context.Context, channelID, messageID string) error

+ DeleteGuildAnnounces func(ctx context.Context, guildID, messageID string) error

+ type AudioAPI interface

+ DeleteMic func(ctx context.Context, channelID string) error

+ PostAudio func(ctx context.Context, channelID string, value *dto.AudioControl) (*dto.AudioControl, error)

+ PutMic func(ctx context.Context, channelID string) error

+ type Base interface

+ Setup func(token *token.Token, inSandbox bool) OpenAPI

+ TraceID func() string

+ Transport func(ctx context.Context, method, url string, body interface{}) ([]byte, error)

+ Version func() APIVersion

+ WithTimeout func(duration time.Duration) OpenAPI

+ type ChannelAPI interface

+ Channel func(ctx context.Context, channelID string) (*dto.Channel, error)

+ Channels func(ctx context.Context, guildID string) ([]*dto.Channel, error)

+ CreatePrivateChannel func(ctx context.Context, guildID string, value *dto.ChannelValueObject, ...) (*dto.Channel, error)

+ DeleteChannel func(ctx context.Context, channelID string) error

+ ListVoiceChannelMembers func(ctx context.Context, channelID string) ([]*dto.Member, error)

+ PatchChannel func(ctx context.Context, channelID string, value *dto.ChannelValueObject) (*dto.Channel, error)

+ PostChannel func(ctx context.Context, guildID string, value *dto.ChannelValueObject) (*dto.Channel, error)

+ type ChannelPermissionsAPI interface

+ ChannelPermissions func(ctx context.Context, channelID, userID string) (*dto.ChannelPermissions, error)

+ ChannelRolesPermissions func(ctx context.Context, channelID, roleID string) (*dto.ChannelRolesPermissions, error)

+ PutChannelPermissions func(ctx context.Context, channelID, userID string, p *dto.UpdateChannelPermissions) error

+ PutChannelRolesPermissions func(ctx context.Context, channelID, roleID string, p *dto.UpdateChannelPermissions) error

+ type DirectMessageAPI interface

+ CreateDirectMessage func(ctx context.Context, dm *dto.DirectMessageToCreate) (*dto.DirectMessage, error)

+ PostDMSettingGuide func(ctx context.Context, dm *dto.DirectMessage, jumpGuildID string) (*dto.Message, error)

+ PostDirectMessage func(ctx context.Context, dm *dto.DirectMessage, msg *dto.MessageToCreate) (*dto.Message, error)

+ RetractDMMessage func(ctx context.Context, guildID, msgID string, options ...RetractMessageOption) error

+ type GetGroupMembersAPI interface

+ GetGroupMembers func(ctx context.Context, groupId string, limit, startIndex int) (*dto.GetGroupMembersResp, error)

+ type GuildAPI interface

+ DeleteGuildMember func(ctx context.Context, guildID, userID string, opts ...dto.MemberDeleteOption) error

+ Guild func(ctx context.Context, guildID string) (*dto.Guild, error)

+ GuildMember func(ctx context.Context, guildID, userID string) (*dto.Member, error)

+ GuildMembers func(ctx context.Context, guildID string, pager *dto.GuildMembersPager) ([]*dto.Member, error)

+ GuildMute func(ctx context.Context, guildID string, mute *dto.UpdateGuildMute) error

+ GuildRoleMembers func(ctx context.Context, guildID string, roleID string, ...) ([]*dto.Member, string, error)

+ type HTTPFilter func(req *http.Request, response *http.Response) error

+ type InteractionAPI interface

+ PutInteraction func(ctx context.Context, interactionID string, body string) error

+ type MemberAPI interface

+ MemberAddRole func(ctx context.Context, guildID string, roleID dto.RoleID, userID string, ...) error

+ MemberDeleteRole func(ctx context.Context, guildID string, roleID dto.RoleID, userID string, ...) error

+ MemberMute func(ctx context.Context, guildID, userID string, mute *dto.UpdateGuildMute) error

+ MultiMemberMute func(ctx context.Context, guildID string, mute *dto.UpdateGuildMute) (*dto.UpdateGuildMuteResponse, error)

+ type MessageAPI interface

+ DelC2CMessage func(ctx context.Context, userID, msgID string, options ...RetractMessageOption) error

+ DelGroupBotMessage func(ctx context.Context, groupID, msgID string, options ...RetractMessageOption) error

+ Message func(ctx context.Context, channelID string, messageID string) (*dto.Message, error)

+ Messages func(ctx context.Context, channelID string, pager *dto.MessagesPager) ([]*dto.Message, error)

+ PatchMessage func(ctx context.Context, channelID string, messageID string, ...) (*dto.Message, error)

+ PostC2CMessage func(ctx context.Context, userId string, msg *dto.C2CMessageToCreate) (*dto.C2CMsgResp, error)

+ PostC2CRichMediaMessage func(ctx context.Context, userId string, msg *dto.C2CRichMediaMessageToCreate) (*dto.RichMediaMsgResp, error)

+ PostGroupMessage func(ctx context.Context, groupId string, msg *dto.GroupMessageToCreate) (*dto.GroupMsgResp, error)

+ PostGroupRichMediaMessage func(ctx context.Context, groupId string, msg *dto.GroupRichMediaMessageToCreate) (*dto.RichMediaMsgResp, error)

+ PostMessage func(ctx context.Context, channelID string, msg *dto.MessageToCreate) (*dto.Message, error)

+ PostSettingGuide func(ctx context.Context, channelID string, atUserIDs []string) (*dto.Message, error)

+ RetractMessage func(ctx context.Context, channelID, msgID string, options ...RetractMessageOption) error

+ type MessageReactionAPI interface

+ CreateMessageReaction func(ctx context.Context, channelID, messageID string, emoji dto.Emoji) error

+ DeleteOwnMessageReaction func(ctx context.Context, channelID, messageID string, emoji dto.Emoji) error

+ GetMessageReactionUsers func(ctx context.Context, channelID, messageID string, emoji dto.Emoji, ...) (*dto.MessageReactionUsers, error)

+ type MessageSettingAPI interface

+ GetMessageSetting func(ctx context.Context, guildID string) (*dto.MessageSetting, error)

+ type OpenAPI interface

+ var DefaultImpl OpenAPI

+ type PinsAPI interface

+ AddPins func(ctx context.Context, channelID string, messageID string) (*dto.PinsMessage, error)

+ CleanPins func(ctx context.Context, channelID string) error

+ DeletePins func(ctx context.Context, channelID, messageID string) error

+ GetPins func(ctx context.Context, channelID string) (*dto.PinsMessage, error)

+ type RetractMessageOption int

+ const RetractMessageOptionHidetip

+ type RoleAPI interface

+ DeleteRole func(ctx context.Context, guildID string, roleID dto.RoleID) error

+ PatchRole func(ctx context.Context, guildID string, roleID dto.RoleID, role *dto.Role) (*dto.UpdateResult, error)

+ PostRole func(ctx context.Context, guildID string, role *dto.Role) (*dto.UpdateResult, error)

+ Roles func(ctx context.Context, guildID string) (*dto.GuildRoles, error)

+ type ScheduleAPI interface

+ CreateSchedule func(ctx context.Context, channelID string, schedule *dto.Schedule) (*dto.Schedule, error)

+ DeleteSchedule func(ctx context.Context, channelID, scheduleID string) error

+ GetSchedule func(ctx context.Context, channelID, scheduleID string) (*dto.Schedule, error)

+ ListSchedules func(ctx context.Context, channelID string, since uint64) ([]*dto.Schedule, error)

+ ModifySchedule func(ctx context.Context, channelID, scheduleID string, schedule *dto.Schedule) (*dto.Schedule, error)

+ type UserAPI interface

+ Me func(ctx context.Context) (*dto.User, error)

+ MeGuilds func(ctx context.Context, pager *dto.GuildPager) ([]*dto.Guild, error)

+ type WebhookAPI interface

+ CheckSessions func(ctx context.Context) ([]*dto.HTTPSession, error)

+ CreateSession func(ctx context.Context, identity dto.HTTPIdentity) (*dto.HTTPReady, error)

+ RemoveSession func(ctx context.Context, sessionID string) error

+ SessionList func(ctx context.Context) ([]*dto.HTTPSession, error)

+ type WebsocketAPI interface

+ WS func(ctx context.Context, params map[string]string, body string) (*dto.WebsocketAP, error)