diff --git a/.gitignore b/.gitignore index 702257894..581cc4cc7 100644 --- a/.gitignore +++ b/.gitignore @@ -180,3 +180,4 @@ test-source/ test-destination/ test-portal/ /.idea/ +.github/copilot-instructions.md \ No newline at end of file diff --git a/README.md b/README.md index 677eb57e2..1b79ffafa 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ $ npm install -g @apimatic/cli $ apimatic COMMAND running command... $ apimatic (--version) -@apimatic/cli/1.1.0-alpha.21 win32-x64 node-v23.4.0 +@apimatic/cli/1.1.0-alpha.22 win32-x64 node-v23.4.0 $ apimatic --help [COMMAND] USAGE $ apimatic COMMAND @@ -34,130 +34,137 @@ USAGE # Commands -* [`apimatic api:transform`](#apimatic-apitransform) -* [`apimatic api:validate`](#apimatic-apivalidate) -* [`apimatic auth:login`](#apimatic-authlogin) -* [`apimatic auth:logout`](#apimatic-authlogout) -* [`apimatic auth:status`](#apimatic-authstatus) +* [`apimatic api transform`](#apimatic-api-transform) +* [`apimatic api validate`](#apimatic-api-validate) +* [`apimatic auth login`](#apimatic-auth-login) +* [`apimatic auth logout`](#apimatic-auth-logout) +* [`apimatic auth status`](#apimatic-auth-status) * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell) * [`apimatic help [COMMAND]`](#apimatic-help-command) -* [`apimatic portal:copilot`](#apimatic-portalcopilot) -* [`apimatic portal:generate`](#apimatic-portalgenerate) -* [`apimatic portal:quickstart`](#apimatic-portalquickstart) -* [`apimatic portal:recipe:new`](#apimatic-portalrecipenew) -* [`apimatic portal:serve`](#apimatic-portalserve) -* [`apimatic portal:toc:new`](#apimatic-portaltocnew) -* [`apimatic sdk:generate`](#apimatic-sdkgenerate) +* [`apimatic portal copilot`](#apimatic-portal-copilot) +* [`apimatic portal generate`](#apimatic-portal-generate) +* [`apimatic portal quickstart`](#apimatic-portal-quickstart) +* [`apimatic portal recipe new`](#apimatic-portal-recipe-new) +* [`apimatic portal serve`](#apimatic-portal-serve) +* [`apimatic portal toc new`](#apimatic-portal-toc-new) +* [`apimatic sdk generate`](#apimatic-sdk-generate) -## `apimatic api:transform` +## `apimatic api transform` -Transform API specifications from one format to another. Supports [10+ different formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman Collections. +Transform API specifications between different formats. ``` USAGE - $ apimatic api:transform --format [--file ] [--url ] [-d ] [-f] [-k ] + $ apimatic api transform --format + apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apiblueprint|raml|raml10|postman10|postman2 + 0|graphqlschema [--file ] [--url ] [-d ] [-f] [-k ] FLAGS - -d, --destination= [default: ./] directory to download transformed file to + -d, --destination= [default: ./] directory to save the transformed file to -f, --force overwrite changes without asking for user consent. -k, --auth-key= override current authentication state with an authentication key. --file= path to the API specification file to transform - --format= (required) specification format to transform API specification into - APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML| - RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA - --url= URL to the API specification file to transform. Can be used in place of the --file option - if the API specification is publicly available. + --format=