Skip to content
This repository has been archived by the owner on Feb 1, 2019. It is now read-only.

Update API docs #98

Open
wpears opened this issue Sep 18, 2015 · 1 comment
Open

Update API docs #98

wpears opened this issue Sep 18, 2015 · 1 comment

Comments

@wpears
Copy link
Member

wpears commented Sep 18, 2015

Currently the generated API docs include "api" in the path, eg,
http://<servername>/api/isValidMSA/:activityYear/:msa

However, no Kraken controller exists for /api and as such all the example routes are incorrect (dropping the /api part makes them valid).

Perhaps this was included in case the api was sitting behind a reverse proxy which required additional path components to reach the api but then only passed the remaining path fragments, eg, curl server/some/path/isValidMSA/12345 but the app only sees the /isValidMSA/12345 part.

Either way, I'd say remove /api from the docs and perhaps include a note about how to deal with the api not accepting requests at the root path of the server.

@LinuxBozo
Copy link
Contributor

This is definitely a shortcoming in the documentation. To get around CORS issues, it is best to run the API bits behind a proxy within the same FQDN that the frontend (hmda-pilot) is running. This ensures that everything is requested from the same FQDN, thus eliminating issues with CORS.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants