Fixes enveloped schemas to have null error.

Modifies the test_conventions... to adapt to new criteria

Author: Pedro Crespo

api/specs/webserver/v0/components/schemas/error.yaml

@@ -22,6 +22,7 @@ ErrorType:
 #     - e.g. metadata can serialize an exception in server that can be reproduced in client side
 #
   type: object
+  nullable: true
   properties:
     logs:
       description: log messages

api/specs/webserver/v0/components/schemas/fake.yaml

@@ -2,14 +2,10 @@ FakeEnveloped:
   type: object
   required:
     - data
-    - error
   properties:
     data:
       $ref: '#/FakeType'
-      nullable: true
-      default: null
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
       default: null
 

api/specs/webserver/v0/components/schemas/health_check.yaml

@@ -2,14 +2,10 @@ HealthCheckEnveloped:
   type: object
   required:
     - data
-    - error
   properties:
     data:
       $ref: '#/HealthCheckType'
-      nullable: true
-      default: null
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
       default: null
 

api/specs/webserver/v0/components/schemas/log_message.yaml

@@ -2,14 +2,10 @@ LogMessageEnveloped:
   type: object
   required:
     - data
-    - error
   properties:
     data:
       $ref: "#/LogMessageType"
-      nullable: true
-      default: null
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
       default: null
 

api/specs/webserver/v0/components/schemas/login.yaml

@@ -2,14 +2,10 @@ LoginEnveloped:
   type: object
   required:
     - data
-    - error
   properties:
     data:
       $ref: '#/LoginFormType'
-      nullable: true
-      default: null
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
       default: null
 

api/specs/webserver/v0/components/schemas/my.yaml

@@ -35,46 +35,41 @@ Token:
     service: 'github-api-v1'
     token_key: foo
 
-
 # enveloped and array versions --------------------------
 
-
-# TODO: move this as base class??
-ErrorEnvelopeModel:
+ProfileEnveloped:
   type: object
+  required:
+    - data
   properties:
+    data:
+      $ref: '#/Profile'
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
-
-
-ProfileEnveloped:
-  allOf:
-    - $ref: '#/ErrorEnvelopeModel'
-    - type: object
-      properties:
-        data:
-          $ref: '#/Profile'
-          nullable: true
+      default: null
 
 
 TokenEnveloped:
-  allOf:
-    - $ref: '#/ErrorEnvelopeModel'
-    - type: object
-      properties:
-        data:
-          $ref: '#/Token'
-          nullable: true
+  type: object
+  required:
+    - data
+  properties:
+    data:
+      $ref: '#/Token'
+    error:
+      nullable: true
+      default: null
 
 
 TokensArrayEnveloped:
-  allOf:
-    - $ref: '#/ErrorEnvelopeModel'
-    - type: object
-      properties:
-        data:
-          type: array
-          items:
-            $ref: '#/Token'
-          nullable: true
+  type: object
+  required:
+    - data
+  properties:
+    data:
+      type: array
+      items:
+        $ref: '#/Token'
+    error:
+      nullable: true
+      default: null

api/specs/webserver/v0/components/schemas/registration.yaml

@@ -2,14 +2,10 @@ RegistrationEnveloped:
   type: object
   required:
     - data
-    - error
   properties:
     data:
       $ref: '#/RegistrationType'
-      nullable: true
-      default: null
     error:
-      $ref: "./error.yaml#/ErrorType"
       nullable: true
       default: null
 

api/tests/test_conventions_openapi.py

@@ -9,7 +9,7 @@
 from utils import list_files_in_api_specs
 
 # Conventions
-_REQUIRED_FIELDS = ["error", "data"]
+_REQUIRED_FIELDS = ["data", ]
 CONVERTED_SUFFIX = "-converted.yaml"
 
 # TESTS ----------------------------------------------------------
@@ -20,7 +20,6 @@
                                     if not pathstr.endswith(CONVERTED_SUFFIX) ]  # skip converted schemas
 
 
-@pytest.mark.skip(reason="TODO: discuss with sanderegg")
 @pytest.mark.parametrize("path", non_converted_yamls)
 def test_openapi_envelope_required_fields(path: str):
     with io.open(path) as file_stream:
@@ -29,25 +28,9 @@ def test_openapi_envelope_required_fields(path: str):
             if "Envelope" in key:
                 assert "required" in value, "field required is missing from {file}".format(file=path)
                 required_fields = value["required"]
+
                 assert "properties" in value, "field properties is missing from {file}".format(file=path)
                 fields_definitions = value["properties"]
-                for field in _REQUIRED_FIELDS:
-                    assert field in required_fields, ("field {field} is missing in {file}".format(field=field, file=path))
-                    assert field in fields_definitions, ("field {field} is missing in {file}".format(field=field, file=path))
-
 
-@pytest.mark.skip(reason="TODO: discuss with sanderegg")
-@pytest.mark.parametrize("path", non_converted_yamls)
-def test_openapi_type_name(path: str):
-    with io.open(path) as file_stream:
-        oas_dict = yaml.safe_load(file_stream)
-
-        for key, value in oas_dict.items():
-            if "Envelope" in key:
-                assert "properties" in value, ("field properties is missing from {file}".format(file=path))
-                fields_definitions = value["properties"]
-                for field_key, field_value in fields_definitions.items():
-                    data_values = field_value
-                    for data_key, data_value in data_values.items():
-                        if "$ref" in data_key:
-                            assert str(data_value).endswith("Type"), ("field {field} name is not finishing with Type in {file}".format(field=field_key, file=path))
+                assert 'error' in required_fields or 'data' in required_fields
+                assert 'error' in fields_definitions or 'data' in fields_definitions