369 lines
8.8 KiB
Go
369 lines
8.8 KiB
Go
swagger: "2.0"
|
|
info:
|
|
title: oc-peer
|
|
description: |
|
|
Manage OpenCloud peers
|
|
version: 1.0.0
|
|
termsOfService: http://cloud.o-forge.io/
|
|
contact:
|
|
email: admin@o-cloud.io
|
|
license:
|
|
name: AGPL
|
|
url: https://www.gnu.org/licenses/agpl-3.0.html
|
|
basePath: /oc
|
|
paths:
|
|
/:
|
|
get:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
find all peer
|
|
<br>
|
|
operationId: PeerController.GetAll
|
|
parameters:
|
|
- in: query
|
|
name: is_draft
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: limit
|
|
description: "false"
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/{id}:
|
|
get:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
find peer by peerid
|
|
<br>
|
|
operationId: PeerController.Get
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
delete:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
delete peer by peerid
|
|
<br>
|
|
operationId: PeerController.Delete
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to delete state
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/{type}/extended/search:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
search workspace
|
|
<br>
|
|
operationId: PeerController.Search
|
|
parameters:
|
|
- in: query
|
|
name: is_draft
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: limit
|
|
description: "false"
|
|
type: string
|
|
- in: body
|
|
name: data
|
|
description: body for data content (Json format)
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/json'
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
/{type}/search/{search}:
|
|
get:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
search workspace
|
|
<br>
|
|
operationId: PeerController.Search
|
|
parameters:
|
|
- in: path
|
|
name: type
|
|
description: the type you want to get
|
|
required: true
|
|
type: string
|
|
- in: path
|
|
name: search
|
|
description: the word search you want to get
|
|
required: true
|
|
type: string
|
|
- in: query
|
|
name: is_draft
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: "false"
|
|
type: string
|
|
- in: query
|
|
name: limit
|
|
description: "false"
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{workspace} models.workspace'
|
|
/add/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add peer by peerid
|
|
<br>
|
|
operationId: PeerController.add
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/blacklist/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add blacklist peer by peerid
|
|
<br>
|
|
operationId: PeerController.Blacklist
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/known/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add kwown peer by peerid
|
|
<br>
|
|
operationId: PeerController.known
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/master/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add master peer by peerid
|
|
<br>
|
|
operationId: PeerController.Master
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/nano/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add Nano peer by peerid
|
|
<br>
|
|
operationId: PeerController.Nano
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/organization:
|
|
put:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
set organization data on self peer (only allowed when peer has no OrganizationMasterID)
|
|
<br>
|
|
operationId: PeerController.SetOrganization
|
|
parameters:
|
|
- in: body
|
|
name: data
|
|
description: organization data
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/json'
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/organization_master/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
request to become the organization master of a peer (send them an ORGANIZATION_MEMBER relation)
|
|
<br>
|
|
operationId: PeerController.OrganizationMasterRequest
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id to become member of our org
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/organization_member/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
request to join a peer's organization as a member (send them an ORGANIZATION_MASTER relation)
|
|
<br>
|
|
operationId: PeerController.OrganizationMemberRequest
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id whose org we want to join
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/organization_partner/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
request organization partner relation with a peer
|
|
<br>
|
|
operationId: PeerController.OrganizationPartner
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id to set as organization partner
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/partner/{id}:
|
|
post:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
add partner peer by peerid
|
|
<br>
|
|
operationId: PeerController.Partner
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to blacklist
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/status/:
|
|
post:
|
|
tags:
|
|
- status
|
|
description: |-
|
|
get peer status if it's alive
|
|
<br>
|
|
operationId: StatusController.Status
|
|
parameters:
|
|
- in: body
|
|
name: body
|
|
description: of
|
|
schema:
|
|
$ref: '#/definitions/list'
|
|
responses:
|
|
"200":
|
|
description: '{status} models.status'
|
|
/valid/{id}:
|
|
get:
|
|
tags:
|
|
- oc-peer/controllersPeerController
|
|
description: |-
|
|
find peer by peerid
|
|
<br>
|
|
operationId: PeerController.Valid
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: the peer id you want to get
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: '{peer} models.peer'
|
|
/version/:
|
|
get:
|
|
tags:
|
|
- version
|
|
description: |-
|
|
get version
|
|
<br>
|
|
operationId: VersionController.GetAll
|
|
responses:
|
|
"200":
|
|
description: ""
|
|
definitions:
|
|
json:
|
|
title: json
|
|
type: object
|
|
list:
|
|
title: list
|
|
type: object
|
|
tags:
|
|
- name: status
|
|
description: |
|
|
Operations about workflow
|
|
- name: oc-peer/controllersPeerController
|
|
description: |
|
|
Operations about workflow
|
|
- name: version
|
|
description: |
|
|
VersionController operations for Version
|