search

triggermesh / aws-event-sources

Knative event sources for AWS services
Apache License 2.0
60 stars 14 forks source link

Document OpenAPI schema for AWSCodeCommitSource #316

Closed antoineco closed 3 years ago

antoineco commented 3 years ago

Part of #313

Demo :

(just printing the top level spec, please check locally for yourself if you're interested in printing the doc for sub-attributes)

$ kubectl explain awscodecommitsources.spec
KIND:     AWSCodeCommitSource
VERSION:  sources.triggermesh.io/v1alpha1

RESOURCE: spec <Object>

DESCRIPTION:
     Desired state of the event source.

FIELDS:
   arn  <string> -required-
     ARN of the CodeCommit repository to receive events from. The expected
     format is documented at
     https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscodecommit.html#awscodecommit-resources-for-iam-policies

   branch       <string> -required-
     Name of the Git branch this source observes.

   credentials  <Object>
     Credentials to interact with the Amazon CodeCommit API. For more
     information about AWS security credentials, please refer to the AWS General
     Reference at
     https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html

   eventTypes   <[]string> -required-
     List of event types that should be processed by the source.

   sink <Object> -required-
     The destination of events sourced from Amazon CodeCommit.