Skip to content

Latest commit

 

History

History
194 lines (113 loc) · 6.02 KB

stream.md

File metadata and controls

194 lines (113 loc) · 6.02 KB

Stream Schema

https://platform.codeclimate.com/schemas/stream

Streams are data sources that can be subscribed to.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none Stream.schema.json

Stream Type

object (Stream)

Stream Properties

Property Type Required Nullable Defined by
_type string Required cannot be null Stream
id string Required cannot be null Stream
self string Required cannot be null Stream
name string Required cannot be null Stream
htmlUrl string Optional cannot be null Stream
description string Optional cannot be null Stream
record string Optional cannot be null Stream
recordType string Optional cannot be null Stream
subscribed boolean Optional cannot be null Stream

_type

_type

  • is required
  • Type: string
  • cannot be null
  • defined in: Stream

_type Type

string

_type Constraints

constant: the value of this property must be equal to:

"Stream"

id

An ID for this stream. Should be unique within the context of this connector for a given configuration.

id

  • is required
  • Type: string
  • cannot be null
  • defined in: Stream

id Type

string

self

The canonical URL for this stream

self

  • is required
  • Type: string
  • cannot be null
  • defined in: Stream

self Type

string

self Constraints

URI: the string must be a URI, according to RFC 3986

name

A name for this stream

name

  • is required
  • Type: string
  • cannot be null
  • defined in: Stream

name Type

string

htmlUrl

The URL for a human to view this stream

htmlUrl

  • is optional
  • Type: string
  • cannot be null
  • defined in: Stream

htmlUrl Type

string

htmlUrl Constraints

URI: the string must be a URI, according to RFC 3986

description

A description of this stream

description

  • is optional
  • Type: string
  • cannot be null
  • defined in: Stream

description Type

string

record

A stream may be a representation of another record - use the URI of that record here if desired.

record

  • is optional
  • Type: string
  • cannot be null
  • defined in: Stream

record Type

string

record Constraints

URI: the string must be a URI, according to RFC 3986

recordType

The type of the record referred to by the record URI, if present

recordType

  • is optional
  • Type: string
  • cannot be null
  • defined in: Stream

recordType Type

string

subscribed

Represents if the stream has been subscribed to by a user within Code Climate

subscribed

  • is optional
  • Type: boolean
  • cannot be null
  • defined in: Stream

subscribed Type

boolean