Skip to content
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.

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

Wizard Creation #1

Closed
robmorgan-tab opened this issue Nov 17, 2022 · 0 comments
Closed

Wizard Creation #1

robmorgan-tab opened this issue Nov 17, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@robmorgan-tab
Copy link
Contributor

robmorgan-tab commented Nov 17, 2022

Let the user choose:

  1. Project Name
  • Required
  • Any string value of length > 0
  1. Project Document Syntax
  • The user should pick one document syntax for OpenAPI files in the project.
  • This can be YAML or JSON
  • The wizard provide the user with only these two options to choose from.
  • Requires an answer
  • Default value: JSON
  1. Root Document Filename
  • The root document filename (default: openapi)
  • Wizard should ignore any known file extensions. e.g. if the user enters my-api.json, don't include the .json file extension in the output value from this step. It should however include dot portions. e.g. company.account.api would pass the value forward unaltered.
  • If the user has selected a document syntax AND has entered a file extension into this field AND they do not match, show an appropriate error message and don't let them proceed.
  • Filenames must be valid on both windows & unix based systems (you may want to use something like valid-filename to check this

Given the user has chosen valid selection for the above steps
Then a file should be created in the following relative directory:
./spec/${rootDocumentFilename}.${projectDocumentSyntax.extension}

@robmorgan-tab robmorgan-tab added the enhancement New feature or request label Nov 17, 2022
@robmorgan-tab robmorgan-tab added this to the Launch milestone Nov 17, 2022
@Si3rr4wow Si3rr4wow self-assigned this Nov 21, 2022
@Si3rr4wow Si3rr4wow mentioned this issue Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants