Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some spelling mistakes #395

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Fix some spelling mistakes #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions api/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_
```
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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
10 changes: 5 additions & 5 deletions api/routes/job.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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',
Expand Down
4 changes: 2 additions & 2 deletions api/web/src/components/util/MustLogin.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>
<p class='my6'>
Financial backers of the project can also export in CSV &amp; 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.
</p>
</div>
<div class="modal-footer">
Expand All @@ -25,7 +25,7 @@

<script>
import {
TablerModal
TablerModal
} from '@tak-ps/vue-tabler';
import {
IconUserExclamation
Expand Down
Loading