Skip to content

Commit

Permalink
type(docs): Update GraphQL document (support 3.11.0) (#4791)
Browse files Browse the repository at this point in the history
* Update graphql docs v3.9.x

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Update graphql docs v3.10.x

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Update graphql docs v3.11.x

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Update latest GraphQL documentation url

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Change graphql docs v3.9.x path to v3.9.0

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Change graphql docs v3.10.x path to v3.10.0

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

* Change graphql docs v3.11.x path to v3.11.0

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>

---------

Signed-off-by: Suyeon Jung <suyeonjungdev@gmail.com>
  • Loading branch information
suyeon-jung-dev authored Nov 21, 2024
1 parent 25ff937 commit aab8a5e
Show file tree
Hide file tree
Showing 41 changed files with 90,697 additions and 1 deletion.
2 changes: 1 addition & 1 deletion mkdocs/docs/experiments/api/contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
<tr>
<td>GraphQL Server</td>
<td>Contains GraphQL Server API documentation</td>
<td><a target="_" href="/litmus/graphql/v2.0.0/api.html">GraphQL Server</a></td>
<td><a target="_" href="/litmus/graphql/v3.11.0/api.html">GraphQL Server</a></td>
</tr>
</table>
17,897 changes: 17,897 additions & 0 deletions mkdocs/docs/graphql/v3.10.0/api.html

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions mkdocs/docs/graphql/v3.10.0/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
spectaql:
targetDir: ./mkdocs/docs/graphql/v3.10.0
logoFile: ./mkdocs/docs/graphql/logo.png
faviconFile: ./mkdocs/docs/graphql/logo.png
displayAllServers: true
themeDir: ./mkdocs/docs/graphql/v3.10.0/custom-theme

introspection:
removeTrailingPeriodFromDescriptions: false
schemaFile: ./chaoscenter/graphql/definitions/shared/*.graphqls
queryNameStrategy: capitalizeFirst
fieldExpansionDepth: 2

spectaqlDirective:
enable: true

extensions:
graphqlScalarExamples: true

info:
title: ChaosCenter API Documentation
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.

x-introItems:
- title: Common Error Response
file: ./mkdocs/docs/graphql/v3.10.0/error_response_guide.md

servers:
- url: http://localhost:8080
description: Dev
- url: http://localhost:8080/query
description: Prod
production: true
24 changes: 24 additions & 0 deletions mkdocs/docs/graphql/v3.10.0/custom-theme/stylesheets/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

$line-height-heading: 1.2;
$font-size-large-heading: 1.7105263158rem;
$font-weight-large-heading: 700;
$content-padding: 20px;
$text-color: #535b60;
$text-weight: 400;
$text-size: 1.5789473684rem;

#spectaql {
h2 {
color: $text-color;
font-weight: $text-weight;
font-size: $text-size;
}

.doc-heading {
line-height: $line-height-heading;
font-size: $font-size-large-heading;
font-weight: $font-weight-large-heading;
color: #535b60
}

}
29 changes: 29 additions & 0 deletions mkdocs/docs/graphql/v3.10.0/error_response_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
All error responses follow the structure outlined below.

```json
{
"errors": [
{
"message": "Error message",
"path": [
"Request path"
]
}
],
"data": {}
}
```

### Field Descriptions:
- **errors**: <br>
An array of error objects. Multiple errors can occur, and each error contains a message and a path field. <br>
**Type: `Array`** <br><br>
- **message**: <br>
A description of the error. <br>
**Type: `String`** <br><br>
- **path**: <br>
Indicates the GraphQL or API operation path where the error occurred. It helps in identifying which operation or resolver triggered the error. <br>
**Type: `Array of Strings`** <br><br>
- **data**: <br>
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>
**Type: `Object`** <br>
Binary file added mkdocs/docs/graphql/v3.10.0/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mkdocs/docs/graphql/v3.10.0/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs/docs/graphql/v3.10.0/javascripts/spectaql.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions mkdocs/docs/graphql/v3.10.0/stylesheets/spectaql.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit aab8a5e

Please sign in to comment.