How do I get rid of the _openAPIToGraphQL object in the response?

[MarkLyck]

Hi.

I have multiple openAPI rest endpoints I am using in my graphql-mesh. However whenever I query one, they always return this annoying object that I don't think I have any use for? called _openAPIToGraphQL.

example response:

{
  "data": {
    "signalTest": {
      "latest": {
        "records": [
          {
            "scoreColor": "green",
            "siteId": 17035
          },
          {
            "scoreColor": "green",
            "siteId": 17051
          },
          {
            "scoreColor": "green",
            "siteId": 69159
          },
          {
            "scoreColor": "green",
            "siteId": 13887
          },
          {
            "scoreColor": "green",
            "siteId": 14944
          }
        ],
        "_openAPIToGraphQL": {
          "data": {
            "_0___gqtld1__": {
              "usedParams": {
                "size": 5
              },
              "url": "https://my-api.com/v4/latest",
              "usedRequestOptions": {
                "headers": {
                  "authorization": "Bearer  MY_TOKEN",
                  "accept": "application/json"
                },
                "method": "get"
              },
              "usedStatusCode": "200",
              "responseHeaders": {
                "access-control-allow-origin": "*",
                "access-control-expose-headers": "content-range",
                "alt-svc": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000",
                "content-length": "352",
                "content-type": "application/json",
                "date": "Fri, 22 Apr 2022 14:35:18 GMT",
                "server": "uvicorn",
                "via": "kong/2.8.0, 1.1 google",
                "x-kong-proxy-latency": "0",
                "x-kong-upstream-latency": "16"
              }
            }
          }
        }
      }
    }
  }
}

I really just want the records here, I don't want to waste my users data, or add the complexity of including all this metadata in each request.

I thought the obvious solution was to just add includeHttpDetails: false but that doesn't seem to do anything?

Here's my graphQL mesh file:

sources:
  - name: test
    handler:
      openapi:
        baseUrl: https://my-api.com/v4
        source: https://my-api.com/v4/openapi.json
        includeHttpDetails: false
        operationHeaders:
          Authorization: "{context.headers['authorization']}"
    transforms:
      - encapsulate:

is it a bug that the includeHttpDetails: false doesn't do anything? Or am I using it wrong perhaps? Or is there another method to not include all this meta data?

[ardatan]

Please share a reproduction with a partial openapi schema so we can debug the issue.

[MarkLyck]

@ardatan Here is a minimal reproduction .meshrc.yml file

sources:
  - name: test
    handler:
      openapi:
        source: https://petstore.swagger.io/v2/swagger.json
        includeHttpDetails: false

Or if you need a full project here is a minimal reproduction project:

https://codesandbox.io/s/graphlql-mesh-openapi-bug-1c1tm8

