search

kubernetes-sigs / kubebuilder

Kubebuilder - SDK for building Kubernetes APIs using CRDs
http://book.kubebuilder.io
Apache License 2.0
7.62k stars 1.42k forks source link

Document how to represent time and dates in types. #476

Open erictune opened 5 years ago

erictune commented 5 years ago

KRM convention for storing dates is to settype: string and format: date in the openAPI.

For date-times it is to use type: string and format: date-time.

This is RFC3339, and you can refer this reference: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types.

Suggest putting this in the KubeBuilder book. I didn't find the terms date-time or RFC3339 when searching the kubebuilder book.

fejta-bot commented 5 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

erictune commented 5 years ago

/remove-lifecycle stale

DirectXMan12 commented 5 years ago

We talk a bit about using metav1.Time, which does this for us. We could do better with documenting it, but users shouldn't have to care about using RFC3339, etc since we have metav1.Time support in CT.

fejta-bot commented 4 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

fejta-bot commented 4 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle rotten

fejta-bot commented 4 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /close

k8s-ci-robot commented 4 years ago

@fejta-bot: Closing this issue.

In response to [this](https://github.com/kubernetes-sigs/kubebuilder/issues/476#issuecomment-546743272): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >Send feedback to sig-testing, kubernetes/test-infra and/or [fejta](https://github.com/fejta). >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
erictune commented 4 years ago

/reopen

On Sun, Oct 27, 2019 at 3:51 PM Kubernetes Prow Robot < notifications@github.com> wrote:

Closed #476 https://github.com/kubernetes-sigs/kubebuilder/issues/476.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/kubebuilder/issues/476?email_source=notifications&email_token=AB5245T4YKMSDF6DBZCGMC3QQYLOHA5CNFSM4GDKOTVKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGOUO5R4CA#event-2746949128, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB5245TO5S7PJEZ4GZAKKTLQQYLOHANCNFSM4GDKOTVA .

k8s-ci-robot commented 4 years ago

@erictune: Reopened this issue.

In response to [this](https://github.com/kubernetes-sigs/kubebuilder/issues/476#issuecomment-546746372): >/reopen > >On Sun, Oct 27, 2019 at 3:51 PM Kubernetes Prow Robot < >notifications@github.com> wrote: > >> Closed #476 . >> >> — >> You are receiving this because you authored the thread. >> Reply to this email directly, view it on GitHub >> , >> or unsubscribe >> >> . >> > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
fejta-bot commented 4 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /close

k8s-ci-robot commented 4 years ago

@fejta-bot: Closing this issue.

In response to [this](https://github.com/kubernetes-sigs/kubebuilder/issues/476#issuecomment-558862296): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >Send feedback to sig-testing, kubernetes/test-infra and/or [fejta](https://github.com/fejta). >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
DirectXMan12 commented 4 years ago

/lifecycle frozen /help

k8s-ci-robot commented 4 years ago

@DirectXMan12: This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/kubernetes-sigs/kubebuilder/issues/476): >/lifecycle frozen >/help Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
camilamacedo86 commented 3 years ago

This shows another one nice to the FAQ section such as :

Sajiyah-Salat commented 1 year ago

hello, why this issue is still open.

camilamacedo86 commented 1 year ago

Hi @Sajiyah-Salat,

Did you find this info documented already? If so, could you please add here the link for it?

If not, we need to address it via documentation. The FAQ section shows a good place to do so.

Sajiyah-Salat commented 1 year ago

According to @DirectXMan12 we have metav1.Time we just need to document it. Can I get some resources from which I can get idea of what and how to add? I think this is a document issue. Thank you.

ashutosh887 commented 11 months ago

@camilamacedo86 @varshaprasad96 DO we still need to fix this or it can be closed now?

Sajiyah-Salat commented 11 months ago

Hello @camilamacedo86 I didnt find this info documented though. I would like to take this up? https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#data-types Should we add the whole datatype block in documentation or we should extract data on our own and tweak it. what say?