Skip to content

Commit aab8a5e

Browse files
type(docs): Update GraphQL document (support 3.11.0) (#4791)
* Update graphql docs v3.9.x Signed-off-by: Suyeon Jung <[email protected]> * Update graphql docs v3.10.x Signed-off-by: Suyeon Jung <[email protected]> * Update graphql docs v3.11.x Signed-off-by: Suyeon Jung <[email protected]> * Update latest GraphQL documentation url Signed-off-by: Suyeon Jung <[email protected]> * Change graphql docs v3.9.x path to v3.9.0 Signed-off-by: Suyeon Jung <[email protected]> * Change graphql docs v3.10.x path to v3.10.0 Signed-off-by: Suyeon Jung <[email protected]> * Change graphql docs v3.11.x path to v3.11.0 Signed-off-by: Suyeon Jung <[email protected]> --------- Signed-off-by: Suyeon Jung <[email protected]>
1 parent 25ff937 commit aab8a5e

File tree

41 files changed

+90697
-1
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

+90697
-1
lines changed

mkdocs/docs/experiments/api/contents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
<tr>
1515
<td>GraphQL Server</td>
1616
<td>Contains GraphQL Server API documentation</td>
17-
<td><a target="_" href="/litmus/graphql/v2.0.0/api.html">GraphQL Server</a></td>
17+
<td><a target="_" href="/litmus/graphql/v3.11.0/api.html">GraphQL Server</a></td>
1818
</tr>
1919
</table>

mkdocs/docs/graphql/v3.10.0/api.html

Lines changed: 17897 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
spectaql:
2+
targetDir: ./mkdocs/docs/graphql/v3.10.0
3+
logoFile: ./mkdocs/docs/graphql/logo.png
4+
faviconFile: ./mkdocs/docs/graphql/logo.png
5+
displayAllServers: true
6+
themeDir: ./mkdocs/docs/graphql/v3.10.0/custom-theme
7+
8+
introspection:
9+
removeTrailingPeriodFromDescriptions: false
10+
schemaFile: ./chaoscenter/graphql/definitions/shared/*.graphqls
11+
queryNameStrategy: capitalizeFirst
12+
fieldExpansionDepth: 2
13+
14+
spectaqlDirective:
15+
enable: true
16+
17+
extensions:
18+
graphqlScalarExamples: true
19+
20+
info:
21+
title: ChaosCenter API Documentation
22+
description: Litmus Portal provides console and UI experience for managing, monitoring, and events around chaos workflows. Chaos workflows consist of a sequence of experiments run together to achieve the objective of introducing some kind of fault into an application or the Kubernetes platform.
23+
24+
x-introItems:
25+
- title: Common Error Response
26+
file: ./mkdocs/docs/graphql/v3.10.0/error_response_guide.md
27+
28+
servers:
29+
- url: http://localhost:8080
30+
description: Dev
31+
- url: http://localhost:8080/query
32+
description: Prod
33+
production: true
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
$line-height-heading: 1.2;
3+
$font-size-large-heading: 1.7105263158rem;
4+
$font-weight-large-heading: 700;
5+
$content-padding: 20px;
6+
$text-color: #535b60;
7+
$text-weight: 400;
8+
$text-size: 1.5789473684rem;
9+
10+
#spectaql {
11+
h2 {
12+
color: $text-color;
13+
font-weight: $text-weight;
14+
font-size: $text-size;
15+
}
16+
17+
.doc-heading {
18+
line-height: $line-height-heading;
19+
font-size: $font-size-large-heading;
20+
font-weight: $font-weight-large-heading;
21+
color: #535b60
22+
}
23+
24+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
All error responses follow the structure outlined below.
2+
3+
```json
4+
{
5+
"errors": [
6+
{
7+
"message": "Error message",
8+
"path": [
9+
"Request path"
10+
]
11+
}
12+
],
13+
"data": {}
14+
}
15+
```
16+
17+
### Field Descriptions:
18+
- **errors**: <br>
19+
An array of error objects. Multiple errors can occur, and each error contains a message and a path field. <br>
20+
**Type: `Array`** <br><br>
21+
- **message**: <br>
22+
A description of the error. <br>
23+
**Type: `String`** <br><br>
24+
- **path**: <br>
25+
Indicates the GraphQL or API operation path where the error occurred. It helps in identifying which operation or resolver triggered the error. <br>
26+
**Type: `Array of Strings`** <br><br>
27+
- **data**: <br>
28+
This field contains the data returned from the request. In the event of an error, the field corresponding to the failed operation will be null, while other successful operations (if any) will still return valid data. <br>
29+
**Type: `Object`** <br>
450 Bytes
Loading
450 Bytes
Loading

mkdocs/docs/graphql/v3.10.0/javascripts/spectaql.min.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mkdocs/docs/graphql/v3.10.0/stylesheets/spectaql.min.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)