Skip to content

Commit 7c7207a

Browse files
committed
Update 4.2-4.6 rest doc formatting
1 parent 53c7bc6 commit 7c7207a

File tree

5 files changed

+20
-30
lines changed

5 files changed

+20
-30
lines changed

versioned_docs/version-4.2/developers/rest.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,21 +79,20 @@ Generally the POST method can be used for custom actions since POST has the broa
7979

8080
This is handled by the Resource method `post(data)`, which is a good method to extend to make various other types of modifications. Also, with a table you can create a new record without specifying a primary key, for example:
8181

82-
`````http
83-
````http
82+
```http
8483
POST /MyTable/
8584
Content-Type: application/json
8685
87-
`{ "name": "some data" }`
88-
`````
86+
{ "name": "some data" }
87+
```
8988

9089
This will create a new record, auto-assigning a primary key, which will be returned in the `Location` header.
9190

9291
## Querying through URL query parameters
9392

9493
URL query parameters provide a powerful language for specifying database queries in HarperDB. This can be used to search by a single property name and value, to find all records which provide value for the given property/attribute. It is important to note that this property must be configured to be indexed to search on it. For example:
9594

96-
````http
95+
```http
9796
GET /my-resource/?property=value
9897
```
9998

@@ -199,4 +198,3 @@ Content-Type: image/gif
199198
200199
...image data...
201200
```
202-
````

versioned_docs/version-4.3/developers/rest.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,21 +79,20 @@ Generally the POST method can be used for custom actions since POST has the broa
7979

8080
This is handled by the Resource method `post(data)`, which is a good method to extend to make various other types of modifications. Also, with a table you can create a new record without specifying a primary key, for example:
8181

82-
`````http
83-
````http
82+
```http
8483
POST /MyTable/
8584
Content-Type: application/json
8685
87-
`{ "name": "some data" }`
88-
`````
86+
{ "name": "some data" }
87+
```
8988

9089
This will create a new record, auto-assigning a primary key, which will be returned in the `Location` header.
9190

9291
## Querying through URL query parameters
9392

9493
URL query parameters provide a powerful language for specifying database queries in HarperDB. This can be used to search by a single attribute name and value, to find all records which provide value for the given property/attribute. It is important to note that this attribute must be configured to be indexed to search on it. For example:
9594

96-
````http
95+
```http
9796
GET /my-resource/?property=value
9897
```
9998

@@ -355,4 +354,3 @@ Content-Type: image/gif
355354
356355
...image data...
357356
```
358-
````

versioned_docs/version-4.4/developers/rest.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,20 @@ Generally the POST method can be used for custom actions since POST has the broa
8181

8282
This is handled by the Resource method `post(data)`, which is a good method to extend to make various other types of modifications. Also, with a table you can create a new record without specifying a primary key, for example:
8383

84-
`````http
85-
````http
84+
```http
8685
POST /MyTable/
8786
Content-Type: application/json
8887
89-
`{ "name": "some data" }`
90-
`````
88+
{ "name": "some data" }
89+
```
9190

9291
This will create a new record, auto-assigning a primary key, which will be returned in the `Location` header.
9392

9493
### Querying through URL query parameters
9594

9695
URL query parameters provide a powerful language for specifying database queries in Harper. This can be used to search by a single attribute name and value, to find all records which provide value for the given property/attribute. It is important to note that this attribute must be configured to be indexed to search on it. For example:
9796

98-
````http
97+
```http
9998
GET /my-resource/?property=value
10099
```
101100

@@ -402,4 +401,3 @@ Content-Type: image/gif
402401
403402
...image data...
404403
```
405-
````

versioned_docs/version-4.5/developers/rest.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,20 @@ Generally the POST method can be used for custom actions since POST has the broa
8181

8282
This is handled by the Resource method `post(data)`, which is a good method to extend to make various other types of modifications. Also, with a table you can create a new record without specifying a primary key, for example:
8383

84-
`````http
85-
````http
84+
```http
8685
POST /MyTable/
8786
Content-Type: application/json
8887
89-
`{ "name": "some data" }`
90-
`````
88+
{ "name": "some data" }
89+
```
9190

9291
This will create a new record, auto-assigning a primary key, which will be returned in the `Location` header.
9392

9493
### Querying through URL query parameters
9594

9695
URL query parameters provide a powerful language for specifying database queries in Harper. This can be used to search by a single attribute name and value, to find all records which provide value for the given property/attribute. It is important to note that this attribute must be configured to be indexed to search on it. For example:
9796

98-
````http
97+
```http
9998
GET /my-resource/?property=value
10099
```
101100

@@ -402,4 +401,3 @@ Content-Type: image/gif
402401
403402
...image data...
404403
```
405-
````

versioned_docs/version-4.6/developers/rest.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,20 @@ Generally the POST method can be used for custom actions since POST has the broa
8181

8282
This is handled by the Resource method `post(data)`, which is a good method to extend to make various other types of modifications. Also, with a table you can create a new record without specifying a primary key, for example:
8383

84-
`````http
85-
````http
84+
```http
8685
POST /MyTable/
8786
Content-Type: application/json
8887
89-
`{ "name": "some data" }`
90-
`````
88+
{ "name": "some data" }
89+
```
9190

9291
This will create a new record, auto-assigning a primary key, which will be returned in the `Location` header.
9392

9493
### Querying through URL query parameters
9594

9695
URL query parameters provide a powerful language for specifying database queries in Harper. This can be used to search by a single attribute name and value, to find all records which provide value for the given property/attribute. It is important to note that this attribute must be configured to be indexed to search on it. For example:
9796

98-
````http
97+
```http
9998
GET /my-resource/?property=value
10099
```
101100

@@ -402,4 +401,3 @@ Content-Type: image/gif
402401
403402
...image data...
404403
```
405-
````

0 commit comments

Comments
 (0)