Forge Atlas Fetch - Documentation
Integrate with any Atlassian Product API using simple and typed javascript / typescript commands.
Getting started
The client lets you interact with the following Atlassian products:
- Confluence
- Jira
And interact either:
- as the logged-in User
- as the App itself
Installation
Install via:
- npm
npm install --save forge-atlas-fetch
- yarn
yarn add forge-atlas-fetch
Update your existing Forge app config
- install
webpack
yarn add --dev ts-loader webpack webpack-cli
- add the following
webpack.config.js
at the root of your Forge app:
const path = ; moduleexports = entry: './src/index.tsx' target: 'node' module: rules: test: /\.tsx?$/ use: 'ts-loader' exclude: /node_modules/ resolve: extensions: '.tsx' '.ts' '.js' output: filename: 'index.js' library: '' libraryTarget: 'commonjs' path: path ;
- change your
package.json
build step to:
"build": "webpack",
Usage in your Forge app
Forge Confluence client
Sample query
;; const fetchContent = async contentId: Promise<Content> return await contentresults;;
Full documentation available here
Forge Jira client
Sample query
;; const fetchIssue = async issueKey: Promise<IssueBean> return await ;;
Full documentation available here