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 AWSSNSSource #321

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 awssnssources.spec
KIND:     AWSSNSSource
VERSION:  sources.triggermesh.io/v1alpha1

RESOURCE: spec <Object>

DESCRIPTION:
     Desired state of the event source.

FIELDS:
   arn  <string> -required-
     ARN of the Amazon SNS topic to consume messages from. The expected format
     is documented at
     https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html#amazonsns-resources-for-iam-policies

   credentials  <Object>
     Credentials to interact with the Amazon SNS 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

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

   subscriptionAttributes       <Object>
     Attributes to set on the Amazon SNS Subscription that is used for receiving
     messages from the SNS topic.