Skip to content
This repository has been archived by the owner on Jun 4, 2021. It is now read-only.

Sources open api spec does not include field descriptions. #182

Closed
vaikas opened this issue Jan 15, 2019 · 2 comments
Closed

Sources open api spec does not include field descriptions. #182

vaikas opened this issue Jan 15, 2019 · 2 comments
Assignees
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@vaikas
Copy link
Contributor

vaikas commented Jan 15, 2019

Expected Behavior

when dumping the CRD for a source, I'll get a description for each of the fields.

For example, Cloud Scheduler shows:
validation:
openAPIV3Schema:
properties:
apiVersion:
type: string
kind:
type: string
metadata:
type: object
spec:
properties:
body:
description: Optional body to send in the event
type: string
googleCloudProject:
description: Google Cloud Project ID to create the scheduler job in.
type: string
httpMethod:
description: Optional HTTP method to use when delivering the event.
If omitted, uses POST
type: string

Actual Behavior

For example, containersource does not:
validation:
openAPIV3Schema:
properties:
apiVersion:
type: string
kind:
type: string
metadata:
type: object
spec:
properties:
args:
items:
type: string
type: array
env:
items:
type: object
type: array
image:
minLength: 1
type: string

Steps to Reproduce the Problem

  1. kubectl get crds containersources.sources.eventing.knative.dev -oyaml
  2. look at the output, fields have no description.

Additional Info

@grantr
Copy link
Contributor

grantr commented Jan 16, 2019

Our version of controller-tools doesn't generate this, but that was fixed in kubernetes-sigs/controller-tools#111 (and kubernetes-sigs/controller-tools#118). I think if we upgrade we'll get this for free. @n3wscott is working on that; first step is knative/eventing#726.

@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 13, 2020
devguyio added a commit to devguyio/eventing-contrib that referenced this issue Dec 1, 2020
Set subscription readiness based on consumer group status (knative#182)

    * WIP: Set subscription readiness based on consumer group status

    * Refactor KafkaWatcher to an edge-triggered, level driven design

    * Refactor the test to prevent a map race

    * goimports and gofmt comments

    * Add tests for the KafkaWatcher and reconnect for AdminClient

    * Improve consumer group watcher code aethetics and robustness

    * Make variable names more descriptive for consumer group watcher and adimn client
    * Forget watcher when channel is deleted
    * Terminate old watcher and free the cache when config is created

    * Set the KafkaChannel consolidated dispatcher reconciler to be read-only

    * Enable HA for KafkaChannel(consolidated) dispatcher

    * Run update-codegen.sh

    * Optimize consumer group watcher

    * Use sets.String for internal cache instead of string slice
    * Allow for a single callback per watcher
    * Synchronization on Terminate and Forget
knative-prow-robot pushed a commit that referenced this issue Dec 1, 2020
Set subscription readiness based on consumer group status (#182)

    * WIP: Set subscription readiness based on consumer group status

    * Refactor KafkaWatcher to an edge-triggered, level driven design

    * Refactor the test to prevent a map race

    * goimports and gofmt comments

    * Add tests for the KafkaWatcher and reconnect for AdminClient

    * Improve consumer group watcher code aethetics and robustness

    * Make variable names more descriptive for consumer group watcher and adimn client
    * Forget watcher when channel is deleted
    * Terminate old watcher and free the cache when config is created

    * Set the KafkaChannel consolidated dispatcher reconciler to be read-only

    * Enable HA for KafkaChannel(consolidated) dispatcher

    * Run update-codegen.sh

    * Optimize consumer group watcher

    * Use sets.String for internal cache instead of string slice
    * Allow for a single callback per watcher
    * Synchronization on Terminate and Forget
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

No branches or pull requests

2 participants