Clarify /api/ not in base path in README

[david4096]

The api in the documentation is an artifact of running via AWS lambda and not a part of the schematization. The OpenAPI description shows the needed basePath.

To close this issue, make a note in the readme about how AWS adds the api path to development API gateway instances.

┆Issue is synchronized with this JIRA Story ┆Project Name: dos-dss-lambda ┆Issue Number: DDL-2

[mikebaumann]

Moreover, I suggest the readme files for the AWS Lambda based implementations of DOS be updated to recommend configuration of a Custom Domain Name, as described here: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html

Doing so has multiple benefits, including:

• Eliminating the stage name (e.g. 'api' in this case) from the URL used to reference the service
• Providing a stable domain name that can continue to be used even if the underlying Lambda host name changes (e.g. due to removing and redeploying the Lambda to resolve a issue) or the deployment stage changes
• Providing a user friendly domain name that, among other things, allows association of the Lambda with a given institution (e.g. UCSC, UChicago, etc.)

[david4096]

Thanks @mikebaumann!

I don't think it is necessarily assumed that a DOS service will be from the root level of a path. One simply must know the root path when instantiating a client, as the schemas return a base path to the client.

That being said, to close this we'll remove all automatically generated API gateway URLs from publicly facing repositories, unless specified as the generated URL when doing local development.