(I'm not quite sure how to make graphql-mesh open in codesandbox though? But you can just clone the files and run it locally and run yarn start

Once you run it, if you do any valid query, e.g. this:

query {
    storeInventory
}

You'll get a response like this:

{
  "data": {
    "storeInventory": {
      "_0": 1,
      "totvs": 1,
      "aVAILABLE": 2,
      "sold": 7,
      "teststa5": 357,
      "string": 194,
      "unavailable": 5,
      "pending": 2,
      "available": 2,
      "connectorUp": 1,
      "status": 18,
      "_openAPIToGraphQL": {
        "data": {
          "_0_storeInventory": {
            "usedParams": {},
            "url": "https://petstore.swagger.io/v2/store/inventory",
            "usedRequestOptions": {
              "headers": {
                "accept": "application/json"
              },
              "method": "get"
            },
            "usedStatusCode": "200",
            "responseHeaders": {
              "access-control-allow-headers": "Content-Type, api_key, Authorization",
              "access-control-allow-methods": "GET, POST, DELETE, PUT",
              "access-control-allow-origin": "*",
              "connection": "keep-alive",
              "content-type": "application/json",
              "date": "Fri, 22 Apr 2022 15:12:34 GMT",
              "server": "Jetty(9.2.9.v20150224)",
              "transfer-encoding": "chunked"
            }
          }
        }
      }
    }
  }
}

Again it includes this _openAPIToGraphQL object.

[ardatan]

_openAPIToGraphQL is a needed internal field for the handler. Here it seems storeInventory doesn't have an object type because it doesn't have a selectionSet. Usually the fields returning an object should have an object type with those fields like a usual GraphQL Schema. Since we are currently rewriting the OpenAPI handler, you can try it like this example (maybe it makes difference) or you can extend your schema by adding a better schema by yourself with certain fields in order to avoid returning the object as-is.
Other than that, we aren't planning to spend time on the current openapi handler.

[MarkLyck]

@ardatan Thanks for the response! I didn't know The guild was working on a new version.

I tried it out, and while it doesn't have that _openAPIToGraphQL object in the new version 🎉, the response and query names end up being very strange and for some reason includes the data 4 times? 😅 I guess it's still in early development?

{
  "data": {
    "signalTest": {
      "signaltest_DOT_api_DOT_latest_records": {
        "records": [
          {
            "score_color": "green",
            "site_id": 17035
          },
          {
            "score_color": "green",
            "site_id": 17051
          },
          {
            "score_color": "green",
            "site_id": 69159
          },
          {
            "score_color": "green",
            "site_id": 13887
          },
          {
            "score_color": "green",
            "site_id": 14944
          },
          {
            "score_color": "green",
            "site_id": 19314
          },
          {
            "score_color": "green",
            "site_id": 19282
          },
          {
            "score_color": "green",
            "site_id": 16196
          },
          {
            "score_color": "green",
            "site_id": 19286
          },
          {
            "score_color": "yellow",
            "site_id": 17006
          }
        ],
        "$url": "https://my-api.com/v4/",
        "$method": "GET",
        "$request": {
          "query": {
            "records": [
              {
                "score_color": "green",
                "site_id": 17035
              },
              {
                "score_color": "green",
                "site_id": 17051
              },
              {
                "score_color": "green",
                "site_id": 69159
              },
              {
                "score_color": "green",
                "site_id": 13887
              },
              {
                "score_color": "green",
                "site_id": 14944
              },
              {
                "score_color": "green",
                "site_id": 19314
              },
              {
                "score_color": "green",
                "site_id": 19282
              },
              {
                "score_color": "green",
                "site_id": 16196
              },
              {
                "score_color": "green",
                "site_id": 19286
              },
              {
                "score_color": "yellow",
                "site_id": 17006
              }
            ],
            "input": {
              "size": 10
            },
            "size": 10
          },
          "path": {
            "records": [
              {
                "score_color": "green",
                "site_id": 17035
              },
              {
                "score_color": "green",
                "site_id": 17051
              },
              {
                "score_color": "green",
                "site_id": 69159
              },
              {
                "score_color": "green",
                "site_id": 13887
              },
              {
                "score_color": "green",
                "site_id": 14944
              },
              {
                "score_color": "green",
                "site_id": 19314
              },
              {
                "score_color": "green",
                "site_id": 19282
              },
              {
                "score_color": "green",
                "site_id": 16196
              },
              {
                "score_color": "green",
                "site_id": 19286
              },
              {
                "score_color": "yellow",
                "site_id": 17006
              }
            ],
            "input": {
              "size": 10
            }
          },
          "header": {}
        },
        "$response": {
          "url": "https://my-api.com/v4/",
          "method": "GET",
          "status": 200,
          "statusText": "OK",
          "body": {
            "records": [
              {
                "score_color": "green",
                "site_id": 17035
              },
              {
                "score_color": "green",
                "site_id": 17051
              },
              {
                "score_color": "green",
                "site_id": 69159
              },
              {
                "score_color": "green",
                "site_id": 13887
              },
              {
                "score_color": "green",
                "site_id": 14944
              },
              {
                "score_color": "green",
                "site_id": 19314
              },
              {
                "score_color": "green",
                "site_id": 19282
              },
              {
                "score_color": "green",
                "site_id": 16196
              },
              {
                "score_color": "green",
                "site_id": 19286
              },
              {
                "score_color": "yellow",
                "site_id": 17006
              }
            ]
          }
        }
      }
    }
  }
}

So as a baseline the current openAPI handler has a nicer response in my case. I'll live with the extra object being sent to the client until the new-openapi-handler is done :)

[ardatan]

It seems the schema you use doesn't have an object type for that field so you cannot select the fielda you want(which is an antipattern in GraphQL) so that causes the internal fields being exposed. The point of having an object type with a defined field structure (for each object, you should select fields with selection sets). You can fix your schema or check the other options because it is not possible for us to remove those internal fields in the root level currently.

[MarkLyck]

@ardatan Yeah that totally makes sense. I actually wasn't even aware our openAPI specs were not properly typed... And I guess the pet store example swagger api also just happened to not be typed properly either 😅.

I'll go harass the API developers to add properly typed objects instead of just doing type: "object" on everything 🤦‍♂️

Thank you so much for clearing up why this happens?