Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update custom resource doc, and make it available in OpenApi spec #94

Merged
merged 9 commits into from
Oct 14, 2019
Merged

Update custom resource doc, and make it available in OpenApi spec #94

merged 9 commits into from
Oct 14, 2019

Conversation

tomgeorge
Copy link
Contributor

@tomgeorge tomgeorge commented Oct 11, 2019

Description

This PR :

  • adds an openapi schema to the CheCluster CRD, allowing for completion and validation in the OpenShift 4.2 console.
  • updates the comments of each Custom Resource field so that they can be the basis of the official CheCluster custom resource documentation.

This is the implementarion part of issue eclipse-che/che#13886 (comment)

NOTE related to docs:

@rkratky

The updated documentation comments added in file che-types.go contain the description of the content that should also be documented in the Che documentation (by the docs team ?).

Signed-off-by: Tom George <tg82490@gmail.com>
Signed-off-by: Tom George <tg82490@gmail.com>
pkg/apis/org/v1/che_types.go Outdated Show resolved Hide resolved
tomgeorge and others added 7 commits October 11, 2019 15:32
Signed-off-by: Tom George <tg82490@gmail.com>
Signed-off-by: Tom George <tg82490@gmail.com>
Signed-off-by: David Festal <dfestal@redhat.com>
Signed-off-by: David Festal <dfestal@redhat.com>
Signed-off-by: David Festal <dfestal@redhat.com>
Signed-off-by: David Festal <dfestal@redhat.com>
Signed-off-by: David Festal <dfestal@redhat.com>
@davidfestal davidfestal changed the title [WIP] - Add openapi spec Add openapi spec Oct 14, 2019
@davidfestal davidfestal changed the title Add openapi spec Update custom resource doc, and make it available in OpenApi spec Oct 14, 2019
@davidfestal davidfestal merged commit 431809f into eclipse-che:master Oct 14, 2019
@ibuziuk ibuziuk requested a review from rkratky October 14, 2019 15:51
@tomgeorge tomgeorge deleted the openapi-spec branch October 21, 2019 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants