api

Documentation

Overview

Copyright (c) 2025 Chakib Ben Ziane <contact@blob42.xyz> and [`gosuki` contributors](https://github.com/blob42/gosuki/graphs/contributors). All rights reserved.

SPDX-License-Identifier: AGPL-3.0-or-later

This file is part of GoSuki.

GoSuki is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

GoSuki is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with gosuki. If not, see <http://www.gnu.org/licenses/>.

Index

• func GetAPIBookmarks(w http.ResponseWriter, r *http.Request)
• func GetBookmarks(r *http.Request) ([]*gosuki.Bookmark, uint, error)
• func GetPaginationParams(r *http.Request) *db.PaginationParams
• func IsFuzzy(r *http.Request) bool
• type Bookmark
• type Payload
• type RawBookmark
• type ReqIsFuzzy
• type ResetPage

Functions

func GetAPIBookmarks

func GetAPIBookmarks(w http.ResponseWriter, r *http.Request)

func GetBookmarks

func GetBookmarks(r *http.Request) ([]*gosuki.Bookmark, uint, error)

func GetPaginationParams

func GetPaginationParams(r *http.Request) *db.PaginationParams

func IsFuzzy

func IsFuzzy(r *http.Request) bool

Types

type Bookmark

type Bookmark = gosuki.Bookmark

type Payload

type Payload struct {
	Total   uint `json:"total"`
	Page    int  `json:"page"`
	PerPage int  `json:"per_page"`
	Result  any  `json:"result"`
}

type RawBookmark

type RawBookmark = db.RawBookmark

type ReqIsFuzzy

type ReqIsFuzzy struct{}

type ResetPage

type ResetPage struct{}