module WarpEngine::AdminApi::Definitions::Schemas

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 258
def all
  [ software, release, release_asset, external_link, software_image, platform_link, software_status,
    software_category, download, download_summary, file_downloads, software_downloads,
    software_download_stats, pipeline, pipeline_run, pipeline_sync, file_entry, file_path,
    application_token, device_grant, principal, extra ]
end

Every Named component schema.

application_token ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 212
def application_token
  named("ApplicationToken", {
    id: S.id, name: S.string, tokenPrefix: S.string, ownerType: S.string, ownerId: S.integer,
    scopes: S.array(S.string), unrestricted: S.boolean, expiresAt: S.nullable(S.datetime),
    lastUsedAt: S.nullable(S.datetime), **timestamps,
    plainToken: S.string("Only in the answer that created it; never shown again"),
    sync: S.nullable(S.object({ synced: S.integer, failed: S.integer }, required: %i[synced failed]))
  }, required: %i[id name tokenPrefix ownerType ownerId scopes unrestricted expiresAt lastUsedAt createdAt updatedAt])
end

The ApplicationToken schema; the plain token and CI sync only when issued.

application_token_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 223
def application_token_body
  S.object({
    name: S.string, ownerId: S.integer("Defaults to the caller's owner"),
    scopes: S.array(S.string, "Admin scopes no wider than the caller's own"),
    unrestricted: S.boolean("Only an unrestricted caller may ask"),
    expiresAt: S.nullable(S.datetime("Not later than the caller's own expiry"))
  })
end

The body of issuing or changing an application token.

device_grant ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 233
def device_grant
  named("DeviceGrant", {
    id: S.id, userCode: S.string, clientName: text, state: S.enum(%w[pending approved denied expired]),
    subjectType: text, subjectId: S.nullable(S.integer), applicationTokenId: S.nullable(S.integer),
    approvedAt: S.nullable(S.datetime), deniedAt: S.nullable(S.datetime), expiresAt: S.datetime, **timestamps
  })
end

The DeviceGrant schema, one device sign-in.

download ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 142
def download
  named("Download", { id: S.id, filePath: S.string, releaseId: S.nullable(S.integer),
                      softwareId: S.nullable(S.integer), ipAddress: text, userAgent: text, referer: text,
                      **timestamps })
end

The Download schema, one entry of the download log.

download_summary ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 149
def download_summary
  named("DownloadSummary", { total: S.integer, today: S.integer, week: S.integer, month: S.integer })
end

The DownloadSummary schema: downloads in total, today, this week and this month.

external_link ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 81
def external_link
  named("ExternalLink", { id: S.id, softwareId: S.integer, label: S.string, url: S.string, **timestamps })
end

The ExternalLink schema.

external_link_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 86
def external_link_body = S.object({ label: S.string, url: S.string })

The body of creating or changing an external link.

extra ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 252
def extra
  named("Extra", { association: S.string, multiple: S.boolean,
                   value: { description: "An object, or an array of objects when multiple" } })
end

The Extra schema: what a host-defined additional resource holds for a software.

file_downloads ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 154
def file_downloads
  named("FileDownloads", { filePath: S.string, downloads: S.integer, lastDownloadAt: S.nullable(S.datetime) })
end

The FileDownloads schema: downloads of one file.

file_entry ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 200
def file_entry
  named("FileEntry", { name: S.string, path: S.string, type: S.enum(%w[file directory]),
                       size: S.nullable(S.integer), modifiedAt: S.nullable(S.datetime),
                       downloads: S.nullable(S.integer) })
end

The FileEntry schema, one file or directory of the artifact store.

file_path ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 207
def file_path
  named("FilePath", { path: S.string("Relative to the artifact store") })
end

The FilePath schema: a path in the artifact store.

named (name, properties, required: properties.keys)

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 20
def named(name, properties, required: properties.keys)
  Named.new(name, S.object(properties, required: required))
end

A Named schema name of an object with properties, by default all required.

pipeline ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 174
def pipeline
  named("Pipeline", { id: S.id, repoId: S.integer, repoOwner: S.string, repoName: S.string,
                      fullName: S.string, platform: S.string, active: S.boolean,
                      softwareId: S.nullable(S.integer), lastPipelineStatus: text,
                      lastPipelineAt: S.nullable(S.datetime), **timestamps })
end

The Pipeline schema, one CI repository.

pipeline_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 182
def pipeline_body
  S.object({ platform: S.enum(WarpEngine::Platform.names + [ WarpEngine::Pipeline::UNKNOWN_PLATFORM ]),
             softwareId: S.nullable(S.integer("One pipeline per software: taking one moves it here")) })
end

The body of changing a pipeline’s platform or software.

pipeline_run ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 188
def pipeline_run
  named("PipelineRun", { number: S.integer, status: text, branch: text, message: text,
                         createdAt: S.nullable(S.datetime), url: text })
end

The PipelineRun schema, one run on the CI server.

pipeline_sync ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 194
def pipeline_sync
  named("PipelineSync", { created: S.array(S.ref("Pipeline")), updated: S.array(S.ref("Pipeline")),
                          deactivated: S.array(S.ref("Pipeline")) })
end

The PipelineSync schema: the pipelines a sync created, updated and deactivated.

platform_link ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 107
def platform_link
  named("PlatformLink", { id: S.id, platform: S.string, name: S.string, url: S.string,
                          position: S.integer, **timestamps })
end

The PlatformLink schema.

