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.
# 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 Project Key and Name…
version: 1.0.0
extends: openapi/atlassian-project-key-and-name-validation-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: 3
- target: $.paths['/rest/api/3/projectvalidate/key'].get
update:
x-apievangelist-phrasing:
intent: Check whether a project key is valid
effect: read
questions:
- Is a Jira project key already taken?
- Does a proposed project key follow the allowed format?
instructions:
- text: Validate project key {key}.
slots:
key: query.key
- text: Tell me if {key} is a usable, unused project key.
slots:
key: query.key
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectvalidate/validProjectKey'].get
update:
x-apievangelist-phrasing:
intent: Get a valid project key suggestion
effect: read
questions:
- Can Jira suggest an alternative project key if mine is taken?
- What key will Jira generate when my proposed one is invalid?
instructions:
- text: Give me a valid project key based on {key}.
slots:
key: query.key
- text: Suggest a free project key if {key} is already used.
slots:
key: query.key
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectvalidate/validProjectName'].get
update:
x-apievangelist-phrasing:
intent: Get a valid, unused project name
effect: read
questions:
- Is a project name already in use in Jira?
- Will Jira suggest a numbered variant if my project name is taken?
instructions:
- text: Check project name {name} and suggest a free one if needed.
slots:
name: query.name
- text: Get an available project name based on {name}.
slots:
name: query.name
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.