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

Generate a better API file name when saving as JSON/YAML #26

Open
EricWittmann opened this issue Jan 15, 2019 · 7 comments
Open

Generate a better API file name when saving as JSON/YAML #26

EricWittmann opened this issue Jan 15, 2019 · 7 comments
Labels
enhancement New feature or request

Comments

@EricWittmann
Copy link
Member

From @mmajerni : "Regarding Saving as JSON/YAML, it will be great to have an opportunity to change an API file name. Now, all saved API's have name openapi-spec.json/yaml. "

I think the best option is to generate a filename from the API title. Another option is to prompt the user for a filename.

@chirino do you have an opinion on this?

@EricWittmann EricWittmann added the enhancement New feature or request label Jan 15, 2019
@chirino
Copy link
Contributor

chirino commented Jan 16, 2019

I don’t think it’s a bad idea, but I also don’t think it should be high on the priority list.

@EricWittmann
Copy link
Member Author

@chirino Fair enough - do you have a preference between the two approaches?

  1. Prompt for filename
  2. Use the API title as the filename (sanitized)

@chirino
Copy link
Contributor

chirino commented Jan 16, 2019

Don’t really have a preference.

@EricWittmann
Copy link
Member Author

  1. RANDOM NAME!

@amysueg
Copy link

amysueg commented Jan 16, 2019

I think using the API title (sanitized) as the default filename makes the most sense here @EricWittmann @chirino

@chirino
Copy link
Contributor

chirino commented Jan 16, 2019

Keep in mind that we name the document open-api.json in all the camel projects by convention. Keeping to the existing default makes it easier to work with camel projects.

@schelv
Copy link

schelv commented Sep 9, 2021

openapi.yaml or openapi.json are the names recommended in the specification

cunningt pushed a commit to cunningt/apicurito that referenced this issue Jun 2, 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

4 participants