Skip to content

docs: fix typos in CLI help text and documentation #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos in CLI help text and documentation #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmd/namespace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,11 @@ func executeNamespace(cmd *cobra.Command, _ []string) error {

var namespaceCmd = &cobra.Command{
Use: "namespace [flags]",
Short: "Namespaces API paths by prefixing it",
Long: `Namespaces API paths by prefixing it.
Short: "Namespaces API paths by prefixing them",
Long: `Namespaces API paths by prefixing them.

By prefixing paths with a specific segment, colliding paths to services can be
namespaced to prevent the collisions. Eg. 2 API definitions that both expose a
namespaced to prevent the collisions. E.g. 2 API definitions that both expose a
'/list' path. By prefixing one with '/addressbook' and the other with '/cookbook'
the resulting paths '/addressbook/list' and '/cookbook/list' can be exposed without
colliding.
Expand Down Expand Up @@ -168,7 +168,7 @@ func init() {
string(filebasics.OutputFormatJSON)+" or "+string(filebasics.OutputFormatYaml))
namespaceCmd.Flags().StringArrayP("selector", "", []string{},
"json-pointer identifying routes to update (can be specified more than once)")
namespaceCmd.Flags().StringP("path-prefix", "p", "", "the path based namespace to apply")
namespaceCmd.Flags().StringP("path-prefix", "p", "", "the path-based namespace to apply")
namespaceCmd.Flags().BoolP("allow-empty-selectors", "", false, "do not error out if the selectors return empty")
namespaceCmd.Flags().StringArrayP("host", "h", []string{},
"hostname to add to the route.hosts property (can be specified more than once)")
Expand Down
2 changes: 1 addition & 1 deletion cmd/openapi2mcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ func init() {
openapi2mcpCmd.Flags().StringP("format", "", string(filebasics.OutputFormatYaml), "output format: "+
string(filebasics.OutputFormatJSON)+" or "+string(filebasics.OutputFormatYaml))
openapi2mcpCmd.Flags().StringP("uuid-base", "", "",
`the unique base-string for uuid-v5 generation of entity id's (if omitted
`the unique base-string for uuid-v5 generation of entity IDs (if omitted
will use the root-level "x-kong-name" directive, or fall back to 'info.title')`)
openapi2mcpCmd.Flags().StringSlice("select-tag", nil,
`select tags to apply to all entities (if omitted will use the "x-kong-tags"
Expand Down
2 changes: 1 addition & 1 deletion cmd/patch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The input file will be read, the patches will be applied, and if successful, wri
to the output file. The patches can be specified by a '--selector' and one or more
'--value' tags, or via patch-files.

When using '--selector' and '--values', the items will be selected by the 'selector' which is
When using '--selector' and '--value', the items will be selected by the 'selector' which is
a JSONpath query. From the array of nodes found, only the objects will be updated.
The 'values' will be applied on each of the JSONobjects returned by the 'selector'.

Expand Down
Loading