Hi I wonder if someone could give me a hint as to how to upd DataHub #getting-started

Hi, I wonder if someone could give me a hint as to...

faint-gold-51647

12/13/2023, 5:36 PM

Hi, I wonder if someone could give me a hint as to how to update dataset fields descriptions via API. I've run into a problem trying to update a dataset field description using

updateDescription

. I realize that it's incubating, but the docs mention that it currently only supports Dataset Schema Fields, Containers. So, I thought it should work, but looks like I was wrong. My mutation (I used GraphQL) looks like this:

Copy code

mutation updateDescription {
  updateDescription(
    input: {
      description: "My description",
      resourceUrn: "urn:this:is:(urn:some:urn:),fieldname)"
    }
  )
}

The response I get is:

Copy code

"message": "An unknown error occurred."

and

Copy code

"extensions": {
        "code": 500,
        "type": "SERVER_ERROR",
        "classification": "DataFetchingException"
      }

What am I doing wrong? And is there a better way to add/change field descriptions programmatically?

faint-gold-51647

12/13/2023, 5:55 PM

Oh. Just figured it out myself. You know, there's this magic: you spend hours trying to solve a problem, then you give in and ask a question, and lo and behold, it dawns on you.

faint-gold-51647

12/13/2023, 6:01 PM

Now, just in case someone else runs into this: 1/ As to my query above, all fields should be filled, like so:

Copy code

mutation updateDescription {
  updateDescription(
    input: {
      description: "My description",
      resourceUrn: "My dataset URN, not that of the field!!!",
      subResource: "field_name, that is the ending of the field URN",
      subResourceType: DATASET_FIELD
    }
  )
}

Now it works. 2/ In fact, the whole thing is working on GraphQL API, so basically, we simply use all the same queries in our scripts. So as soon as we need a reference, we can open DevTools > Network and check out the payload of the necessary request.

rich-barista-93413

12/19/2023, 5:50 AM

Thanks for sharing, Anna!

Open in Slack

Previous Next