rest of swagger

Author: Hussein Elgridly

app.yaml.ctmpl

@@ -9,6 +9,8 @@ env_variables:
     RAWLS_URL: "{env.rawls_url}"
     SAM_URL: "{env.sam_url}"
 
+    SWAGGER_OAUTH_CLIENT_ID: "{env.oauth_id}"
+
     IMPORT_SVC_SA_EMAIL: "{env.import_svc_sa_email}"
     BATCH_UPSERT_BUCKET: "import-service-batchupsert-{env}"
 

app/new_import.py

@@ -1,31 +1,10 @@
 import flask
-import jsonschema
-import logging
 
 from app import translate
-from app.util import exceptions
 from app.db import db, model
 from app.external import sam, pubsub
 from app.auth import user_auth
 
-NEW_IMPORT_SCHEMA = {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "path": {
-      "type": "string"
-    },
-    "filetype": {
-      "type": "string",
-      "enum": list(translate.FILETYPE_TRANSLATORS.keys())
-    }
-  },
-  "required": ["path", "filetype"]
-}
-
-
-schema_validator = jsonschema.Draft7Validator(NEW_IMPORT_SCHEMA)
-
 
 def handle(request: flask.Request, ws_ns: str, ws_name: str) -> model.ImportStatusResponse:
     access_token = user_auth.extract_auth_token(request)
@@ -37,12 +16,6 @@ def handle(request: flask.Request, ws_ns: str, ws_name: str) -> model.ImportStat
     # make sure the user is allowed to import to this workspace
     workspace_uuid = user_auth.workspace_uuid_with_auth(ws_ns, ws_name, access_token, "write")
 
-    try:  # now validate that the input is correctly shaped
-        schema_validator.validate(request_json)
-    except jsonschema.ValidationError as ve:
-        logging.info("Got malformed JSON.")
-        raise exceptions.BadJsonException(ve.message)
-
     import_url = request_json["path"]
 
     # and validate the input's path

app/server/routes.py

@@ -1,5 +1,5 @@
 import flask
-from flask_restx import Api, Resource
+from flask_restx import Api, Resource, fields
 import json
 import humps
 from typing import Dict, Callable, Any
@@ -10,37 +10,58 @@
 from app.server.requestutils import httpify_excs, pubsubify_excs
 
 routes = flask.Blueprint('import-service', __name__, '/')
+
+authorizations = {
+    'Bearer': {
+        "type": "apiKey",
+        "name": "Authorization",
+        "in": "header",
+        "description": "Use your GCP auth token, i.e. `gcloud auth print-access-token`. Required scopes are [openid, email, profile]. Write `Bearer <yourtoken>` in the box."
+    }
+}
+
 api = Api(routes, version='1.0', title='Import Service',
-          description='import service')
+          description='import service',
+          authorizations=authorizations,
+          security=[{"Bearer": "[]"}])
 
 ns = api.namespace('/', description='import handling')
 
 
+new_import_model = ns.model("NewImport",
+                             {"path": fields.String(required=True),
+                              "filetype": fields.String(enum=list(translate.FILETYPE_TRANSLATORS.keys()), required=True)})
 import_status_response_model = ns.model("ImportStatusResponse", model.ImportStatusResponse.get_model())
 
 
-@ns.route('/<ws_ns>/<ws_name>/imports/<import_id>')
+@ns.route('/<workspace_project>/<workspace_name>/imports/<import_id>')
+@ns.param('workspace_project', 'Workspace project')
+@ns.param('workspace_name', 'Workspace name')
+@ns.param('import_id', 'Import id')
 class SpecificImport(Resource):
     @httpify_excs
     @ns.marshal_with(import_status_response_model)
-    def get(self, ws_ns, ws_name, import_id):
+    def get(self, workspace_project, workspace_name, import_id):
         """Return status for this import."""
-        return status.handle_get_import_status(flask.request, ws_ns, ws_name, import_id)
+        return status.handle_get_import_status(flask.request, workspace_project, workspace_name, import_id)
 
 
-@ns.route('/<ws_ns>/<ws_name>/imports')
+@ns.route('/<workspace_project>/<workspace_name>/imports')
+@ns.param('workspace_project', 'Workspace project')
+@ns.param('workspace_name', 'Workspace name')
 class Imports(Resource):
     @httpify_excs
-    @ns.marshal_with(import_status_response_model, 201)
-    def post(self, ws_ns, ws_name):
+    @ns.expect(new_import_model, validate=True)
+    @ns.marshal_with(import_status_response_model, code=201)
+    def post(self, workspace_project, workspace_name):
         """Accept an import request."""
-        return new_import.handle(flask.request, ws_ns, ws_name), 201
+        return new_import.handle(flask.request, workspace_project, workspace_name), 201
 
     @httpify_excs
-    @ns.marshal_with(import_status_response_model, 200)
-    def get(self, ws_ns, ws_name):
+    @ns.marshal_with(import_status_response_model, code=200, as_list=True)
+    def get(self, workspace_project, workspace_name):
         """Return all imports in the workspace."""
-        return status.handle_list_import_status(flask.request, ws_ns, ws_name)
+        return status.handle_list_import_status(flask.request, workspace_project, workspace_name)
 
 
 # Dispatcher for pubsub messages.
@@ -55,7 +76,7 @@ def get(self, ws_ns, ws_name):
 @ns.route('/_ah/push-handlers/receive_messages', doc=False)
 class PubSub(Resource):
     @pubsubify_excs
-    @ns.marshal_with(import_status_response_model, 200)
+    @ns.marshal_with(import_status_response_model, code=200)
     def post(self) -> flask.Response:
         app.auth.service_auth.verify_pubsub_jwt(flask.request)
 

app/tests/test_new_import.py

@@ -9,10 +9,6 @@
 from app.db.model import *
 
 
-def test_schema_valid():
-    jsonschema.Draft7Validator.check_schema(new_import.NEW_IMPORT_SCHEMA)
-
-
 good_json = {"path": f"https://{translate.VALID_NETLOCS[0]}/some/path", "filetype": "pfb"}
 good_headers = {"Authorization": "Bearer ya29.blahblah", "Accept": "application/json"}