diff --git a/api/API.md b/api/API.md index aa123d61..cd8c28e9 100644 --- a/api/API.md +++ b/api/API.md @@ -17,7 +17,7 @@ Once an API token has been obtained, scripted calls to the API can be made by us Authentication. This header must be included with all calls to the API. Note: Basic authentication (username, password) is not supported by any API endpoint other than initial login. -A valid API token must generated for programatic access +A valid API token must be generated for programmatic access _Example_ ``` @@ -48,7 +48,7 @@ always remain free to download for all users ## Sponsor Benefits -Sponsors have access to all of the benefits that a Backer recieves as well as the following. +Sponsors have access to all of the benefits that a Backer receives as well as the following. ### Direct AWS S3 @@ -57,11 +57,11 @@ Endpoints that track data will return an `s3` key as part of the JSON response w full S3 URL to the file in question. It should be noted that files themselves on S3 are subject to change and the current location -of a file on S3 is not guarenteed. The API will always return the most up-to-date location. +of a file on S3 is not guaranteed. The API will always return the most up-to-date location. ### Validated Data {Experimental} -Validated data improves upon the authoratative data provided and curated by government entities. +Validated data improves upon the authoritative data provided and curated by government entities. We currently only generate validated data for `address` sources @@ -70,6 +70,6 @@ We currently only generate validated data for `address` sources - Remove data with no/invalid street name Future Operations -- Perform Abbreviation Expansion (`E` => `East`, etc) +- Perform Abbreviation Expansion (`E` => `East`, etc.) - Clip data to expected geographic area to ensure erroneous data isn't included (IE: Null Islands) - Add City/Postcode/Region/State data where it doesn't exist diff --git a/api/routes/job.js b/api/routes/job.js index d19b540d..6c0c474e 100644 --- a/api/routes/job.js +++ b/api/routes/job.js @@ -142,11 +142,11 @@ export default async function router(schema, config) { group: 'Job', auth: 'user', description: ` - Sponsors of our project recieve access to validated data as a way of saying thanks for + Sponsors of our project receive access to validated data as a way of saying thanks for keeping our project alive. Note: the user must be authenticated to perform a download. One of our largest costs is - S3 egress, authenticated downloads allow us to prevent abuse and keep the project running and the data freetw + S3 egress, authenticated downloads allow us to prevent abuse, keep the project running, and the data free. Faster Downloads? Have AWS? The Jobs, Data, & Collections API all return an "s3" property which links to a requester pays object on S3. For those that are able, this is the best way to download data. @@ -175,7 +175,7 @@ export default async function router(schema, config) { auth: 'user', description: ` Note: the user must be authenticated to perform a download. One of our largest costs is - S3 egress, authenticated downloads allow us to prevent abuse and keep the project running and the data freetw + S3 egress, authenticated downloads allow us to prevent abuse and keep the project running and the data free. Faster Downloads? Have AWS? The Jobs, Data, & Collections API all return an "s3" property which links to a requester pays object on S3. For those that are able, this is the best way to download data. @@ -223,7 +223,7 @@ export default async function router(schema, config) { auth: 'user', description: ` Note: the user must be authenticated to perform a download. One of our largest costs is - S3 egress, authenticated downloads allow us to prevent abuse and keep the project running and the data freetw + S3 egress, authenticated downloads allow us to prevent abuse and keep the project running and the data free. Faster Downloads? Have AWS? The Jobs, Data, & Collections API all return an "s3" property which links to a requester pays object on S3. For those that are able, this is the best way to download data. @@ -249,7 +249,7 @@ export default async function router(schema, config) { description: ` Return the batch-machine processing log for a given job Note: These are stored in AWS CloudWatch and *do* expire - The presence of a loglink on a job, does not guarentree log retention + The presence of a loglink on a job, does not guarantee log retention `, ':job': 'integer', query: 'req.query.SingleLog.json', diff --git a/api/web/src/components/util/MustLogin.vue b/api/web/src/components/util/MustLogin.vue index a676804d..e01e4cfe 100644 --- a/api/web/src/components/util/MustLogin.vue +++ b/api/web/src/components/util/MustLogin.vue @@ -13,7 +13,7 @@

Financial backers of the project can also export in CSV & Shapefile, and sponsors - recieve access to our validated data as well as direct AWS S3 access. + receive access to our validated data as well as direct AWS S3 access.