Справочник API

Общий доступ

Поддержку функций проверяйте через app.capabilities, доступ — через app.access и разрешения хоста. Замените тестовые значения перед вызовом.

Определения типов

graphql
type Mutation {
  createShare(input: ShareInput!): Share!
  deleteShare(id: ID!): Boolean!
  updateShare(id: ID!, input: ShareInput!): Share!
}

type Query {
  share(id: ID!): Share
  shares: [Share!]!
}

scalar Instant

type Share {
	id: ID!
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePath!]!
	url: String!
}

input ShareInput {
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePathInput!]!
}

type SharePath {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

input SharePathInput {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

Операции

mutation

createShare

Создаёт общий доступ для выбранных путей с политикой только чтения и необязательным сроком действия.

graphql
mutation createShare($input: ShareInput!) {
  createShare(input: $input) { id name password expiresAt readOnly url }
}
mutation

deleteShare

Удаляет общий ресурс и отзывает доступ через него.

graphql
mutation deleteShare($id: ID!) {
  deleteShare(id: $id)
}
mutation

updateShare

Обновляет имя общего ресурса, срок действия или выбранные корни файловой системы.

graphql
mutation updateShare($id: ID!, $input: ShareInput!) {
  updateShare(id: $id, input: $input) { id name password expiresAt readOnly url }
}
query

share

Прочитать общий ресурс с типизированными сопоставлениями путей и доступным URL; вернуть null, если он отсутствует.

graphql
query share($id: ID!) {
  share(id: $id) { id name password expiresAt readOnly url }
}
query

shares

Перечислить сохранённые общие ресурсы, включая истёкшие, которые ещё можно редактировать.

graphql
query shares {
  shares { id name password expiresAt readOnly url }
}