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

Run command from folder path #60

Open
maxkisung opened this issue Sep 27, 2019 · 3 comments
Open

Run command from folder path #60

maxkisung opened this issue Sep 27, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request
Projects

Comments

@maxkisung
Copy link

maxkisung commented Sep 27, 2019

Can you have autorest run from the swagger doc's folder path so it can read configuration from a readme.md?

I would be able to override the client name from there.

@christianhelle
Copy link
Owner

I didn't know AutoRest could do that!! What arguments do I need to pass in for that and how would you structure your README.md for this to work?

@christianhelle christianhelle self-assigned this Sep 28, 2019
@christianhelle christianhelle added the enhancement New feature or request label Sep 28, 2019
@maxkisung
Copy link
Author

maxkisung commented Sep 28, 2019

The documentation is scattered and not consistent.
http://azure.github.io/autorest/user/configuration.html
https://github.com/Azure/autorest/wiki/How-do-configuration-files-work-with-AutoRest%3F
https://github.com/Azure/autorest/tree/master/Samples
https://github.com/Azure/autorest/blob/master/docs/user/literate-file-formats/configuration.md

Configuration files can be in json, yaml, or markdown (.md).

Command-line Usage autorest [config-file.md | config-file.json | config-file.yaml] [additional options]

It will automatically find readme.md files. So you wouldn't have to add a command line argument if you used a readme.md.
I've only tried it with the readme.md.

for markdown files, autorest will look for this line
> see https://aka.ms/autorest
and then yaml or json between two sets of ```

@christianhelle
Copy link
Owner

Thanks for the links! I'll see what I can do!

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
No open projects
AutoRest V3
  
To Do
Development

No branches or pull requests

2 participants