dragonchaser / libre-graph-api-go

generated go SDK for the open graph api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Go API client for libregraph

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v0.14.2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import libregraph "github.com/owncloud/libre-graph-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), libregraph.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), libregraph.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), libregraph.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), libregraph.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://ocis.ocis-traefik.latest.owncloud.works

Class Method HTTP request Description
DrivesApi CreateDrive Post /drives Create a new space of a specific type
DrivesApi DeleteDrive Delete /drives/{drive-id} Delete a specific space
DrivesApi GetDrive Get /drives/{drive-id} Get drive by id
DrivesApi UpdateDrive Patch /drives/{drive-id} Update the space
DrivesGetDrivesApi ListAllDrives Get /drives Get All drives
DrivesRootApi GetRoot Get /drives/{drive-id}/root Get root from arbitrary space
GroupApi AddMember Post /groups/{group-id}/members/$ref Add a member to a group
GroupApi DeleteGroup Delete /groups/{group-id} Delete entity from groups
GroupApi DeleteMember Delete /groups/{group-id}/members/{directory-object-id}/$ref Delete member from a group
GroupApi GetGroup Get /groups/{group-id} Get entity from groups by key
GroupApi UpdateGroup Patch /groups/{group-id} Update entity in groups
GroupsApi CreateGroup Post /groups Add new entity to groups
GroupsApi ListGroups Get /groups Get entities from groups
MeChangepasswordApi ChangeOwnPassword Post /me/changePassword Chanage your own password
MeDriveApi GetHome Get /me/drive Get personal space for user
MeDriveRootApi HomeGetRoot Get /me/drive/root Get root from personal space
MeDriveRootChildrenApi HomeGetChildren Get /me/drive/root/children Get children from drive
MeDrivesApi ListMyDrives Get /me/drives Get drives from me
MeUserApi MeGet Get /me
UserApi DeleteUser Delete /users/{user-id} Delete entity from users
UserApi GetUser Get /users/{user-id} Get entity from users by key
UserApi UpdateUser Patch /users/{user-id} Update entity in users
UsersApi CreateUser Post /users Add new entity to users
UsersApi ListUsers Get /users Get entities from users

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

About

generated go SDK for the open graph api

License:Apache License 2.0


Languages

Language:Shell 100.0%