From 22838db26389c28450820e0f0e9771e015403e8c Mon Sep 17 00:00:00 2001 From: Patrick Arminio Date: Wed, 13 Mar 2024 13:49:33 +0100 Subject: [PATCH] Update extensions names --- docs/extensions/_template.md | 5 +++-- docs/extensions/add-validation-rules.md | 8 +++++--- docs/extensions/apollo-tracing.md | 2 +- docs/extensions/datadog.md | 2 +- docs/extensions/disable-validation.md | 2 +- docs/extensions/mask-errors.md | 5 +++-- docs/extensions/max-aliases-limiter.md | 5 +++-- docs/extensions/max-tokens-limiter.md | 5 +++-- docs/extensions/opentelemetry.md | 5 +++-- docs/extensions/parser-cache.md | 5 +++-- docs/extensions/query-depth-limiter.md | 5 +++-- docs/extensions/sentry-tracing.md | 2 +- docs/extensions/validation-cache.md | 5 +++-- 13 files changed, 33 insertions(+), 23 deletions(-) diff --git a/docs/extensions/_template.md b/docs/extensions/_template.md index be032724ab..82d58739ec 100644 --- 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 index 7bc785551c..69fcfd77fc 100644 --- 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 index 89f1254d0f..f7e2356850 100644 --- 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 index 3f57e1494c..ac647a2d33 100644 --- 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 index 1708ebded9..2aa7f20179 100644 --- 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 index 21491fb3ba..6adf3723b5 100644 --- 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 index 5fc8140d14..f7678332dd 100644 --- 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 index f06d82a1e6..54c96ec163 100644 --- 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 index 89c2f63377..f355e071de 100644 --- 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 index a80167157d..cb145d90ef 100644 --- 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 index 2fd806c9ad..a40964f590 100644 --- 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 index d9eedb050a..52b70d3582 100644 --- 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 index 0f4c7b34fc..dde2292612 100644 --- 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`