Skip to content

Commit 05f7324

Browse files
committed
fix(docs): Add synopsis for bind apiservice and preserve list formatting
Signed-off-by: olalekan odukoya <odukoyaonline@gmail.com>
1 parent 404f7d2 commit 05f7324

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

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

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,20 @@ 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(`Bind to a remote API service by creating an APIServiceExportRequest.
50+
51+
This command allows you to bind remote services into your cluster by either:
52+
53+
- Providing a URL to an APIServiceExportRequest resource
54+
- Providing a file containing an APIServiceExportRequest manifest
55+
- Using a template name to interactively create the binding
56+
57+
The command will authenticate with the remote service provider, create the necessary
58+
APIServiceExportRequest, and deploy a konnector to establish the connection between
59+
your cluster and the remote service.`),
60+
Example: fmt.Sprintf(bindAPIServiceExampleUses, "kubectl bind"),
5061
SilenceUsage: true,
5162
RunE: func(cmd *cobra.Command, args []string) error {
5263
if err := logsv1.ValidateAndApply(opts.Logs, nil); err != nil {

0 commit comments

Comments
 (0)