Fix godoc

This commit is contained in:
Joshua Casey
2023-07-19 15:47:47 -05:00
parent f6c2d40141
commit 52b0cf43ca
7 changed files with 28 additions and 22 deletions
@@ -1,4 +1,4 @@
// Copyright 2020 the Pinniped contributors. All Rights Reserved.
// Copyright 2020-2023 the Pinniped contributors. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
package provider
@@ -11,7 +11,7 @@ import (
"go.pinniped.dev/internal/constable"
)
// FederationDomainIssuer represents all of the settings and state for a downstream OIDC provider
// FederationDomainIssuer represents all the settings and state for a downstream OIDC provider
// as defined by a FederationDomain.
type FederationDomainIssuer struct {
issuer string
@@ -19,6 +19,8 @@ type FederationDomainIssuer struct {
issuerPath string
}
// NewFederationDomainIssuer returns a FederationDomainIssuer.
// Performs validation, and returns any error from validation.
func NewFederationDomainIssuer(issuer string) (*FederationDomainIssuer, error) {
p := FederationDomainIssuer{issuer: issuer}
err := p.validate()
@@ -64,14 +66,17 @@ func (p *FederationDomainIssuer) validate() error {
return nil
}
// Issuer returns the issuer
func (p *FederationDomainIssuer) Issuer() string {
return p.issuer
}
// IssuerHost returns the issuerHost
func (p *FederationDomainIssuer) IssuerHost() string {
return p.issuerHost
}
// IssuerPath returns the issuerPath
func (p *FederationDomainIssuer) IssuerPath() string {
return p.issuerPath
}