-
Bug
-
Resolution: Fixed
-
Low
-
None
-
Severity 3 - Minor
-
The example for the endpoint /rest/api/3/search in the Jira Cloud REST API documentation is incomplete:
Indeed, the provided example is the below one:
curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
However, the above example is missing to show the actual JQL query (url encoded) to be added after the jql parameter.
The example should be corrected and the JQL parameter should be added to the url. Something like (project = Test Project"):
curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search?jql=project%20%3D%20"Test%20Project"' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
- is related to
-
-
- Closed
-
- is duplicated by
-
DXD-118 Failed to load
[JRACLOUD-70163] The /rest/api/3/search endpoint example is missing the search parameter
| Comment |
[ Due to an extended period of inactivity and low interest this bug has been auto-closed. If you’re still experiencing this issue, please comment and we’ll re-open to triage.
Cheers, Dylan - Service Enablement @ Atlassian ] |
| Resolution | Original: Won't Fix [ 2 ] | New: Fixed [ 1 ] |
| Status | Original: Closed [ 6 ] | New: Closed [ 6 ] |
| Resolution | New: Won't Fix [ 2 ] | |
| Status | Original: Gathering Impact [ 12072 ] | New: Closed [ 6 ] |
| Workflow | Original: JIRA Bug Workflow w Kanban v6 - Restricted [ 2810765 ] | New: JAC Bug Workflow v3 [ 3358857 ] |
| Status | Original: Verified [ 10005 ] | New: Gathering Impact [ 12072 ] |
| Link |
New:
This issue is related to |
| Remote Link | New: This issue links to "DXD-118 (Ecosystem JIRA)" [ 393175 ] |
| Component/s | New: Ecosystem [ 53294 ] | |
| Component/s | Original: Ecosystem - REST API [ 46576 ] |
| Status | Original: Open [ 1 ] | New: Verified [ 10005 ] |
| Assignee | Original: Sarah Karp [ skarp ] | New: Andrew [ alui ] |
| Description |
Original:
The example for the endpoint /rest/api/3/search in the Jira Cloud REST API documentation is incomplete: - [Search for issues using JQL (GET)|https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-search-get] Indeed, the provided example is the below one: {noformat} curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' {noformat} However, the above example is missing to show the actual JQL query (url encoded) to be added after the *jql* parameter. The example should be corrected and the JQL parameter should be added to the url. Something like (project = Test Project"): {noformat} curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search?jql=project%20%3D%20"Test%20Project"' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' {noformat} |
New:
The example for the endpoint /rest/api/3/search in the Jira Cloud REST API documentation is incomplete:
- [Search for issues using JQL (GET)|https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-search-get] Indeed, the provided example is the below one: {noformat} curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' {noformat} However, the above example is missing to show the actual JQL query (url encoded) to be added after the *jql* parameter. The example should be corrected and the JQL parameter should be added to the url. Something like (project = Test Project"): {noformat} curl --request GET \ --url 'https://your-domain.atlassian.net/rest/api/3/search?jql=project%20%3D%20"Test%20Project"' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' {noformat} |