Skip to content

Commit 90f506f

Browse files
fix(docs): Add synopsis for bind apiservice and preserve list formatting (#392)
1 parent 6ce7902 commit 90f506f

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

  • cli/pkg/kubectl/bind-apiservice/cmd

cli/pkg/kubectl/bind-apiservice/cmd/cmd.go

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,22 @@ var (
4444
func New(streams genericclioptions.IOStreams) (*cobra.Command, error) {
4545
opts := plugin.NewBindAPIServiceOptions(streams)
4646
cmd := &cobra.Command{
47-
Use: "apiservice https://<url-to-a-APIServiceExportRequest>|-f <file-to-a-APIBindingRequest>",
48-
Short: "Bind to a remote API service",
49-
Example: help.Examplesf(bindAPIServiceExampleUses, "kubectl bind"),
47+
Use: "apiservice https://<url-to-a-APIServiceExportRequest>|-f <file-to-a-APIBindingRequest>",
48+
Short: "Bind to a remote API service",
49+
Long: help.Doc(`
50+
Bind to a remote API service by creating an APIServiceExportRequest.
51+
52+
This command allows you to bind remote services into your cluster by either:
53+
54+
- Providing a URL to an APIServiceExportRequest resource
55+
- Providing a file containing an APIServiceExportRequest manifest
56+
- Using a template name to interactively create the binding
57+
58+
The command will authenticate with the remote service provider, create the necessary
59+
APIServiceExportRequest, and deploy a konnector to establish the connection between
60+
your cluster and the remote service.
61+
`),
62+
Example: fmt.Sprintf(bindAPIServiceExampleUses, "kubectl bind"),
5063
SilenceUsage: true,
5164
RunE: func(cmd *cobra.Command, args []string) error {
5265
if err := logsv1.ValidateAndApply(opts.Logs, nil); err != nil {

0 commit comments

Comments
 (0)