You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2020/01/07 01:17:57 UTC
[GitHub] [incubator-superset] dpgaspar commented on a change in pull request
#8917: [WiP] [charts] New, REST API
dpgaspar commented on a change in pull request #8917: [WiP] [charts] New, REST API
URL: https://github.com/apache/incubator-superset/pull/8917#discussion_r363555367
##########
File path: superset/views/base.py
##########
@@ -520,6 +566,155 @@ def related(self, column_name: str, **kwargs):
return self.response(200, count=count, result=result)
+class BaseOwnedModelRestApi(BaseSupersetModelRestApi):
+ @expose("/<pk>", methods=["PUT"])
+ @protect()
+ @check_ownership_and_item_exists
+ @safe
+ def put(self, item): # pylint: disable=arguments-differ
+ """Changes a owned Model
+ ---
+ put:
+ parameters:
+ - in: path
+ schema:
+ type: integer
+ name: pk
+ requestBody:
+ description: Model schema
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/{{self.__class__.__name__}}.put'
+ responses:
+ 200:
+ description: Item changed
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ result:
+ $ref: '#/components/schemas/{{self.__class__.__name__}}.put'
+ 400:
+ $ref: '#/components/responses/400'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/401'
+ 404:
+ $ref: '#/components/responses/404'
+ 422:
+ $ref: '#/components/responses/422'
+ 500:
+ $ref: '#/components/responses/500'
+ """
+ if not request.is_json:
+ self.response_400(message="Request is not JSON")
+ item = self.edit_model_schema.load(request.json, instance=item)
+ if item.errors:
+ return self.response_422(message=item.errors)
+ try:
+ self.datamodel.edit(item.data, raise_exception=True)
+ return self.response(
+ 200, result=self.edit_model_schema.dump(item.data, many=False).data
+ )
+ except SQLAlchemyError as e:
+ return self.response_422(message=str(e))
+
+ @expose("/", methods=["POST"])
+ @protect()
+ @safe
+ def post(self):
+ """Creates a new owned Model
+ ---
+ post:
+ requestBody:
+ description: Model schema
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/{{self.__class__.__name__}}.post'
+ responses:
+ 201:
+ description: Model added
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ result:
+ $ref: '#/components/schemas/{{self.__class__.__name__}}.post'
+ 400:
+ $ref: '#/components/responses/400'
+ 401:
+ $ref: '#/components/responses/401'
+ 422:
+ $ref: '#/components/responses/422'
+ 500:
+ $ref: '#/components/responses/500'
+ """
+ if not request.is_json:
+ return self.response_400(message="Request is not JSON")
+ item = self.add_model_schema.load(request.json)
+ # This validates custom Schema with custom validations
+ if item.errors:
+ return self.response_422(message=item.errors)
+ try:
+ self.datamodel.add(item.data, raise_exception=True)
+ return self.response(
+ 201,
+ result=self.add_model_schema.dump(item.data, many=False).data,
+ id=item.data.id,
+ )
+ except SQLAlchemyError as e:
+ return self.response_422(message=str(e))
+
+ @expose("/<pk>", methods=["DELETE"])
+ @protect()
+ @check_ownership_and_item_exists
+ @safe
+ def delete(self, item): # pylint: disable=arguments-differ
Review comment:
It is, delete will not process request data, just the id on the URI `/api/v1/<resource>/<id>`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org