Cosense icon

Cosense

Read and write pages in Cosense (formerly Scrapbox)
Join our community

Actions15

Overview

This node interacts with Cosense (formerly Scrapbox) to manage and retrieve information about pages within a project. Specifically, the "Get Commits" operation under the "Page" resource fetches the commit history of a specified page in a given project. This is useful for tracking changes, auditing edits, or understanding the evolution of content on a page.

Practical examples include:

  • Reviewing all changes made to a documentation page over time.
  • Auditing contributions by different users on a project page.
  • Integrating commit history into workflows that require version tracking or change notifications.

Properties

Name Meaning
Project Name The name of your Cosense/Scrapbox project where the page resides.
Page Title The title of the page whose commit history you want to retrieve.

Output

The output json field contains an array of commit objects representing the commit history of the specified page. Each commit object typically includes details such as commit identifiers, timestamps, authorship, and possibly descriptions of the changes made.

Since this operation deals with textual commit data, there is no binary output.

Example structure (simplified):

[
  {
    "commitId": "abc123",
    "author": "username",
    "timestamp": "2024-01-01T12:00:00Z",
    "message": "Fixed typo in section"
  },
  {
    "commitId": "def456",
    "author": "anotheruser",
    "timestamp": "2024-01-02T15:30:00Z",
    "message": "Added new paragraph"
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Cosense API.
  • The node depends on the external Cosense API client library bundled with the node.
  • Proper configuration of the API key credential in n8n is necessary for successful requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect project name or page title may result in "page not found" errors.
    • Network connectivity problems can lead to request timeouts or failures.

  • Error messages:

    • "Page not found": Verify that the project name and page title are correct and that the page exists.
    • "Authentication failed": Check that the API key credential is correctly configured and valid.
    • "Request timed out": Ensure network connectivity and try again later.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring network access.

Links and References

Discussion