iSharkFly-Docs/angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-docs-cn/aio/aio-builds-setup/docs/overview--http-status-codes.md
Georgios Kalpakas 20556346a3 feat(aio): add API endpoint for notifying about PR updates 
This commit adds an API endpoint for notifying the preview server about PR
updates (`/pr-updated`). According to the update, the preview server can take
several actions. Currently, it will only check and (if necessary) update the
PR's preview visibility (but more actions could be supported in the future).
The API can be used with an automatic trigger (e.g. a GitHub webhook) to
instantly update a PR's preview visibility when it changes.

Fixes #16526
2017-07-10 12:30:45 +01:00

2.1 KiB
Raw Blame History

Overview - HTTP Status Codes

This is a list of all the possible HTTP status codes returned by the nginx anf upload servers, along with a bried explanation of what they mean:

http://*.ngbuilds.io/*

  • 307 (Temporary Redirect): All non-HTTPS requests. 308 (Permanent Redirect) would be more appropriate, but is not supported by all agents (e.g. cURL).

https://pr<pr>-<sha>.ngbuilds.io/*

  • 200 (OK): File was found or URL was rewritten to /index.html (i.e. all paths that have no . in final segment).

  • 403 (Forbidden): Trying to access a sub-directory.

  • 404 (Not Found): File not found.

https://ngbuilds.io/create-build/<pr>/<sha>

  • 201 (Created): Build deployed successfully and is publicly available.

  • 202 (Accepted): Build not automatically verifiable. Stored for later deployment (after re-verification).

  • 400 (Bad Request): No payload.

  • 401 (Unauthorized): No AUTHORIZATION header.

  • 403 (Forbidden): Unable to verify build (e.g. invalid JWT token, or unable to talk to 3rd-party APIs, etc).

  • 405 (Method Not Allowed): Request method other than POST.

  • 409 (Conflict): Request to overwrite existing directory (e.g. deploy existing build or change PR visibility when the destination directory does already exist).

  • 413 (Payload Too Large): Payload larger than size specified in AIO_UPLOAD_MAX_SIZE.

https://ngbuilds.io/health-check

  • 200 (OK): The server is healthy (i.e. up and running and processing requests).

https://ngbuilds.io/pr-updated

  • 200 (OK): Request processed successfully. Processing may or may not have resulted in further actions.

  • 400 (Bad Request): No payload or no number field in payload.

  • 405 (Method Not Allowed): Request method other than POST.

  • 409 (Conflict): Request to overwrite existing directory (i.e. directories for both visibilities exist). (Normally, this should not happen.)

https://*.ngbuilds.io/*

  • 404 (Not Found): Request not matched by the above rules.

  • 500 (Internal Server Error): Error while processing a request matched by the above rules.