Skip to content

Commit

Permalink
chore(o2k): update cli help to reflect inso compatibility (#1067)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske authored Oct 31, 2023
1 parent 3b72c96 commit b11a1cc
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions cmd/file_openapi2kong.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,18 @@ func newOpenapi2KongCmd() *cobra.Command {
Short: "Convert OpenAPI files to Kong's decK format",
Long: `Convert OpenAPI files to Kong's decK format.
IMPORTANT: due to comatibility issues with the older 'inso' tool, it is strongly recommended
to use the '--inso-compatible' flag when converting OpenAPI files.
The example file at https://github.com/Kong/go-apiops/blob/main/docs/learnservice_oas.yaml
has extensive annotations explaining the conversion process, as well as all supported
custom annotations (x-kong-... directives).
The output will be targeted at Kong version 3.x.
`,
RunE: executeOpenapi2Kong,
Example: "# Convert an OAS file, adding 2 tags, and namespacing the UUIDs to a unique name\n" +
"cat service_oas.yml | deck file openapi2kong --select-tag=serviceA,teamB --uuid-base=unique-service-name",
Example: "# Convert an OAS file, adding 2 tags, with inso compatibility enabled\n" +
"cat service_oas.yml | deck file openapi2kong --inso-compatible --select-tag=serviceA,teamB",
Args: cobra.NoArgs,
}

Expand Down

0 comments on commit b11a1cc

Please sign in to comment.