Documentation
¶
Index ¶
- func NewSitesHandler(sitesCtrl ports.Sites, filesCtrl ports.Files) *sitesHandler
- func Register(api huma.API, h *sitesHandler)
- type CreateSiteInput
- type CreateSiteOutput
- type GetSiteInput
- type GetSiteOutput
- type GetSiteOutputBody
- type UpdateSiteOwnedByInput
- type UpdateSiteOwnedByOutput
- type UploadFileInput
- type UploadFileOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSitesHandler ¶
NewSitesHandler creates a new SitesHandler with the given Sites controller.
Types ¶
type CreateSiteInput ¶
type CreateSiteInput struct {
Body struct {
Name string `body:"name" json:"name" example:"fizzy-buzzy" doc:"The name of the site (e.g. fizzy-buzzy)."`
}
}
CreateSiteInput is the input for the CreateSite operation.
type CreateSiteOutput ¶
CreateSiteOutput is the output for the CreateSite operation.
type GetSiteInput ¶
type GetSiteInput struct {
// Name is the name of the site to retrieve.
Name string `json:"name" query:"name" example:"my-site" doc:"The name of the site to retrieve."`
}
GetSiteInput is the input for the GetSite operation.
type GetSiteOutput ¶
type GetSiteOutput struct {
Body GetSiteOutputBody `json:"body"`
}
GetSiteOutput is the output for the GetSite operation.
type GetSiteOutputBody ¶ added in v0.3.0
GetSiteOutputBody is the body of the GetSite output.
type UpdateSiteOwnedByInput ¶ added in v0.3.34
type UpdateSiteOwnedByInput struct {
// Name is the name of the site.
Name string `path:"name" json:"name" example:"fizzy-buzzy" doc:"The name of the site."`
}
UpdateSiteOwnedByInput is the input for the UpdateSiteOwnedBy operation.
type UpdateSiteOwnedByOutput ¶ added in v0.3.34
type UpdateSiteOwnedByOutput struct{}
UpdateSiteOwnedByOutput is the output of the UpdateSiteOwnedBy operation.
type UploadFileInput ¶ added in v0.3.0
type UploadFileInput struct {
ID string `path:"siteId" json:"siteId" example:"1bd3f34f-8d15-4818-816e-6fe6c0a3a847" doc:"The ID of the site."`
Filename string `query:"fileName" json:"fileName" example:"index.html" doc:"The filename of the file."`
RawBody []byte
}
UploadFileInput is the input for the UploadFile operation.
type UploadFileOutput ¶ added in v0.3.0
type UploadFileOutput struct {
Body string `json:"body"`
}
UploadFileOutput is the output of the UploadFile operation.
Click to show internal directories.
Click to hide internal directories.