From aefde02e30d5ef6fc67ecbe2c82480a8313cca67 Mon Sep 17 00:00:00 2001 From: SoXX Date: Mon, 16 Oct 2023 16:11:03 +0200 Subject: [PATCH] docs: prepare function documentation --- pkg/e621/endpoints/tags.go | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/pkg/e621/endpoints/tags.go b/pkg/e621/endpoints/tags.go index a29b68f..dedbe0a 100644 --- a/pkg/e621/endpoints/tags.go +++ b/pkg/e621/endpoints/tags.go @@ -1 +1,20 @@ package endpoints + +import ( + "git.dragse.it/anthrove/e621-to-graph/pkg/e621/model" + "net/http" +) + +// GetTags allows you to search based on the following query: +// +// - search[name_matches]: A tag name expression to match against, which can include * as a wildcard. +// - search[category]: Filters results to a particular category. Default value is blank (show all tags). See below for allowed values. +// - search[order]: Changes the sort order. Pass one of date (default), count, or name. +// - search[hide_empty]: Hide tags with zero visible posts. Pass true (default) or false. +// - search[has_wiki]: Show only tags with, or without, a wiki page. Pass true, false, or blank (default). +// - search[has_artist]: Show only tags with, or without an artist page. Pass true, false, or blank (default). +// - limit: Maximum number of results to return per query. Default is 75. There is a hard upper limit of 320. +// - page: The page that will be returned. Can also be used with a or b + tag_id to get the tags after or before the specified tag ID. For example a13 gets every tag after tag_id 13 up to the limit. This overrides the specified search ordering, date is always used instead. +func GetTags(client http.Client, requestContext model.RequestContext, query map[string]string) { + return +}