platform_link_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 113
def platform_link_body
  S.object({ platform: S.enum(WarpEngine::Platform.names), name: S.string, url: S.string,
             position: S.integer(minimum: 0) })
end

The body of creating or changing a platform link.

principal ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 242
def principal
  named("Principal", {
    label: text, ownerType: text, ownerId: S.nullable(S.integer), scopes: S.array(S.string),
    unrestricted: S.boolean, tokenPrefix: text, expiresAt: S.nullable(S.datetime),
    resources: S.array(S.string, "The resources this caller may use here"),
    readOnly: S.boolean, mcp: S.boolean
  })
end

The Principal schema answered by GET /me.

release ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 61
def release
  named("Release", { id: S.id, softwareId: S.integer, version: S.string,
                     assets: S.array(S.ref("ReleaseAsset")), **timestamps })
end

The Release schema, with its assets.

release_asset ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 70
def release_asset
  named("ReleaseAsset", { id: S.id, releaseId: S.integer, kind: S.enum(WarpEngine::ReleaseAsset::KINDS),
                          path: S.string, **timestamps })
end

The ReleaseAsset schema.

release_asset_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 76
def release_asset_body
  S.object({ kind: S.enum(WarpEngine::ReleaseAsset::KINDS), path: S.string("Absolute path in the artifact store") })
end

The body of creating or changing a release asset.

release_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 67
def release_body = S.object({ version: S.string })

The body of creating or changing a release.

software ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 33
def software
  base = {
    id: S.id, name: S.string, title: S.string, author: text, desc: text, story: text,
    license: text, platform: S.enum(WarpEngine::Platform.names), status: text, category: text,
    highlighted: S.nullable(S.boolean), shelfName: text, ownerType: text, ownerId: S.nullable(S.integer), **timestamps
  }
  included = {
    releases:      S.array(S.ref("Release"), "With include=releases"),
    images:        S.array(S.ref("SoftwareImage"), "With include=images"),
    externalLinks: S.array(S.ref("ExternalLink"), "With include=externalLinks"),
    extras:        S.object({}, description: "With include=extras: one key per additional resource", additional: true)
  }
  named("Software", base.merge(included), required: base.keys)
end

The Software schema, with the optional included lists of GET /softwares/:id.

software_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 49
def software_body
  S.object({
    name: S.string("Internal name, unique"), title: S.string, author: text, desc: text, story: text,
    license: text, platform: S.enum(WarpEngine::Platform.names),
    status: S.nullable(S.string("A key from software_statuses")),
    category: S.nullable(S.string("A key from software_categories; a new word is registered for review")),
    highlighted: S.boolean,
    shelfName: S.nullable(S.string("File name on a shelf (A-Z, 0-9, -); null uses the name"))
  })
end

The body of creating or changing a software.

software_category ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 131
def software_category
  named("SoftwareCategory", { id: S.id, key: S.string, label: S.string, position: S.integer,
                              needsReview: S.boolean, softwareCount: S.integer, **timestamps })
end

The SoftwareCategory schema.

software_category_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 137
def software_category_body
  S.object({ key: S.string, label: S.string, position: S.integer, needsReview: S.boolean })
end

The body of creating or changing a software category.

software_download_stats ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 164
def software_download_stats
  named("SoftwareDownloadStats", {
    total:    S.integer,
    releases: S.array(S.object({ releaseId: S.integer, version: S.string, downloads: S.integer,
                                 files: S.array(S.ref("FileDownloads")) },
                               required: %i[releaseId version downloads files]))
  })
end

The SoftwareDownloadStats schema: downloads of one software by release and file.

software_downloads ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 159
def software_downloads
  named("SoftwareDownloads", { softwareId: S.integer, name: S.string, title: S.string, downloads: S.integer })
end

The SoftwareDownloads schema: downloads of one software.

software_image ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 89
def software_image
  named("SoftwareImage", { id: S.id, softwareId: S.integer, imageId: S.integer, isDefault: S.boolean,
                           position: S.integer, url: S.nullable(S.string), **timestamps })
end

The SoftwareImage schema.

software_image_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 95
def software_image_body
  S.object({ imageId: S.integer("An image of the host's image library"), isDefault: S.boolean,
             position: S.integer(minimum: 0) })
end

The body of linking a library image to a software.

software_image_upload_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 101
def software_image_upload_body
  S.object({ file: S.string("The image file", format: "binary"), isDefault: S.boolean,
             position: S.integer(minimum: 0) })
end

The multipart body of uploading an image for a software.

software_status ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 119
def software_status
  named("SoftwareStatus", { id: S.id, key: S.string, label: S.string, position: S.integer,
                            defaultVisible: S.boolean, badge: text, softwareCount: S.integer, **timestamps })
end

The SoftwareStatus schema.

software_status_body ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 125
def software_status_body
  S.object({ key: S.string(pattern: "^[a-z0-9_-]+$"), label: S.string, position: S.integer,
             defaultVisible: S.boolean, badge: text })
end

The body of creating or changing a software status.

text ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 30
def text = S.nullable(S.string)

A nullable string schema.

timestamps ()

Source

# File lib/warp_engine/admin_api/definitions/schemas.rb, line 25
def timestamps
  { createdAt: S.nullable(S.datetime), updatedAt: S.nullable(S.datetime) }
end

The nullable createdAt and updatedAt properties.

module WarpEngine::AdminApi::Definitions::Schemas

Constants

Public Instance Methods