Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Link Types API

6 actions 6 updates phrasing extends openapi/atlassian-issue-link-types-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/rest/api/3/issueLinkType'].get

$.paths['/rest/api/3/issueLinkType'].post

$.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].get

$.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].put

$.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Link Types API
  version: 1.0.0
extends: openapi/atlassian-issue-link-types-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/rest/api/3/issueLinkType'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue link types
      effect: read
      questions:
      - What kinds of links, like blocks or duplicates, can I create between issues?
      - Which issue link types are configured in my Jira site?
      instructions:
      - text: List all issue link types.
      - text: Show every relationship type available for linking issues.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLinkType'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue link type
      effect: write
      questions:
      - How do I add a new kind of relationship between Jira issues?
      - Can I define separate inward and outward wording for a link type?
      instructions:
      - text: Create link type {name} with outward {outward} and inward {inward}.
        slots:
          name: requestBody.name
          outward: requestBody.outward
          inward: requestBody.inward
      - text: Add an issue link type called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue link type
      effect: read
      questions:
      - What are the inward and outward descriptions for one link type?
      - Can I look up a single issue link type by its ID?
      instructions:
      - text: Get issue link type {issueLinkTypeId}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
      - text: Show the wording of link type {issueLinkTypeId}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue link type
      effect: write
      questions:
      - How do I rename an issue link type?
      - Can I change the inward description on an existing link type?
      instructions:
      - text: Rename issue link type {issueLinkTypeId} to {name}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
          name: requestBody.name
      - text: Change link type {issueLinkTypeId}'s inward text to {inward}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
          inward: requestBody.inward
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLinkType/{issueLinkTypeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue link type
      effect: destructive
      questions:
      - How do I remove a link type we don't use anymore?
      - Can I delete an issue link type if issue linking is disabled?
      instructions:
      - text: Delete issue link type {issueLinkTypeId}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
      - text: Remove the unused link type {issueLinkTypeId}.
        slots:
          issueLinkTypeId: path.issueLinkTypeId
      method: generated
      generated: '2026-10-01'