Skip to content

ReleaseSchema.description should be optional #3350

@privet-kitty

Description

@privet-kitty

Hi. Thank you for maintaining this awesome SDK!

Description

  • Node.js version: any
  • Gitbeaker version: 35.1.0
  • Gitbeaker release (cli, node, browser, core, requester-utils): core
  • OS & version: any

Currently description field of ReleaseSchema doesn't allow null, while it's allowed in GitLab API. Actually there exists a release out there that contains null in description field, which you can get from tezos, for example:

curl --header "PRIVATE-TOKEN: <your token>" https://gitlab.com/api/v4/projects/3836952/releases/v17.1 | jq .description
# -> null

This difference sometimes causes troubles in a software that relies on gitbeaker. My case is node-gitlab-2-github, a migration tool from GitLab to GitHub. This tool trusts gitbeaker's typing, fetches a release from GitLab, and moves it to GitHub, while it incorrectly assumes that description be always a string and throws an exception on a GitHub-side stack.

Steps to reproduce

Expected behaviour

Actual behaviour

Possible fixes

descpription field should be optional.

Checklist

Metadata

Metadata

Assignees

No one assigned

    Labels

    releasedThis issue/pull request has been released.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions