Update extensions names

strawberry-graphql · Mar 13, 2024 · 22838db · 22838db
1 parent 101ab96
commit 22838db
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 23 deletions.
diff --git a/docs/extensions/_template.md b/docs/extensions/_template.md
@@ -1,5 +1,5 @@
 ---
-title: ExtensionName
+title: Extension Name
 summary: A summary of the extension.
 tags: comma,separated,list,of,tags
 ---
@@ -25,7 +25,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class ExtensionName(an_argument=None): ...
+class ExtensionName(an_argument=None):
+    ...
 ```
 
 #### `an_argument: Optional[str] = None`

diff --git a/docs/extensions/add-validation-rules.md b/docs/extensions/add-validation-rules.md
@@ -1,5 +1,5 @@
 ---
-title: AddValidationRules
+title: Add Validation Rules
 summary: Add GraphQL validation rules.
 tags: validation,security
 ---
@@ -20,7 +20,8 @@ from strawberry.extensions import AddValidationRules
 from graphql import ValidationRule
 
 
-class MyCustomRule(ValidationRule): ...
+class MyCustomRule(ValidationRule):
+    ...
 
 
 schema = strawberry.Schema(
@@ -34,7 +35,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class AddValidationRules(validation_rules): ...
+class AddValidationRules(validation_rules):
+    ...
 ```
 
 #### `validation_rules: List[Type[ASTValidationRule]]`

diff --git a/docs/extensions/apollo-tracing.md b/docs/extensions/apollo-tracing.md
@@ -1,5 +1,5 @@
 ---
-title: ApolloTracingExtension
+title: Apollo Tracing
 summary: Add Apollo tracing to your GraphQL server.
 tags: tracing
 ---

diff --git a/docs/extensions/datadog.md b/docs/extensions/datadog.md
@@ -1,5 +1,5 @@
 ---
-title: DatadogExtension
+title: Datadog
 summary: Add Datadog tracing to your GraphQL server.
 tags: tracing
 ---

diff --git a/docs/extensions/disable-validation.md b/docs/extensions/disable-validation.md
@@ -1,5 +1,5 @@
 ---
-title: DisableValidation
+title: Disable Validation
 summary: Disable all query validation.
 tags: performance,validation
 ---

diff --git a/docs/extensions/mask-errors.md b/docs/extensions/mask-errors.md
@@ -1,5 +1,5 @@
 ---
-title: MaskErrors
+title: Mask Errors
 summary: Hide error messages from the client.
 tags: security
 ---
@@ -28,7 +28,8 @@ schema = strawberry.Schema(
 ```python
 class MaskErrors(
     should_mask_error=default_should_mask_error, error_message="Unexpected error."
-): ...
+):
+    ...
 ```
 
 #### `should_mask_error: Callable[[GraphQLError], bool] = default_should_mask_error`

diff --git a/docs/extensions/max-aliases-limiter.md b/docs/extensions/max-aliases-limiter.md
@@ -1,5 +1,5 @@
 ---
-title: MaxAliasesLimiter
+title: Max Aliases Limiter
 summary:
   Add a validator to limit the maximum number of aliases in a GraphQL document.
 tags: security
@@ -27,7 +27,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class MaxAliasesLimiter(max_alias_count): ...
+class MaxAliasesLimiter(max_alias_count):
+    ...
 ```
 
 #### `max_alias_count: int`

diff --git a/docs/extensions/max-tokens-limiter.md b/docs/extensions/max-tokens-limiter.md
@@ -1,5 +1,5 @@
 ---
-title: MaxTokensLimiter
+title: Max Tokens Limiter
 summary:
   Add a validator to limit the maximum number of tokens in a GraphQL document.
 tags: security
@@ -30,7 +30,8 @@ tokens, the server will respond with an error message.
 ## API reference:
 
 ```python
-class MaxTokensLimiter(max_token_count): ...
+class MaxTokensLimiter(max_token_count):
+    ...
 ```
 
 #### `max_token_count: int`

diff --git a/docs/extensions/opentelemetry.md b/docs/extensions/opentelemetry.md
@@ -1,5 +1,5 @@
 ---
-title: OpenTelemetryExtension
+title: Open Telemetry
 summary: Add Open Telemetry tracing to your GraphQL server.
 tags: tracing
 ---
@@ -55,7 +55,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class OpenTelemetryExtension(arg_filter=None): ...
+class OpenTelemetryExtension(arg_filter=None):
+    ...
 ```
 
 #### `arg_filter: Optional[ArgFilter]`

diff --git a/docs/extensions/parser-cache.md b/docs/extensions/parser-cache.md
@@ -1,5 +1,5 @@
 ---
-title: ParserCache
+title: Parser Cache
 summary: Add in memory caching to the parsing step of query execution.
 tags: performance,caching,parsing
 ---
@@ -26,7 +26,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class ParserCache(maxsize=None): ...
+class ParserCache(maxsize=None):
+    ...
 ```
 
 #### `maxsize: Optional[int] = None`

diff --git a/docs/extensions/query-depth-limiter.md b/docs/extensions/query-depth-limiter.md
@@ -1,5 +1,5 @@
 ---
-title: QueryDepthLimiter
+title: Query Depth Limiter
 summary: Add a validator to limit the query depth of GraphQL operations.
 tags: security
 ---
@@ -25,7 +25,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class QueryDepthLimiter(max_depth, callback=None, should_ignore=None): ...
+class QueryDepthLimiter(max_depth, callback=None, should_ignore=None):
+    ...
 ```
 
 #### `max_depth: int`

diff --git a/docs/extensions/sentry-tracing.md b/docs/extensions/sentry-tracing.md
@@ -1,5 +1,5 @@
 ---
-title: SentryTracingExtension
+title: Sentry Tracing
 summary: Add Sentry tracing to your GraphQL server.
 tags: tracing
 ---

diff --git a/docs/extensions/validation-cache.md b/docs/extensions/validation-cache.md
@@ -1,5 +1,5 @@
 ---
-title: ValidationCache
+title: Validation Cache
 summary: Add in memory caching to the validation step of query execution.
 tags: performance,caching,validation
 ---
@@ -26,7 +26,8 @@ schema = strawberry.Schema(
 ## API reference:
 
 ```python
-class ValidationCache(maxsize=None): ...
+class ValidationCache(maxsize=None):
+    ...
 ```
 
 #### `maxsize: Optional[int] = None`