Search code examples
google-cloud-endpointsgcloudopenapigoogle-cloud-endpoints-v2

Error deploying endpoint containing parameter of type "file"


I'm trying to deploy a simple endpoint which contains a parameter of type file .

I'm using the gcloud service-management deploy command with the following openapi compliant yaml:

swagger: "2.0"

info:
  description: "Image API"
  title: "Image API"
  version: "v1"

host: "image-api.endpoints.myproject.cloud.goog"
basePath: "/v1"

schemes:
- "https"

paths:
  "/images":
    post:
      description: "Adds an image"
      operationId: "add"
      consumes:
      - "multipart/form-data"      
      produces:
      - "application/json"
      responses:
        201:
          description: "An image create response"
          schema:
            $ref: "#/definitions/ImageResponse"
      parameters:
      - name: filepath
        in: formData
        required: true
        type: string
      - name: image
        in: formData
        required: false
        type: file

definitions:
  ImageResponse:
    type: object
    properties:
      id:
        type: string
      url:
        type: string
      thumbnail_url:
        type: string

But getting the following error:

 ERROR: unknown location: http: repeated message field 'google.protobuf.Struct.fields' referred to by message 'AddRequest' cann
ot be mapped as an HTTP parameter.
 ERROR: unknown location: http: cyclic message field 'google.protobuf.Struct.FieldsEntry.value' referred to by message 'AddRequ
est' cannot be mapped as an HTTP parameter.
 ERROR: unknown location: http: cyclic message field 'google.protobuf.ListValue.values' referred to by message 'AddRequest' can
not be mapped as an HTTP parameter.'

If I take the file parameter out the endpoint is successfully deployed. Is that a Google Cloud Endpoint limitation or is there another way to define it ?


Solution

  • Google Cloud Endpoints does not currently support uploading of images.

    You could upload to Google Cloud Storage first: https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload https://cloud.google.com/storage/docs/object-basics

    And then pass the URL to your Google Cloud Endpoints, which could then retrieve the image from Google Cloud Storage and perform processing.