Almanac (Independent Publisher) (#2830)

* Revert "Merge branch 'microsoft:dev' into dev"

This reverts commit 096a7c3199, reversing
changes made to cb0948670f.

* Revert "Merge branch 'microsoft:dev' into dev"

This reverts commit cb0948670f, reversing
changes made to dc26e8a026.

* Revert "Revert "Merge branch 'microsoft:dev' into dev""

This reverts commit 01764d0a6d.

* Revert "Revert "Merge branch 'microsoft:dev' into dev""

This reverts commit a3f086ef0f.

* Add files via upload

* Revert "Add files via upload"

This reverts commit eeff7b7a02.

* Add files via upload

* Delete independent-publisher-connectors/FileIO directory

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Revert "Add files via upload"

This reverts commit 1d85506958.

* Add files via upload

* Update apiDefinition.swagger.json
This commit is contained in:
Troy Taylor 2023-08-14 10:52:48 -04:00 коммит произвёл GitHub
Родитель 93db09c6d5
Коммит 0a094a31c3
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 2445 добавлений и 0 удалений

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -0,0 +1,258 @@
{
"properties": {
"connectionParameters": {
"workspace": {
"type": "string",
"uiDefinition": {
"displayName": "Workspace ID",
"description": "The workspace ID for this API.",
"tooltip": "Provide your workspace ID",
"constraints": {
"tabIndex": 2,
"clearText": false,
"required": "true"
}
}
},
"api_key": {
"type": "securestring",
"uiDefinition": {
"displayName": "Access Token (in the form 'Bearer yourAccessToken')",
"description": "The Access Token (in the form 'Bearer yourAccessToken') for this API.",
"tooltip": "Provide your Access Token (in the form 'Bearer yourAccessToken')",
"constraints": {
"tabIndex": 2,
"clearText": false,
"required": "true"
}
}
}
},
"iconBrandColor": "#da3b01",
"capabilities": [],
"policyTemplateInstances": [
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs Access ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs/{doc_id}/accesses/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"DeleteDocsDocIdAccessesId",
"PutDocsDocIdAccessesId",
"PatchDocsDocIdAccessesId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs Access",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs/{doc_id}/accesses",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"PostDocsDocIdProperties",
"GetDocsDocIdProperties"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetDocsId",
"PutDocsId",
"PatchDocsId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetDocs"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Files Move",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/files/move",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"PostFilesMove"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Folders ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/folders/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetFoldersId",
"PutFoldersId",
"PatchFoldersId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Folders",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/folders",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetFolders",
"PostFolders"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Groups",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/groups",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetGroups"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Handbooks ID Items ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/handbooks/{handbook_id}/items/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"DeleteHandbooksHandbookIdItemsId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Handbooks ID Items",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/handbooks/{handbook_id}/items",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetHandbooksHandbookIdItems",
"PostHandbooksHandbookIdItems"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Handbooks",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/handbooks",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetHandbooks"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Imports",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/imports",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"PostImports"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Imports ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/imports/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetImportsId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Properties ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/properties/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"DeletePropertiesId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Properties",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/properties",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetProperties",
"PostProperties"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs ID Properties ID",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs/{doc_id}/properties/{id}",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"DeleteDocsDocIdPropertiesId"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Docs ID Properties",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/docs/{doc_id}/properties",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetDocsDocIdProperties",
"PostDocsDocIdProperties"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Groups ID Users",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/groups/{group_id}/users",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetGroupsGroupIdUsers"
]
}
},
{
"templateId": "routerequesttoendpoint",
"title": "Set Workspace ID - Users",
"parameters": {
"x-ms-apimTemplateParameter.newPath": "/@connectionParameters('workspace')/users",
"x-ms-apimTemplateParameter.httpMethod": "@Request.OriginalHTTPMethod",
"x-ms-apimTemplate-operationName": [
"GetUsers"
]
}
}
],
"publisher": "Troy Taylor",
"stackOwner": "Almanac Labs"
}
}

Просмотреть файл

@ -0,0 +1,75 @@
# Almanac
Almanac is building collaborative infrastructure to serve human creativity. Using the fastest wiki and workflow tool, consolidate your docs in a beautiful, organized single source of truth.
## Publisher: Troy Taylor, Hitachi Solutions
## Prerequisites
You will need to sign up for an account with [Almanac](https://almanac.io/signup).
## Obtaining Credentials
To request access to the API, you will need to email [api@almanac.io](mailto:api@almanac.io) with your Almanac email address, your Almanac Workspace name, and your intended use of the API. An API access token will be shared when your request is confirmed.
## Supported Operations
### Add document access
Add access to document.
### Add document property
Add a custom property to a document.
### Create document property
Create a document property on the workspace level.
### Create folder
Create a folder.
### Create handbook item
Add an item to handbook.
### Delete document custom property
Delete a document custom property on the workspace level.
### Delete document property
Remove a custom property from a document.
### Delete workbook item
Delete an item from the handbook.
### Get documents
Retrieve meta information of all docs in workspace.
### Get document accesses
List document accesses.
### Get document info
Retrieve meta information of a document.
### Get document properties
List document custom properties on document level.
### Get document properties
List document custom properties on the workspace level.
### Get groups
Retrieve user groups.
### Get folders
Retrieve a list of all folders.
### Get folder info
Retrieve a list of folder meta information.
### Get handbooks
Retrieve a list of workspace handbooks.
### Get handbook items
Retrieve a list of handbook items.
### Get import
Retrieve information about an existing import.
### Get users
Retrieve a list of users.
### Get users in group
Retrieve all users of a user group.
### Import document
Import a document from an external source.
### Move files
Move files (docs and/or folders) to a specific folder (in same or different workspace).
### Remove document access
Remove access from document.
### Replace document access
Replace access to a document.
### Replace document info
Update meta information of a doc.
### Replace folder info
Replace a folder meta information.
### Update document access
Update access to a document.
### Update document info
Update meta information of a document.
### Update folder info
Update a folder meta information.
## Known Issues and Limitations
The Almanac API is currently in beta and this connector is based on the beta documentation.