Rename space-id to space-key (#9)

Author: Bhacaz

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+* Rename space-id to space-key ([#9](https://github.com/Bhacaz/docs-as-code-confluence/pull/9))
 * Upload images ([#5](https://github.com/Bhacaz/docs-as-code-confluence/pull/5))
 * Specified node version and updated dependencies ([#4](https://github.com/Bhacaz/docs-as-code-confluence/pull/4))
 

README.md

@@ -7,14 +7,14 @@ the directory structure.
 
 ## Parameters
 
-| Name | Description | Required |
-| ---- | --- | --- |
-| `folder` | The folder to sync | true |
-| `username` | Confluence username or email | true |
-| `password` | Confluence password or [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) | true |
+| Name                  | Description | Required |
+|-----------------------| --- | --- |
+| `folder`              | The folder to sync | true |
+| `username`            | Confluence username or email | true |
+| `password`            | Confluence password or [API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) | true |
 | `confluence-base-url` | Your Confluence URL (with `wiki`). Example: `https://mydomain.atlassian.net/wiki` | true |
-| `space-id` | Confluence **space key** to publish the documentation. Located after `spaces` in the URL. `https://mydomain.atlassian.net/wiki/spaces/<<~1234>>`. <br> Or in _Space settings_ > _Space details_ > _Key_. | true |
-| `parent-page-id` | Page id under which the documentation will be published. Located after `pages` in the URL. `https://mydomain.atlassian.net/wiki/spaces/~1234/pages/<<1234>>/My+Parent+Page` | true |
+| `space-key`           | Confluence space key to publish the documentation. Located after `spaces` in the URL. `https://mydomain.atlassian.net/wiki/spaces/<<~1234>>`. <br> Or in _Space settings_ > _Space details_ > _Key_. | true |
+| `parent-page-id`      | Page id under which the documentation will be published. Located after `pages` in the URL. `https://mydomain.atlassian.net/wiki/spaces/~1234/pages/<<1234>>/My+Parent+Page` | true |
 
 ## TODO
 
@@ -48,7 +48,7 @@ jobs:
           username: abc@xyz.com
           password: ${{ secrets.API_TOKEN }}
           confluence-base-url: https://mydomain.atlassian.net/wiki
-          space-id: ~1234
+          space-key: ~1234
           parent-page-id: 123456789
 ```
 

action.yml

@@ -17,8 +17,8 @@ inputs:
   confluence-base-url:
     description: "Your Confluence url"
     required: true
-  space-id:
-    description: "Confluence space id to publish the documentation"
+  space-key:
+    description: "Confluence space key to publish the documentation"
     required: true
   parent-page-id:
     description: "Page id under which the documentation will be published"

confluence.js

@@ -1,13 +1,13 @@
 class SyncConfluence {
-  constructor(confluenceApi, spaceId) {
-    this.spaceId = spaceId;
+  constructor(confluenceApi, spaceKey) {
+    this.spaceKey = spaceKey;
     this.confluenceApi = confluenceApi;
   }
 
   getPageIdByTitle(title) {
     return new Promise((resolve) => {
       this.confluenceApi.getContentByPageTitle(
-        this.spaceId,
+        this.spaceKey,
         title,
         (err, data) => {
           if (err) {
@@ -37,7 +37,7 @@ class SyncConfluence {
   createEmptyParentPage(title, parentId) {
     return new Promise((resolve) => {
       this.confluenceApi.postContent(
-        this.spaceId,
+        this.spaceKey,
         title,
         "",
         parentId,
@@ -55,7 +55,7 @@ class SyncConfluence {
   putContent(pageId, title, content) {
     this.getPageVersion(pageId, (version) => {
       this.confluenceApi.putContent(
-        this.spaceId,
+        this.spaceKey,
         pageId,
         version + 1,
         title,
@@ -74,7 +74,7 @@ class SyncConfluence {
   getAttachments(pageId) {
     return new Promise((resolve) => {
       this.confluenceApi.getAttachments(
-          this.spaceId,
+          this.spaceKey,
           pageId,
           (err, data) => {
             if (err) {
@@ -94,7 +94,7 @@ class SyncConfluence {
   updateAttachment(pageId, attachmentId, source) {
     return new Promise((resolve) => {
       this.confluenceApi.updateAttachmentData(
-          this.spaceId,
+          this.spaceKey,
           pageId,
           attachmentId,
           source,
@@ -116,7 +116,7 @@ class SyncConfluence {
   uploadAttachment(pageId, source) {
     return new Promise((resolve) => {
       this.confluenceApi.createAttachment(
-          this.spaceId,
+          this.spaceKey,
           pageId,
           source,
           (err, data) => {

index.js

@@ -7,7 +7,7 @@ const parser = require("node-html-parser")
 const path = require('path')
 
 const root = "./" + core.getInput("folder", { required: true }) + "/";
-const spaceId = core.getInput("space-id", { required: true });
+const spaceKey = core.getInput("space-key", { required: true });
 const rootParentPageId = core.getInput("parent-page-id", { required: true });
 
 const config = {
@@ -19,7 +19,7 @@ const config = {
 const confluenceAPI = new Confluence(config);
 const syncConfluence = new SyncConflence(
   confluenceAPI,
-  spaceId,
+  spaceKey,
   rootParentPageId
 );