developer.compare

GET

/v1/developer/reports/{id}/compare

curl --request GET \
  --url 'https://example.com/v1/developer/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/compare?other=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$/

Query Parameters

other

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$/

Responses

200

Success

Media typeapplication/json

object

introduced

required

Array<object>

object

code

required

string

impacts

Array<string>

Allowed values: discovery indexing connection

stage

required

string

Allowed values: publication catalog card indexing

severity

required

string

Allowed values: blocking suggestion

source

required

string

fieldPath

string

message

required

string

repair

required

string

resolved

required

Array<object>

object

code

required

string

impacts

Array<string>

Allowed values: discovery indexing connection

stage

required

string

Allowed values: publication catalog card indexing

severity

required

string

Allowed values: blocking suggestion

source

required

string

fieldPath

string

message

required

string

repair

required

string

persisting

required

Array<object>

object

code

required

string

impacts

Array<string>

Allowed values: discovery indexing connection

stage

required

string

Allowed values: publication catalog card indexing

severity

required

string

Allowed values: blocking suggestion

source

required

string

fieldPath

string

message

required

string

repair

required

string

Example

{
  "introduced": [
    {
      "impacts": [
        "discovery"
      ],
      "stage": "publication",
      "severity": "blocking"
    }
  ],
  "resolved": [
    {
      "impacts": [
        "discovery"
      ],
      "stage": "publication",
      "severity": "blocking"
    }
  ],
  "persisting": [
    {
      "impacts": [
        "discovery"
      ],
      "stage": "publication",
      "severity": "blocking"
    }
  ]
}

400

DeveloperInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DeveloperInputInvalid

message

required

string

keys

Array<string>

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "DeveloperInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: DeveloperRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: DeveloperForbidden

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | DeveloperNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: DeveloperNotFound

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: DeveloperConflict

reason

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: DeveloperUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}