- 
                Notifications
    You must be signed in to change notification settings 
- Fork 766
Add support for validation rules #1475
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            7 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      f889000
              
                Add support for validation rules
              
              
                kiendang 918b590
              
                Enable customizing validate max_errors through settings
              
              
                kiendang 3ca1244
              
                Add tests for validation rules
              
              
                kiendang 9a56a2b
              
                Add examples for validation rules
              
              
                kiendang 8eeffc7
              
                Allow setting validation_rules in class def
              
              
                kiendang 9561ec3
              
                Add tests for validation_rules inherited from parent class
              
              
                kiendang d006547
              
                Make tests for validation rules stricter
              
              
                kiendang File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| Query Validation | ||
| ================ | ||
|  | ||
| Graphene-Django supports query validation by allowing passing a list of validation rules (subclasses of `ValidationRule <https://github.com/graphql-python/graphql-core/blob/v3.2.3/src/graphql/validation/rules/__init__.py>`_ from graphql-core) to the ``validation_rules`` option in ``GraphQLView``. | ||
|  | ||
| .. code:: python | ||
|  | ||
| from django.urls import path | ||
| from graphene.validation import DisableIntrospection | ||
| from graphene_django.views import GraphQLView | ||
|  | ||
| urlpatterns = [ | ||
| path("graphql", GraphQLView.as_view(validation_rules=(DisableIntrospection,))), | ||
| ] | ||
|  | ||
| or | ||
|  | ||
| .. code:: python | ||
|  | ||
| from django.urls import path | ||
| from graphene.validation import DisableIntrospection | ||
| from graphene_django.views import GraphQLView | ||
|  | ||
| class View(GraphQLView): | ||
| validation_rules = (DisableIntrospection,) | ||
|  | ||
| urlpatterns = [ | ||
| path("graphql", View.as_view()), | ||
| ] | 
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| from django.urls import path | ||
|  | ||
| from graphene.validation import DisableIntrospection | ||
|  | ||
| from ..views import GraphQLView | ||
| from .schema_view import schema | ||
|  | ||
|  | ||
| class View(GraphQLView): | ||
| schema = schema | ||
|  | ||
|  | ||
| class NoIntrospectionView(View): | ||
| validation_rules = (DisableIntrospection,) | ||
|  | ||
|  | ||
| class NoIntrospectionViewInherited(NoIntrospectionView): | ||
| pass | ||
|  | ||
|  | ||
| urlpatterns = [ | ||
| path("graphql/", View.as_view()), | ||
| path("graphql/validation/", View.as_view(validation_rules=(DisableIntrospection,))), | ||
| path("graphql/validation/alternative/", NoIntrospectionView.as_view()), | ||
| path("graphql/validation/inherited/", NoIntrospectionViewInherited.as_view()), | ||
| ] | 
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about we also check that the json representation of the
responsedoes not contain the__schemain its data (or data is null/empty, however it appears in practice)? That way we ensure it's not merely returning a 400 and the error message, but is also omitting the introspection data from the response as intended. (Same goes for the other 400 error tests below)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point!