Skip to content
Qualia Docs

Issues_DismissIssues

POST
/v1/accounts/{account}/datasets/{dataset}/issues:dismiss
 
curl --request POST \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/datasets/example/issues:dismiss \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "parent": "example", "selection": { "names": { "names": [ "example" ] }, "filter": "example" }, "reason": "example", "cause": "DISMISS_CAUSE_UNSPECIFIED" }'

Dismisses issues by name or by filter, e.g. one kind on every episode at once (QUA-2225). Only issues scoped to the parent: through a mixture, upstream issues are never matched by a filter and are refused (INVALID_ARGUMENT, not under parent) when named. No ruling moves. For a merged dataset the issues of the uploads it holds are its own to dismiss (by filter, or named under it as a read names them, or under their upload).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

dataset
required
string

The dataset id.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request for Issues.DismissIssues.

object
parent
required

Accounts/{account}/datasets/{dataset}

string
selection
required

Which issues; only OPEN blocking issues are dismissed.

object
names

Issue names under the request’s parent.

object
names

Accounts/{account}/datasets/{dataset}/issues/{issue}, at most 10000.

Array<string>
filter

A ListIssues filter over the parent, e.g. code = "idle_tail" AND state = OPEN.

string
reason

Words for the record.

string
cause

MANUAL (default) or TRIM when the client trimmed the moment away.

string format: enum
Allowed values: DISMISS_CAUSE_UNSPECIFIED MANUAL KEEP TRIM RESOLVED

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Issues.DismissIssues.

object
dismissedCount

How many issues were dismissed.

integer format: int32
lockedCount

Episodes whose issues were left as they were, because another person holds the episode’s edit lease. Their issues are not in dismissed_count.

integer format: int32
locked

The first 100 of them, with their holders.

Array<object>

An episode a write left alone, or refused, because another person holds its edit lease (Episodes.AcquireEpisodeLease). Bulk responses list at most 100 of these beside a count of all of them.

object
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}, in the scope the write was made in.

string
holderName

The holder’s display name; empty when they have none. (— api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: a person’s display name, as Episode.Lease calls it. —)

string
Example generated
{
  "dismissedCount": 1,
  "lockedCount": 1,
  "locked": [
    {
      "episode": "example",
      "holderName": "example"
    }
  ]
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}