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

Update API docs #98

@wpears

Description

@wpears

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions