Skip to content

Commit 7ff02db

Browse files
authored
doc: Document v0.7.0 (#8)
1 parent 73a26d9 commit 7ff02db

14 files changed

+48
-3
lines changed

docs/api-details/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ℹ️ API details
2+
3+
In this section, you will find basic information about your APIs such as the GraphQL endpoints (for queries and real-time), the ARN, tags, etc.
4+
5+
![AWS AppSync API details](./img/appsync-api-details.png)

docs/api-details/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"position": 40,
3+
"collapsible": false,
4+
"collapsed": false
5+
}
287 KB
Loading

docs/graphql-client/authentication.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
---
44

55
# Authentication

docs/graphql-client/collections.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 3
33
---
44

55
# Operation Collections
1.17 MB
Loading

docs/graphql-client/query-builder.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Query Builder
6+
7+
The Query Builder allows you to quickly and easily generate GraphQL requests. First, select the operation type (Query, Mutation, or Subscription), then chose which arguments and fields to include by clicking on them. The resulting query will be generated and displayed in the query editor in real time.
8+
9+
![Query Builder](./img/query-builder.gif)

docs/metrics/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# 📈 Monitoring
2+
3+
This section displays CloudWatch metrics. The following metrics are supported:
4+
5+
- Number of Requests
6+
- Errors
7+
- Latency
8+
- Consumed tokens
9+
- Caching
10+
11+
![AWS AppSync API monitoring](./img/appsync-api-metrics.png)

docs/metrics/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"position": 50,
3+
"collapsible": false,
4+
"collapsed": false
5+
}
399 KB
Loading

docs/query-inspector/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Query Inspector
1+
# 🕵️‍♂️ Query Inspector
22

33
The query inspector gives you the ability to dive deep into the execution of your resolvers, quickly find issues, and optimize your API performance.
44

docs/statistics/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 📊 Statistics
2+
3+
It shows stats about the most invoked resolvers and those with the highest duration. You can chose a specific period of time to collect data from.
4+
5+
![AWS AppSync API statistics](./img/appsync-statistics.png)

docs/statistics/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"position": 60,
3+
"collapsible": false,
4+
"collapsed": false
5+
}
321 KB
Loading

0 commit comments

Comments
 (0)