netlify / netlify/open-api

`draft` property not being returned in `listSiteDeploys`

Open
#365 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

Hi, we have a feature that depends on knowing whether or not a deploy was a draft. The listSiteDeploys docs for the api state that the draft property would be sent in the response, but our responses from the API are lacking that property.

We are using the js-client to consume the API from a Node application.

Sample response:

{
      "id":"618c1336ed517213e60df2db",
      "site_id":REDACTED,
      "build_id":"618c1336ed517213e60df2d9",
      "state":"error",
      "name":"sandbox-straightforward-toad-618bcff9885ea2ecc10cb733",
      "url":REDACTED,
      "ssl_url":REDACTED,
      "admin_url":REDACTED,
      "deploy_url":REDACTED,
      "deploy_ssl_url":REDACTED,
      "created_at":"2021-11-10T18:45:10.571Z",
      "updated_at":"2021-11-10T18:45:13.601Z",
      "user_id":REDACTED,
      "error_message":"SOME ERROR NOT RELATED TO THIS",
      "required":[
         
      ],
      "required_functions":null,
      "commit_ref":null,
      "review_id":null,
      "branch":"main",
      "commit_url":null,
      "skipped":null,
      "locked":null,
      "log_access_attributes":{
         REDACTED
      },
      "title":null,
      "review_url":null,
      "published_at":null,
      "context":"production",
      "deploy_time":null,
      "available_functions":[
         
      ],
      "screenshot_url":null,
      "site_capabilities":{
        REDACTED
      },
      "committer":null,
      "skipped_log":null,
      "manual_deploy":false,
      "file_tracking_optimization":true,
      "plugin_state":"none",
      "has_edge_handlers":false,
      "links":{
         REDACTED
      },
      "framework":"not_fetched",
      "entry_path":null,
      "views_count":null
   }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the listSiteDeploys operation in the linked OpenAPI documentation and compare its declared response schema with the sample response. Check whether the omission is in the API specification or in the API data returned to the js-client. Done means the source of the missing draft property is identified and the relevant contract or behavior is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.