Updated README and dependencies - #31
Conversation
kciurleo
left a comment
kciurleo
left a comment
There was a problem hiding this comment.
Looks great, especially the endpoint documentation for such varied endpoints!
| * **Query Params** | ||
| ``` | ||
| git clone https://github.com/LCOGT/photonranch-api.git | ||
| cd photonranch-calendar |
|
|
||
| * **Code:** 500 <br /> | ||
| **Content:** `{ error : "The specified sitecode did not match any config file." }` | ||
| Requests for all services in this repository are handled at the base URL `https://api.photonranch.org/{stage}`. |
There was a problem hiding this comment.
I agree that we should change the naming so this is true (and consistent with other repositories) - "dev" for dev, "prod" for prod etc
timbeccue
left a comment
timbeccue
left a comment
There was a problem hiding this comment.
Great work! Looks good to me.
| staging: | ||
| outputs: | ||
| deploy-stage: ${{ steps.deploy-stage.outputs.stage }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Set up deployment stage | ||
| id: deploy-stage | ||
| run: | | ||
| echo "::set-output name=stage::${{ fromJSON('{"main":"prod","dev":"dev","test":"test"}')[github.ref_name] }}" |
There was a problem hiding this comment.
The name 'staging' is already a common word for a specific part of a deployment process. Usually it refers to an environment that behaves like our dev setup. I would recommend changing the name here to avoid confusion. Since it's basically just assigning a value to a variable, maybe something descriptive along those lines.
|
|
||
| First, get a list of files to be zipped based on | ||
| the query parameters specified. Next, call a Lambda function | ||
| (defined in the repository zip-downloads) that creates a zip |
There was a problem hiding this comment.
The repository is now called photonranch-downloads
| authorizerFunc: | ||
| handler: authorizer.auth | ||
| handler: api/authorizer.auth | ||
| cors: true |
There was a problem hiding this comment.
this line can be removed
There was a problem hiding this comment.
The cors: true line, to be clear
3 participants
This PR adds the following changes:
weather.pyfileOne thing to note is that the dev stage is still called "api" (check the
serverless.ymlfile). We should decide if we want to change this so that the stage naming convention matches the other repositories. (Additionally, I added in the readme that the base URL has/{stage}at the end, but unsure if this will need to change.)