https://github.com/jromero/jira-bulletins

A JIRA plugin that adds project specific bulletin boards to your JIRA agile boards.
https://github.com/jromero/jira-bulletins

Last synced: about 1 month ago
JSON representation

A JIRA plugin that adds project specific bulletin boards to your JIRA agile boards.

• Host: GitHub
• URL: https://github.com/jromero/jira-bulletins
• Owner: jromero
• License: mit
• Created: 2016-06-01T21:42:19.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-29T20:37:10.000Z (about 8 years ago)
• Last Synced: 2024-10-13T11:11:00.636Z (3 months ago)
• Language: TypeScript
• Size: 77.1 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Development

## Getting Started

### Initial Setup

 - Setup [Atlassian SDK](https://developer.atlassian.com/docs/getting-started)

 - Clone repo to your machine

 - Execute `atlas-run` in project root

 - Install Add-on **JIRA Agile** (trial)

   * Registration might be required

 - Create an Agile Project

### Making Changes

 - First, ensure you can go to the Agile board for the project and you can see the *Bulletin Board*'s handle.

 - HACK, HACK, HACK...

 - Execute `mvn package`

   * Your IDE might have some UI around this

 - The changes should be automatically be picked up by a page refresh

## API

    BASE_URL = {HOST}/rest/bulletins/1

### Bulletins

##### GET

###### Request

    GET {BASE_URL}/boards/{PROJECT_KEY}/bulletins

###### Response

**200**

````json

{

    "count": 100,

    "totalCount": 100,

    "bulletins": [

        {

            "id": 1,

            "body": "...",

            "rendered": "...",

            "createdBy": "",

            "createdAt": 1464542825266,

            "updatedAt": 1464542825266

        }

    ]

}

````

###### Request

    GET {BASE_URL}/boards/{PROJECT_KEY}/bulletins/{ID}

###### Response

**200**

````json

{

    "id": 1,

    "body": "...",

    "rendered": "...",

    "createdBy": "",

    "createdAt": 1464542825266,

    "updatedAt": 1464542825266

}

````

##### POST

###### Request

    POST {BASE_URL}/boards/{PROJECT_KEY}/bulletins

````json

{

    "body": "..."

}

````

###### Response

**200**

````json

{

    "id": 1,

    "body": "...",

    "rendered": "...",

    "createdBy": "",

    "createdAt": 1464542825266,

    "updatedAt": 1464542825266

}

````

##### DELETE

###### Request

    DELETE {BASE_URL}/boards/{PROJECT_KEY}/bulletins/{ID}

###### Response

**200**

````json

{

    "message": "OK"

}

````

### Markdown

##### POST

###### Request

    POST {BASE_URL}/markdown

````json

{

    "markdown": "..."

}

````

###### Response

**200**

````json

{

    "html": "..."

}

````