Make OAS_PATH default to the current directory and remove appended path

Nexmo / nexmo-oas-renderer

Render your API references, Nexmo-style!

https://developer.nexmo.com/api

MIT License

46 stars 4 forks source link

Make OAS_PATH default to the current directory and remove appended path #2

Closed mheap closed 5 years ago

mheap commented 5 years ago

Previously we added _open_api/api_specs to OAS_PATH, but this makes the gem difficult to use locally. This PR removes this requirement and Nexmo Developer will set an OAS_PATH of _open_api/api_specs.

This allows users to run nexmo-oas-renderer locally in the api-specification repo and have the endpoint rendered as expected. This does not include any errors as they are provided in errors.md in the Nexmo Developer project, and will be addressed in a future PR

fabianrbz commented 5 years ago

@mheap i tested this locally and some of the pages doesn't work when the app is mounted (the tab filter is blowing up because it can't find a reference to _examples) and also some didn't work when running the cli in the api-specification repo (I believe those are the docs that are not under _open_api).

mheap commented 5 years ago

@fabianrbz Which pages specifically? I tested all the pages linked from /api

fabianrbz commented 5 years ago

@mheap I need to check, but maybe it was the way I was running it, from which folder did you run it?

mheap commented 5 years ago

@fabianrbz OAS_PATH=_open_api/api_specs in .env and bin/rails s