README
¶
ids
Nominal UUID types for all resource identifiers in the identity API.
Purpose
Provides distinct named types over uuid.UUID for every resource category:
| Type | Identifies |
|---|---|
OrganizationID |
organizations |
ProjectID |
projects |
ServiceAccountID |
service accounts |
UserID |
users |
GroupID |
groups |
OAuth2ProviderID |
OAuth2 providers |
AllocationID |
resource allocations |
Each type is a distinct named type — not an alias — so the compiler prevents
a ProjectID from being passed where an OrganizationID is expected, and
so on across all seven types.
Each type implements encoding.TextUnmarshaler by delegating to uuid.UUID,
so the oapi-codegen parameter binder validates UUID format at path-parameter
binding time before any handler is reached. Non-UUID path values produce a
400 at the routing layer rather than propagating into business logic.
Conversion
Inward (string → typed ID): Use Parse* for untrusted input (Kubernetes
labels, token claims, request body fields). Use MustParse* only where the
value is guaranteed valid by a prior validation step (e.g. a path parameter
that has already passed the binding layer).
Outward (typed ID → string): Call .String() to produce the canonical
hyphenated UUID string for Kubernetes object names, label values, or log
messages.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AllocationID ¶
AllocationID is a UUID-backed identifier for resource allocations. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseAllocationID ¶
func MustParseAllocationID(s string) AllocationID
MustParseAllocationID parses s as a UUID into an AllocationID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseAllocationID ¶
func ParseAllocationID(s string) (AllocationID, error)
ParseAllocationID parses s as a UUID into an AllocationID, returning an error if s is not a valid UUID.
func (AllocationID) MarshalText ¶
func (v AllocationID) MarshalText() ([]byte, error)
func (AllocationID) String ¶
func (v AllocationID) String() string
func (*AllocationID) UnmarshalText ¶
func (v *AllocationID) UnmarshalText(b []byte) error
type GroupID ¶
GroupID is a UUID-backed identifier for groups. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseGroupID ¶
MustParseGroupID parses s as a UUID into a GroupID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseGroupID ¶
ParseGroupID parses s as a UUID into a GroupID, returning an error if s is not a valid UUID.
func (GroupID) MarshalText ¶
func (*GroupID) UnmarshalText ¶
type OAuth2ProviderID ¶
OAuth2ProviderID is a UUID-backed identifier for OAuth2 providers. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseOAuth2ProviderID ¶
func MustParseOAuth2ProviderID(s string) OAuth2ProviderID
MustParseOAuth2ProviderID parses s as a UUID into an OAuth2ProviderID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseOAuth2ProviderID ¶
func ParseOAuth2ProviderID(s string) (OAuth2ProviderID, error)
ParseOAuth2ProviderID parses s as a UUID into an OAuth2ProviderID, returning an error if s is not a valid UUID.
func (OAuth2ProviderID) MarshalText ¶
func (v OAuth2ProviderID) MarshalText() ([]byte, error)
func (OAuth2ProviderID) String ¶
func (v OAuth2ProviderID) String() string
func (*OAuth2ProviderID) UnmarshalText ¶
func (v *OAuth2ProviderID) UnmarshalText(b []byte) error
type OrganizationID ¶
OrganizationID is a UUID-backed identifier for organizations. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseOrganizationID ¶
func MustParseOrganizationID(s string) OrganizationID
MustParseOrganizationID parses s as a UUID into an OrganizationID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseOrganizationID ¶
func ParseOrganizationID(s string) (OrganizationID, error)
ParseOrganizationID parses s as a UUID into an OrganizationID, returning an error if s is not a valid UUID.
func (OrganizationID) MarshalText ¶
func (v OrganizationID) MarshalText() ([]byte, error)
func (OrganizationID) String ¶
func (v OrganizationID) String() string
func (*OrganizationID) UnmarshalText ¶
func (v *OrganizationID) UnmarshalText(b []byte) error
type ProjectID ¶
ProjectID is a UUID-backed identifier for projects. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseProjectID ¶
MustParseProjectID parses s as a UUID into a ProjectID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseProjectID ¶
ParseProjectID parses s as a UUID into a ProjectID, returning an error if s is not a valid UUID.
func (ProjectID) MarshalText ¶
func (*ProjectID) UnmarshalText ¶
type ServiceAccountID ¶
ServiceAccountID is a UUID-backed identifier for service accounts. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseServiceAccountID ¶
func MustParseServiceAccountID(s string) ServiceAccountID
MustParseServiceAccountID parses s as a UUID into a ServiceAccountID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseServiceAccountID ¶
func ParseServiceAccountID(s string) (ServiceAccountID, error)
ParseServiceAccountID parses s as a UUID into a ServiceAccountID, returning an error if s is not a valid UUID.
func (ServiceAccountID) MarshalText ¶
func (v ServiceAccountID) MarshalText() ([]byte, error)
func (ServiceAccountID) String ¶
func (v ServiceAccountID) String() string
func (*ServiceAccountID) UnmarshalText ¶
func (v *ServiceAccountID) UnmarshalText(b []byte) error
type UserID ¶
UserID is a UUID-backed identifier for users. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
func MustParseUserID ¶
MustParseUserID parses s as a UUID into a UserID. Panics if s is not a valid UUID; use only where s is guaranteed valid (e.g. previously validated API path parameters).
func ParseUserID ¶
ParseUserID parses s as a UUID into a UserID, returning an error if s is not a valid UUID.
Source Files