https://github.com/teamapis/jira-platform

Jira Cloud Platform (v3) API schema over time.
https://github.com/teamapis/jira-platform

atlassian atlassian-jira cloud jira-rest-api openapi-spec

Last synced: about 1 month ago
JSON representation

Jira Cloud Platform (v3) API schema over time.

• Host: GitHub
• URL: https://github.com/teamapis/jira-platform
• Owner: teamapis
• License: apache-2.0
• Created: 2022-08-26T20:36:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-01T16:33:32.000Z (over 2 years ago)
• Last Synced: 2024-10-21T05:21:41.528Z (2 months ago)
• Topics: atlassian, atlassian-jira, cloud, jira-rest-api, openapi-spec
• Homepage:
• Size: 2.13 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jira Cloud Platform API Spec

> The Jira Cloud Platform API schema over time.

![Atlassian Jira Cloud Platform](assets/[email protected])

The Atlassian Jira Cloud Platform API documentation is located [here](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/) on the Atlassian Developer website.

This **unofficial** repository aims to document the small (or large) changes to the API specification provided by Atlassian for this API.

## What's Here

* `schema-original.json`

  The original json file we downloaded from Atlassian.

* `schema.json`

  A pretty-printed version of `schema-original.json`

* `schema.yaml`

  A YAML representation of `schema.json`

* `modular/`

  A modular version of the API, broken up into multiple YAML files.

## How it works

1. We check the schema regularly for changes.

2. When a change occurs, we update the repository with those changes.

3. We create a release based on when we noticed the change.

Releases are named based on the date **we** first saw the schema change—they are *not* official release names from Atlassian's perspective.

## Thanks

This repository is sponsored by [Loveless Labs](https://lovelesslabs.com).

![Loveless Labs](assets/loveless-labs-big-transparent.png)

Furthermore, thanks to:

* [Redocly](https://redocly.com/) for the handy [redocly split](https://redocly.com/docs/cli/commands/split/) tool.

* The good folks at the [OpenAPI Initiative](https://www.openapis.org/)

* And of course, [Atlassian](https://developer.atlassian.com/) for providing the source specs.

### Disclaimers

Use the information here at your own risk. It may be out of date, inaccurate, or otherwise horribly broken. (Obviously, we're trying to make it accurate!) Contributors to this repository are not responsible for any problems that may arise from the use of the information contained within. We just thought it would be helpful, and thought you might find it useful also.