vikarti.anatra/safing-portbase
1
0
Fork 0
mirror of https://github.com/safing/portbase synced 2025-09-02 02:29:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document API endpoint metadata

Browse source
This commit is contained in:
Daniel 2023-08-09 14:54:29 +02:00
parent cdfdbe929c
commit 48711570af
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
api/endpoints.go
View file

@ -23,6 +23,13 @@ import (
// Path and at least one permission are required. // Path and at least one permission are required.
// As is exactly one function. // As is exactly one function.
type Endpoint struct { //nolint:maligned type Endpoint struct { //nolint:maligned
// Name is the human reabable name of the endpoint.
Name string
// Description is the human readable description and documentation of the endpoint.
Description string
// Parameters is the parameter documentation.
Parameters []Parameter `json:",omitempty"`
// Path describes the URL path of the endpoint. // Path describes the URL path of the endpoint.
Path string Path string
@ -74,12 +81,6 @@ type Endpoint struct { //nolint:maligned
// HandlerFunc is the raw http handler. // HandlerFunc is the raw http handler.
HandlerFunc http.HandlerFunc `json:"-"` HandlerFunc http.HandlerFunc `json:"-"`
// Documentation Metadata.
Name string
Description string
Parameters []Parameter `json:",omitempty"`
} }
// Parameter describes a parameterized variation of an endpoint. // Parameter describes a parameterized variation of an endpoint.