R/organizations.R

In Sage-Bionetworks/schemann: Synapse Annotation Schemas

#' @title Create new organization
#'
#' @description Create a new Synapse JSON schema services organization.
#'
#' @export
#' @param syn Synapse client object
#' @param name Name of the organization (must be unique across Synapse)
create_org <- function(syn, name) {
  uri <- "/schema/organization"
  body <- glue::glue("{{\"organizationName\":\"{name}\"}}")
  rest_post(syn, uri = uri, body = body)
}

#' @title Lookup organization by name
#'
#' @description Get organization information by name.
#'
#' @export
#' @param syn Synapse client object
#' @param name Name of organization
get_org_info <- function(syn, name) {
  uri <- glue::glue("/schema/organization?name={name}")
  rest_get(syn = syn, uri = uri)
}

#' @title Organization ACL
#'
#' @description Get organization's Access Control List (ACL) by organization ID
#' number.
#'
#' @export
#' @param syn Synapse client object
#' @param org_id Organziation ID number
get_org_acl <- function(syn, org_id) {
  uri <- glue::glue("/schema/organization/{org_id}/acl")
  rest_get(syn = syn, uri = uri)
}

#' @title Update organization ACL
#'
#' @description Update an organization's ACL. Must have appropriate ACL
#' permissions to update.
#'
#' @export
#' @param syn Synapse client object
#' @param org_id Organization ID number
#' @param acl JSON formmated string with new ACL
update_org_acl <- function(syn, org_id, acl) {
  ## TODO Make ACL bit better
  uri <- glue::glue("/schema/organization/{org_id}/acl")
  rest_put(syn = syn, uri = uri, body = acl)
}

#' @title List organization schemas
#'
#' @description List first page of schemas registered to an organization.
#' TODO missing token handling for more pages
#'
#' @export
#' @param syn Synapse client object
#' @param name Name of organization
list_org_schemas <- function(syn, name) {
  uri <- "/schema/list"
  body <- glue::glue("{{organizationName: \"{name}\"}}")
  rest_post(syn = syn, uri = uri, body = body)
}

#' @title Get Schema Versions
#'
#' @description Get first page of information about each version of a schema.
#' TODO Handle extra pages
#' @param syn Synapse client object
#' @param org_name Name of organization
#' @param schema_name Name of schema
get_schema_versions <- function(syn, org_name, schema_name) {
  uri <- "/schema/version/list"
  body <- glue::glue("{{organizationName: \"{org_name}\",schemaName: \"{schema_name}\"}}")
  rest_post(syn = syn, uri = uri, body = body)
}