Skip to content

Commit fa7a07a

Browse files
docs: accept requested changes
Co-authored-by: Joseph Livesey <[email protected]>
1 parent 3a0b29e commit fa7a07a

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/Queries.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,36 @@
11
# Query examples
22

3-
These are a (non-exhaustive) list of possible queries
3+
This is a (non-exhaustive) list of possible queries
44
and their responses for `indexer-service-rs`.
55

66
## Supported request and response format examples
77

88
```bash
99
curl http://localhost:7600/
1010
```
11+
1112
```
1213
Service is up and running
1314
```
1415

1516
```bash
1617
curl http://localhost:7600/version
1718
```
19+
1820
```json
1921
{ "version":"0.1.0", "dependencies": {..} }
2022
```
2123

2224
```bash
2325
curl http://localhost:7600/info
2426
```
27+
2528
```json
2629
{ "publicKey": "0xacb05407d78129b5717bb51712d3e23a78a10929" }
2730
```
2831

2932
# Subgraph queries
33+
3034
## Checks for receipts and authorization
3135
```bash
3236
curl -X POST \
@@ -57,13 +61,15 @@ curl -X POST \
5761
```
5862

5963
## Free query auth token check failed
64+
6065
```bash
6166
curl -X POST \
6267
-H 'Content-Type: application/json' \
6368
-H 'Authorization: blah' \
6469
--data '{"query": "{_meta{block{number}}}"}' \
6570
http://localhost:7600/subgraphs/id/0xb655ca6f49e73728a102219726ff678d61d8fb792874792e9f0d9887dc616600
6671
```
72+
6773
```json
6874
{
6975
"message":"No valid receipt or free query auth token provided"
@@ -100,6 +106,7 @@ curl http://localhost:7600/subgraphs/health/QmVGSJyvjEjkk5U9EdxyyB78NCXK3EAoFhrz
100106
```
101107

102108
# Network queries
109+
103110
## Checks for auth and configuration to serve-network-subgraph
104111

105112
```bash
@@ -109,19 +116,22 @@ curl -X POST \
109116
--data '{"query": "{_meta{block{number}}}"}' \
110117
http://localhost:7600/network
111118
```
119+
112120
```json
113121
{
114122
"message":"No valid receipt or free query auth token provided"
115123
}
116124
```
117125

118126
## Indexing status resolver - Route supported root field queries to graph node status endpoint
127+
119128
```bash
120129
curl -X POST \
121130
-H 'Content-Type: application/json' \
122131
--data '{"query": "{blockHashFromNumber(network:\"mainnet\", blockNumber: 21033)}"}' \
123132
http://localhost:7600/status
124133
```
134+
125135
```json
126136
{
127137
"data": {
@@ -131,6 +141,7 @@ curl -X POST \
131141
```
132142

133143
## Indexing status resolver
144+
134145
```bash
135146
curl -X POST \
136147
-H 'Content-Type: application/json' \

docs/Routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ This section lists the routes currently exposed by the Subgraph Service. Each ro
4141

4242
## Note
4343

44-
If this documentation is outdated or incomplete, you can view the complete and up-to-date list of routes in the source code:
44+
You can always view the latest complete and up-to-date list of routes in the source code:
4545
[Service Router Implementation](./crates/service/src/service/router.rs)

0 commit comments

Comments
 (0)