From 050dedba062de23b7e6507e1df5ec4c805c273c2 Mon Sep 17 00:00:00 2001 From: ckoegel Date: Fri, 8 Nov 2024 11:16:46 -0500 Subject: [PATCH] update readme --- README.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 3e1ebdab..8c4a1e48 100644 --- a/README.md +++ b/README.md @@ -5,43 +5,27 @@ This action utilizes the [openapi-generator-cli](https://github.com/OpenAPITools ## Inputs ```yml -branch-name: - description: Branch name - required: true -token: - description: Github auth token - required: true language: description: The generator name (language) (`-g`) argument for the openapi-generator-cli required: true config: description: The configuration (`-c`) argument for the openapi-generator-cli - required: true -user-email: - description: Git user email - default: dx@bandwidth.com required: false -username: - description: Github username - default: DX-Bandwidth + default: ./openapi-config.yml +api-spec-path: + description: The destination of the API Specification to generate a client from required: false + default: ./bandwidth.yml openapi-generator-version: description: The OpenAPI Generator project version, in `x.x.x` format required: false - default: '6.5.0' -api-spec-path: - description: The destination of the API Specification to generate a client from + default: '7.6.0' +additional-properties: + description: Additional properties to pass to the generator required: false - default: ./bandwidth.yml -working-directory: + default: '' +working-directory: description: The working directory to run the action in required: false default: ./ ``` - -## Outputs - -```yml -changes: - description: Boolean representing if files in the SDK were changed or not. -```