Skip to content

Commit a52a295

Browse files
committed
fixes
1 parent 616ea68 commit a52a295

File tree

41 files changed

+106
-106
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+106
-106
lines changed

docs/developers/applications/define-routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ By default, route URLs are configured to be:
2020
2121
However, you can specify the path to be `/` if you wish to have your routes handling the root path of incoming URLs.
2222

23-
- The route below, using the default config, within the **dogs** project, with a route of **breeds** would be available at **http:/localhost:9926/dogs/breeds**.
23+
- The route below, using the default config, within the **dogs** project, with a route of **breeds** would be available at **[http://localhost:9926/dogs/breeds](http://localhost:9926/dogs/breeds)**.
2424

2525
In effect, this route is just a pass-through to Harper. The same result could have been achieved by hitting the core Harper API, since it uses **hdbCore.preValidation** and **hdbCore.request**, which are defined in the "helper methods" section, below.
2626

docs/developers/operations-api/components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ HarperDB/application-template#semver:v1.0.0
5454
You can also install from private repository if you have installed SSH keys on the server. Ensure the `host` portion of the url exactly matches the `host` used when adding ssh keys to ensure proper authentication.
5555

5656
```
57-
git+ssh:/[email protected]:my-org/my-app.git#semver:v1.0.0
57+
git+ssh://[email protected]:my-org/my-app.git#semver:v1.0.0
5858
```
5959

6060
Or you can use a Github token:
@@ -369,9 +369,9 @@ Host harperdb-private-component.github.com
369369
```
370370

371371
```
372-
"package": "git+ssh:/git@<host>:<github-repo-path>.git#semver:v1.2.3"
372+
"package": "git+ssh://git@<host>:<github-repo-path>.git#semver:v1.2.3"
373373
374-
"package": "git+ssh:/[email protected]:HarperDB/harperdb-private-component.git#semver:v1.2.3"
374+
"package": "git+ssh://[email protected]:HarperDB/harperdb-private-component.git#semver:v1.2.3"
375375
```
376376

377377
Note that `deploy_component` with a package uses `npm install` so the url must be a valid npm format url. The above is an example of a url using a tag in the repo to install.

docs/developers/security/jwt-auth.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Users must initially create tokens using their Harper credentials. The following
2828
A full cURL example can be seen here:
2929

3030
```bash
31-
curl --location --request POST 'http:/localhost:9925' \
31+
curl --location --request POST 'http://localhost:9925' \
3232
--header 'Content-Type: application/json' \
3333
--data-raw '{
3434
"operation": "create_authentication_tokens",
@@ -51,7 +51,7 @@ An example expected return object is:
5151
The `operation_token` value is used to authenticate all operations in place of our standard Basic auth. In order to pass the token you will need to create an Bearer Token Authorization Header like the following request:
5252

5353
```bash
54-
curl --location --request POST 'http:/localhost:9925' \
54+
curl --location --request POST 'http://localhost:9925' \
5555
--header 'Content-Type: application/json' \
5656
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXJuYW1lIiwiaWF0IjoxNjA0OTc4MjAwLCJleHAiOjE2MDUwNjQ2MDAsInN1YiI6Im9wZXJhdGlvbiJ9.MpQA-9CMjA-mn-7mHyUXSuSC_-kqMqJXp_NDiKLFtbtMRbodCuY3DzH401rvy_4vb0yCELf0B5EapLVY1545sv80nxSl6FoZFxQaDWYXycoia6zHpiveR8hKlmA6_XTWHJbY2FM1HAFrdtt3yUTiF-ylkdNbPG7u7fRjTmHfsZ78gd2MNWIDkHoqWuFxIyqk8XydQpsjULf2Uacirt9FmHfkMZ-Jr_rRpcIEW0FZyLInbm6uxLfseFt87wA0TbZ0ofImjAuaW_3mYs-3H48CxP152UJ0jByPb0kHsk1QKP7YHWx1-Wce9NgNADfG5rfgMHANL85zvkv8sJmIGZIoSpMuU3CIqD2rgYnMY-L5dQN1fgfROrPMuAtlYCRK7r-IpjvMDQtRmCiNG45nGsM4DTzsa5GyDrkGssd5OBhl9gr9z9Bb5HQVYhSKIOiy72dK5dQNBklD4eGLMmo-u322zBITmE0lKaBcwYGJw2mmkYcrjDOmsDseU6Bf_zVUd9WF3FqwNkhg4D7nrfNSC_flalkxPHckU5EC_79cqoUIX2ogufBW5XgYbU4WfLloKcIpb51YTZlZfwBHlHPSyaq_guaXFaeCUXKq39_i1n0HRF_mRaxNru0cNDFT9Fm3eD7V8axFijSVAMDyQs_JR7SY483YDKUfN4l-vw-EVynImr4' \
5757
--data-raw '{
@@ -68,7 +68,7 @@ curl --location --request POST 'http:/localhost:9925' \
6868
`operation_token` expires at a set interval. Once it expires it will no longer be accepted by Harper. This duration defaults to one day, and is configurable in [harperdb-config.yaml](../../deployments/configuration). To generate a new `operation_token`, the `refresh_operation_token` operation is used, passing the `refresh_token` in the Bearer Token Authorization Header. A full cURL example can be seen here:
6969

7070
```bash
71-
curl --location --request POST 'http:/localhost:9925' \
71+
curl --location --request POST 'http://localhost:9925' \
7272
--header 'Content-Type: application/json' \
7373
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXJuYW1lIiwiaWF0IjoxNjA0OTc4MjAwLCJleHAiOjE2MDc1NzAyMDAsInN1YiI6InJlZnJlc2gifQ.acaCsk-CJWIMLGDZdGnsthyZsJfQ8ihXLyE8mTji8PgGkpbwhs7e1O0uitMgP_pGjHq2tey1BHSwoeCL49b18WyMIB10hK-q2BXGKQkykltjTrQbg7VsdFi0h57mGfO0IqAwYd55_hzHZNnyJMh4b0iPQFDwU7iTD7x9doHhZAvzElpkWbc_NKVw5_Mw3znjntSzbuPN105zlp4Niurin-_5BnukwvoJWLEJ-ZlF6hE4wKhaMB1pWTJjMvJQJE8khTTvlUN8tGxmzoaDYoe1aCGNxmDEQnx8Y5gKzVd89sylhqi54d2nQrJ2-ElfEDsMoXpR01Ps6fNDFtLTuPTp7ixj8LvgL2nCjAg996Ga3PtdvXJAZPDYCqqvaBkZZcsiqOgqLV0vGo3VVlfrcgJXQImMYRr_Inu0FCe47A93IAWuQTs-KplM1KdGJsHSnNBV6oe6QEkROJT5qZME-8xhvBYvOXqp9Znwg39bmiBCMxk26Ce66_vw06MNgoa3D5AlXPWemfdVKPZDnj_aLVjZSs0gAfFElcVn7l9yjWJOaT2Muk26U8bJl-2BEq_DSclqKHODuYM5kkPKIdE4NFrsqsDYuGxcA25rlNETFyl0q-UXj1aoz_joy5Hdnr4mFELmjnoo4jYQuakufP9xeGPsj1skaodKl0mmoGcCD6v1F60' \
7474
--data-raw '{

docs/getting-started/first-harper-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,9 @@ type Dog @table @export {
156156
Now we can start querying. Again, we just simply access the endpoint with query parameters (basic GET requests), like:
157157

158158
```
159-
http:/localhost:9926/Dog/?name=Harper
160-
http:/localhost:9926/Dog/?breed=Labrador
161-
http:/localhost:9926/Dog/?breed=Husky&name=Balto&select(id,name,breed)
159+
http://localhost:9926/Dog/?name=Harper
160+
http://localhost:9926/Dog/?breed=Labrador
161+
http://localhost:9926/Dog/?breed=Husky&name=Balto&select(id,name,breed)
162162
```
163163
164164
Congratulations, you now have created a secure database application backend with a table, a well-defined structure, access controls, and a functional REST endpoint with query capabilities! See the [REST documentation for more information on HTTP access](../developers/rest) and see the [Schema reference](../developers/applications/defining-schemas) for more options for defining schemas.

docs/getting-started/install-harper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ These defaults allow you to quickly start an instance, though you can customize
5959
Containers created from this image store all data and Harper configuration at `/home/harperdb/hdb`. To ensure that your data persists beyond the lifecycle of a container, you should mount this directory to a directory on the container host using a Docker volume. This ensures that your database remains available and your settings are not lost when the container is stopped or removed.
6060

6161
:::info
62-
Test your Harper instance is up and running by querying `curl http:/localhost:9925/health`
62+
Test your Harper instance is up and running by querying `curl http://localhost:9925/health`
6363
:::
6464

6565
### Example Deployments
@@ -123,7 +123,7 @@ If you want to inspect the logs to ensure that Harper has started correctly, use
123123
docker logs <container_id>
124124
```
125125

126-
Once verified, you can access your Harper instance by opening your web browser and navigating to http:/localhost:9925 (or the appropriate port based on your configuration).
126+
Once verified, you can access your Harper instance by opening your web browser and navigating to [http://localhost:9925](http://localhost:9925) (or the appropriate port based on your configuration).
127127

128128
### Raw binary installation
129129

docs/technical-details/reference/analytics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Harper collects statistics for all operations, URL endpoints, and messaging topi
1111
There are two "levels" of analytics in the Harper analytics table: the first is the immediate level of raw direct logging of real-time statistics. These analytics entries are recorded once a second (when there is activity) by each thread, and include all recorded activity in the last second, along with system resource information. The records have a primary key that is the timestamp in milliseconds since epoch. This can be queried (with `superuser` permission) using the search_by_conditions operation (this will search for 10 seconds worth of analytics) on the `hdb_raw_analytics` table:
1212

1313
```
14-
POST http:/localhost:9925
14+
POST http://localhost:9925
1515
Content-Type: application/json
1616
1717
{
@@ -69,7 +69,7 @@ And a typical response looks like:
6969
The second level of analytics recording is aggregate data. The aggregate records are recorded once a minute, and aggregate the results from all the per-second entries from all the threads, creating a summary of statistics once a minute. The ids for these milliseconds since epoch can be queried from the `hdb_analytics` table. You can query these with an operation like:
7070

7171
```
72-
POST http:/localhost:9925
72+
POST http://localhost:9925
7373
Content-Type: application/json
7474
7575
{

docs/technical-details/reference/components/applications.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Furthermore, the `package` field can be set to any valid [npm dependency value](
109109

110110
- For applications deployed to npm, specify the package name: `package="@harperdb/status-check"`
111111
- For applications on GitHub, specify the URL: `package="https://github.com/HarperDB/status-check"`, or the shorthand `package=HarperDB/status-check`
112-
- Private repositories also work if the correct SSH keys are on the server: `package="git+ssh:/[email protected]:HarperDB/secret-applications.git"`
112+
- Private repositories also work if the correct SSH keys are on the server: `package="git+ssh://[email protected]:HarperDB/secret-applications.git"`
113113
- Reference the [SSH Key](../../../developers/operations-api/components#add-ssh-key) operations for more information on managing SSH keys on a remote instance
114114
- Even tarball URLs are supported: `package="https://example.com/application.tar.gz"`
115115

@@ -164,8 +164,8 @@ Harper will generate a `package.json` like:
164164
"dependencies": {
165165
"myGithubComponent": "github:HarperDB-Add-Ons/package#v2.2.0",
166166
"myNPMComponent": "npm:harperdb",
167-
"myTarBall": "file:/Users/harper/cool-component.tar",
168-
"myLocal": "file:/Users/harper/local",
167+
"myTarBall": "file://Users/harper/cool-component.tar",
168+
"myLocal": "file://Users/harper/local",
169169
"myWebsite": "https://harperdb-component"
170170
}
171171
}
@@ -177,7 +177,7 @@ The package prefix is automatically added, however you can manually set it in yo
177177

178178
```yaml
179179
myCoolComponent:
180-
package: file:/Users/harper/cool-component.tar
180+
package: file://Users/harper/cool-component.tar
181181
```
182182

183183
By specifying a file path, npm will generate a symlink and then changes will be automatically picked up between restarts.

versioned_docs/version-4.1/custom-functions/define-routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Route URLs are resolved in the following manner:
1010

1111
- [**Instance URL**]:[**Custom Functions Port**]/[**Project Name**]/[**Route URL**]
1212

13-
- The route below, within the **dogs** project, with a route of **breeds** would be available at **http:/localhost:9926/dogs/breeds**.
13+
- The route below, within the **dogs** project, with a route of **breeds** would be available at **[http://localhost:9926/dogs/breeds](http://localhost:9926/dogs/breeds)**.
1414

1515
In effect, this route is just a pass-through to HarperDB. The same result could have been achieved by hitting the core HarperDB API, since it uses **hdbCore.preValidation** and **hdbCore.request**, which are defined in the "helper methods" section, below.
1616

versioned_docs/version-4.1/security/jwt-auth.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Users must initially create tokens using their HarperDB credentials. The followi
2929
A full cURL example can be seen here:
3030

3131
```bash
32-
curl --location --request POST 'http:/localhost:9925' \
32+
curl --location --request POST 'http://localhost:9925' \
3333
--header 'Content-Type: application/json' \
3434
--data-raw '{
3535
"operation": "create_authentication_tokens",
@@ -52,7 +52,7 @@ An example expected return object is:
5252
The `operation_token` value is used to authenticate all operations in place of our standard Basic auth. In order to pass the token you will need to create an Bearer Token Authorization Header like the following request:
5353

5454
```bash
55-
curl --location --request POST 'http:/localhost:9925' \
55+
curl --location --request POST 'http://localhost:9925' \
5656
--header 'Content-Type: application/json' \
5757
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXJuYW1lIiwiaWF0IjoxNjA0OTc4MjAwLCJleHAiOjE2MDUwNjQ2MDAsInN1YiI6Im9wZXJhdGlvbiJ9.MpQA-9CMjA-mn-7mHyUXSuSC_-kqMqJXp_NDiKLFtbtMRbodCuY3DzH401rvy_4vb0yCELf0B5EapLVY1545sv80nxSl6FoZFxQaDWYXycoia6zHpiveR8hKlmA6_XTWHJbY2FM1HAFrdtt3yUTiF-ylkdNbPG7u7fRjTmHfsZ78gd2MNWIDkHoqWuFxIyqk8XydQpsjULf2Uacirt9FmHfkMZ-Jr_rRpcIEW0FZyLInbm6uxLfseFt87wA0TbZ0ofImjAuaW_3mYs-3H48CxP152UJ0jByPb0kHsk1QKP7YHWx1-Wce9NgNADfG5rfgMHANL85zvkv8sJmIGZIoSpMuU3CIqD2rgYnMY-L5dQN1fgfROrPMuAtlYCRK7r-IpjvMDQtRmCiNG45nGsM4DTzsa5GyDrkGssd5OBhl9gr9z9Bb5HQVYhSKIOiy72dK5dQNBklD4eGLMmo-u322zBITmE0lKaBcwYGJw2mmkYcrjDOmsDseU6Bf_zVUd9WF3FqwNkhg4D7nrfNSC_flalkxPHckU5EC_79cqoUIX2ogufBW5XgYbU4WfLloKcIpb51YTZlZfwBHlHPSyaq_guaXFaeCUXKq39_i1n0HRF_mRaxNru0cNDFT9Fm3eD7V8axFijSVAMDyQs_JR7SY483YDKUfN4l-vw-EVynImr4' \
5858
--data-raw '{
@@ -69,7 +69,7 @@ curl --location --request POST 'http:/localhost:9925' \
6969
`operation_token` expires at a set interval. Once it expires it will no longer be accepted by HarperDB. This duration defaults to one day, and is configurable in [harperdb-config.yaml](../configuration). To generate a new `operation_token`, the `refresh_operation_token` operation is used, passing the `refresh_token` in the Bearer Token Authorization Header. A full cURL example can be seen here:
7070

7171
```bash
72-
curl --location --request POST 'http:/localhost:9925' \
72+
curl --location --request POST 'http://localhost:9925' \
7373
--header 'Content-Type: application/json' \
7474
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXJuYW1lIiwiaWF0IjoxNjA0OTc4MjAwLCJleHAiOjE2MDc1NzAyMDAsInN1YiI6InJlZnJlc2gifQ.acaCsk-CJWIMLGDZdGnsthyZsJfQ8ihXLyE8mTji8PgGkpbwhs7e1O0uitMgP_pGjHq2tey1BHSwoeCL49b18WyMIB10hK-q2BXGKQkykltjTrQbg7VsdFi0h57mGfO0IqAwYd55_hzHZNnyJMh4b0iPQFDwU7iTD7x9doHhZAvzElpkWbc_NKVw5_Mw3znjntSzbuPN105zlp4Niurin-_5BnukwvoJWLEJ-ZlF6hE4wKhaMB1pWTJjMvJQJE8khTTvlUN8tGxmzoaDYoe1aCGNxmDEQnx8Y5gKzVd89sylhqi54d2nQrJ2-ElfEDsMoXpR01Ps6fNDFtLTuPTp7ixj8LvgL2nCjAg996Ga3PtdvXJAZPDYCqqvaBkZZcsiqOgqLV0vGo3VVlfrcgJXQImMYRr_Inu0FCe47A93IAWuQTs-KplM1KdGJsHSnNBV6oe6QEkROJT5qZME-8xhvBYvOXqp9Znwg39bmiBCMxk26Ce66_vw06MNgoa3D5AlXPWemfdVKPZDnj_aLVjZSs0gAfFElcVn7l9yjWJOaT2Muk26U8bJl-2BEq_DSclqKHODuYM5kkPKIdE4NFrsqsDYuGxcA25rlNETFyl0q-UXj1aoz_joy5Hdnr4mFELmjnoo4jYQuakufP9xeGPsj1skaodKl0mmoGcCD6v1F60' \
7575
--data-raw '{

versioned_docs/version-4.2/developers/applications/define-routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ By default, route URLs are configured to be:
2020
2121
However, you can specify the path to be `/` if you wish to have your routes handling the root path of incoming URLs.
2222

23-
- The route below, using the default config, within the **dogs** project, with a route of **breeds** would be available at **http:/localhost:9926/dogs/breeds**.
23+
- The route below, using the default config, within the **dogs** project, with a route of **breeds** would be available at **[http://localhost:9926/dogs/breeds](http://localhost:9926/dogs/breeds)**.
2424

2525
In effect, this route is just a pass-through to HarperDB. The same result could have been achieved by hitting the core HarperDB API, since it uses **hdbCore.preValidation** and **hdbCore.request**, which are defined in the "helper methods" section, below.
2626

0 commit comments

Comments
 (0)