Skip to content
Snippets Groups Projects
Commit 80884323 authored by Tóth Miklós Tibor's avatar Tóth Miklós Tibor :shrug:
Browse files

Fix godoc comments

parent 28d98e67
Branches
Tags
No related merge requests found
// AuthSCH bejelentkezés könyvtár Go-hoz
// Package authsch AuthSCH bejelentkezés könyvtár Go-hoz
package authsch
import (
......@@ -11,12 +11,12 @@ import (
"time"
)
// Egy AuthSCH kliens
// Client gy AuthSCH kliens
type Client struct {
*oauth2.Config
}
// Létrehoz egy klienset. Meg kell adni az AuthSCH-n fejlesztői konzolon kapott azonosítót és kulcsot, illetve a kért scope-okat
// A CreateClient létrehoz egy klienst. Meg kell adni az AuthSCH-n fejlesztői konzolon kapott azonosítót és kulcsot, illetve a kért scope-okat
// A scope-oktról több infót itt találsz:
// https://git.sch.bme.hu/kszk/authsch/-/wikis/api
func CreateClient(ClientID, ClientSecret string, Scopes []string, RedirectURL string) Client {
......@@ -34,7 +34,7 @@ func CreateClient(ClientID, ClientSecret string, Scopes []string, RedirectURL st
return Client{conf}
}
// Egy felhasználó lekérhető adatai.
// AccDetails egy felhasználó lekérhető adatai.
// A scope-októl függően az InternalID-n kívül a többi mező üres lehet.
// A scope-oktról több infót itt találsz:
// https://git.sch.bme.hu/kszk/authsch/-/wikis/api
......@@ -68,7 +68,7 @@ type AccDetails struct {
BMEUnitScope []string `json:"bmeunitscope"`
}
// Ad egy URL-t az AuthSCH-s bejelentkező ablakhoz, ide kell irányítani a usert.
// A GetAuthURL ad egy URL-t az AuthSCH-s bejelentkező ablakhoz, ide kell irányítani a usert.
// Az AuthSCH majd visszairányítja a usert a megadott URL-re.
func (c *Client) GetAuthURL(opts ...oauth2.AuthCodeOption) string {
options := []oauth2.AuthCodeOption{oauth2.AccessTypeOffline}
......@@ -79,7 +79,7 @@ func (c *Client) GetAuthURL(opts ...oauth2.AuthCodeOption) string {
}
// Egy http.Handler-t ad vissza, amit be kell kötni arra az URL-re, ahova az AuthSCH átirányít
// A GetLoginHandler egy http.Handler-t ad vissza, amit be kell kötni arra az URL-re, ahova az AuthSCH átirányít
// A next paraméter megkapja a user adatait a details változóban, illetve egy http.ResponseWriter-t és *http.Request-et is,
// így az a függvény célszerűen eltárolja a user adatait, beállít egy sütit, majd átirányítja.
// Az errorCallback paraméterben megadott függvény pedig hibás belépés esetén fut le, ott célszerű egy hibaoldalt megjeleníteni.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment