Clone wiki

confluence-space-s3-documents-plugin / Home

passing.png

Space S3 Documents for Confluence Documentation

Welcome! here is Quick Start FAQ to start using this App.

Simple app that helps to Store, manage, versioning and centralize space or project related documents on Amazon AWS S3 bucket.

Features

  • Beside Upload, Option to attach and detach existing AWS S3 documents on Confluence.
  • Helps Jira Documents Versioning in AWS S3 bucket
  • Provides Macros
    • S3 Documents Summary (s3-documents-summary}
    • S3 Documents Link (s3-documents-link}
  • REST API

05_s3_documents.PNG

REST API

Get Project S3 Documents

GET http://localhost:8080/rest/spaces3documents/1.0/utility/list/documents/{spaceKey}

Query Parameters:

spaceKey (String) - Confluence Space Key

Response: [Status: 200]

$ curl -u"user:password" -XGET http://localhost:8080/rest/spaces3documents/1.0/utility/list/documents/SWTEST

Attach Existing Amazon AWS S3 Document

POST http://localhost:8090/rest/spaces3documents/1.0/utility/attach/documents

Required Schema Fields:

  • spaceKey (String) - Confluence Space Key
  • pageId (Number)
  • documentKey (String) - AWS S3 Document Path
$ curl -u"user:password" -XPOST http://localhost:8090/rest/spaces3documents/1.0/utility/attach/documents \
-H "Content-Type: application/json" \
--data "{\"spaceKey\":\"SWTEST\",\"pageId\":6881282,\"documentKey\":\"test2/README\"}"
{"status":17,"message":"[Info] Space S3 Document has been attached."}
$

Detach Amazon AWS S3 Document on Jira

DELETE http://localhost:8090/rest/spaces3documents/1.0/utility/detach/documents/{spaceKey}/id/{documentId}

$ curl -u"user:password" -XDELETE \
http://localhost:8090/rest/spaces3documents/1.0/utility/detach/documents/SWTEST/id/17
{"status":17,"message":"[Info] Space S3 Document has been detached."}
$

Updated