Skip to content

K
k3s
Commit 55480054 authored by Kubernetes Submit Queue's avatar Kubernetes Submit Queue Committed by GitHub
Browse files
Options

Merge pull request #40894 from MHBauer/groupmetafactoryargs-doc

Automatic merge from submit-queue GroupMetaFactoryArgs documentation **What this PR does / why we need it**: Documentation for people writing new API-Groups. **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: documentation **Special notes for your reviewer**: @deads2k @pmorie my thoughts from writing the service-catalog apiserver. **Release note**: ```release-note NONE ```
parents ef54fbd0 1169868d
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 2 deletions
staging/src/k8s.io/apimachinery/pkg/apimachinery/announced/group_factory.go
View file @ 55480054
...@@ -42,10 +42,16 @@ type GroupVersionFactoryArgs struct { ...@@ -42,10 +42,16 @@ type GroupVersionFactoryArgs struct {
// GroupMetaFactoryArgs contains the group-level args of a GroupMetaFactory. // GroupMetaFactoryArgs contains the group-level args of a GroupMetaFactory.
type GroupMetaFactoryArgs struct { type GroupMetaFactoryArgs struct {
// GroupName is the name of the API-Group
//
// example: 'servicecatalog.k8s.io'
GroupName string GroupName string
VersionPreferenceOrder []string VersionPreferenceOrder []string
ImportPrefix string // ImportPrefix is the base go package of the API-Group
//
// example: 'k8s.io/kubernetes/pkg/apis/autoscaling'
ImportPrefix string
// RootScopedKinds are resources that are not namespaced.
RootScopedKinds sets.String // nil is allowed RootScopedKinds sets.String // nil is allowed
IgnoredKinds sets.String // nil is allowed IgnoredKinds sets.String // nil is allowed
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment