Skip to content

Doc API group suffix, add test to catch new groups #32315

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Sep 13, 2016

Conversation

liggitt
Copy link
Member

@liggitt liggitt commented Sep 8, 2016

Spawned from discussion in #31887

Doc and add tests to ensure new API groups are suffixed.

Also changed the doc to reference an API group containing the suffix as a starting point for new API groups.

This change is Reviewable

@k8s-github-robot k8s-github-robot added kind/design Categorizes issue or PR as related to design. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. release-note-label-needed labels Sep 8, 2016
@liggitt
Copy link
Member Author

liggitt commented Sep 8, 2016

cc @kubernetes/sig-api-machinery @lavalamp @bgrant0607 @thockin

@lavalamp lavalamp assigned krousey and unassigned bgrant0607 Sep 8, 2016
@liggitt liggitt added release-note-none Denotes a PR that doesn't merit a release note. and removed release-note-label-needed labels Sep 9, 2016
@@ -80,7 +80,7 @@ expected to be programmatically convertible to the name of the resource using
the following conversion. Kinds are expected to be of the form
`<CamelCaseKind>`, and the `APIVersion` for the object is expected to be
`<api-group>/<api-version>`. To prevent collisions, it's expected that you'll
use a fully qualified domain name for the API group, e.g. `example.com`.
use a DNS name of at least three segments for the API group, e.g. `stable.example.com`.

For example `stable.example.com/v1`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe stable is a bad example now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to "mygroup.example.com"... better suggestions welcome

@k8s-bot
Copy link

k8s-bot commented Sep 9, 2016

GCE e2e build/test passed for commit 620cc66.

@krousey krousey added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 12, 2016
@k8s-github-robot
Copy link

@k8s-bot test this [submit-queue is verifying that this PR is safe to merge]

@k8s-bot
Copy link

k8s-bot commented Sep 13, 2016

GCE e2e build/test passed for commit 620cc66.

@k8s-github-robot
Copy link

Automatic merge from submit-queue

@k8s-github-robot k8s-github-robot merged commit 544e64a into kubernetes:master Sep 13, 2016
@liggitt liggitt deleted the api-group-suffix branch September 13, 2016 14:12
xingzhou pushed a commit to xingzhou/kubernetes that referenced this pull request Dec 15, 2016
Automatic merge from submit-queue

Doc API group suffix, add test to catch new groups

Spawned from discussion in kubernetes#31887

Doc and add tests to ensure new API groups are suffixed.

Also changed the doc to reference an API group containing the suffix as a starting point for new API groups.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
kind/design Categorizes issue or PR as related to design. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants