doc: add OpenAPI validation info to user guide #1640
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The generated YAML CRD created when running `operator-sdk add api ...`
includes an OpenAPI v3.0 validation section. E.g.
```YAML
validation:
openAPIV3Schema:
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
type: object
status:
type: object
```
The properties for a CRD should be specified here for validation.
In the case of the Memcached example, a `size` property should be
added to the generated CRD. This change documents that process in
the user guide.
openshift-ci-robot
added
the
size/S
estroz
reviewed
Jul 3, 2019
doc/user-guide.md
Outdated
| $ operator-sdk generate k8s | ||
| ``` | ||
|
|
||
| Update the Open API validation section in the CRD at `deploy/crds/cache_v1alpha1_memcached_crd.yaml` so that Kubernetes can validate the properties in a Memcached Custom Resource when it is created or updated. |
There was a problem hiding this comment.
This should read something like:
To update the OpenAPI validation section in the CRD `deploy/crds/cache_v1alpha1_memcached_crd.yaml`, run the following command:
\```console
$ operator-sdk generate openapi
\```
This validation section allows Kubernetes to validate the properties in a Memcached Custom Resource when it is created or updated. An example of the generated YAML is as follows:
There was a problem hiding this comment.
Oh! I didn't realize that generate openapi was available. Thanks for this. The change has been made.
|
/test e2e-aws-ansible |
hasbro17
reviewed
Jul 9, 2019
|
@estroz We don't have any of the upstream validation directive tags documented anywhere yet right? |
Co-Authored-By: Haseeb Tariq <hasbro17@gmail.com>
|
Thanks for this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change:
The generated YAML CRD created when running
operator-sdk add api ...includes an OpenAPI v3.0 validation section. E.g.
The properties for a CRD should be specified here for validation.
In the case of the Memcached example, a
sizeproperty should beadded to the generated CRD. This change documents that process in
the user guide.
Motivation for the change:
I got hung up on this when going through the tutorial. I thought I was missing a step or something wasn't right when examining the generated CRD files and following the user guide. Perhaps this will make it a little clearer for people just starting out.