developer.compare

GET

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

curl --request GET \
  --url 'https://example.com/v1/developer/reports/example/compare?other=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

id

required

string

Query Parameters

other

required

string

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

DeveloperRestricted | DeveloperForbidden | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

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: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "DeveloperRestricted"
}

404

DeveloperNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: DeveloperNotFound

Example

{
  "_tag": "DeveloperNotFound"
}

409

DeveloperConflict

Media typeapplication/json

object

_tag

required

string

Allowed values: DeveloperConflict

reason

required

string

Example

{
  "_tag": "DeveloperConflict"
}

503

DeveloperUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: DeveloperUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "DeveloperUnavailable"
}