openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 162 kB

JSON

{"openapi":"3.0.0","x-hasEquivalentPaths":true,"info":{"contact":{"x-twitter":"Atlassian"},"title":"JIRA 7.6.1","version":"1.0.0","x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://twitter.com/Atlassian/profile_image?size=original"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"wadl","url":"https://docs.atlassian.com/jira/REST/server/jira-rest-plugin.wadl","version":"1.0"}],"x-providerName":"jira.local"},"paths":{"/api/2/application-properties":{"get":{"description":"Returns an application property.","parameters":[{"description":"a String containing the property key","in":"query","name":"key","required":false,"schema":{"type":"string"}},{"description":"when fetching a list specifies the permission level of all items in the list\n see {@link com.atlassian.jira.bc.admin.ApplicationPropertiesService.EditPermissionLevel}","in":"query","name":"permissionLevel","required":false,"schema":{"type":"string"}},{"description":"when fetching a list allows the list to be filtered by the property's start of key\n e.g. \"jira.lf.*\" whould fetch only those permissions that are editable and whose keys start with\n \"jira.lf.\". This is a regex.","in":"query","name":"keyFilter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/application-properties/advanced-settings":{"get":{"description":"Returns the properties that are displayed on the \"General Configuration > Advanced Settings\" page.","operationId":"getAdvancedSettings","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/application-properties/{id}":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"description":"Modify an application property via PUT. The \"value\" field present in the PUT will override the existing value.","operationId":"setPropertyViaRestfulTable","responses":{"200":{"description":"Successful Response"}}}},"/api/2/applicationrole":{"get":{"description":"Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the\n collection of ApplicationRoles.","operationId":"getAll","responses":{"200":{"description":"Successful Response"}}},"parameters":[],"put":{"description":"Updates the ApplicationRoles with the passed data if the version hash is the same as the server.\n Only the groups and default groups setting of the role may be updated. Requests to change the key\n or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated\n as roles that are present in the server but not in data to update with, will not be deleted.","operationId":"putBulk","parameters":[{"in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/applicationrole/{key}":{"get":{"description":"Returns the ApplicationRole with passed key if it exists.","operationId":"get","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the key of the role to update.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the\n role may be updated. Requests to change the key or the name of the role will be silently ignored.\n \n Optional: If versionHash is passed through the If-Match header the request will be rejected if not the\n same as server","operationId":"put","parameters":[{"description":"the hash of the version to update. Optional Param","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/attachment/meta":{"get":{"description":"Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size\n allowed.","operationId":"getAttachmentMeta","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/attachment/{id}":{"delete":{"description":"Remove an attachment from an issue.","operationId":"removeAttachment","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns the meta-data for an attachment, including the URI of the actual attached file.","operationId":"getAttachment","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"id of the attachment to remove","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/attachment/{id}/expand/human":{"get":{"description":"Tries to expand an attachment. Output is human-readable and subject to change.","operationId":"expandForHumans","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the id of the attachment to expand.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/attachment/{id}/expand/raw":{"get":{"description":"Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.","operationId":"expandForMachines","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the id of the attachment to expand.","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/auditing/record":{"get":{"description":"Returns auditing records filtered using provided parameters","operationId":"getRecords","parameters":[{"description":"- the number of record from which search starts","in":"query","name":"offset","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"- maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"- text query; each record that will be returned must contain the provided text in one of its fields","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or after the 'from' timestamp will be provided in response","in":"query","name":"from","required":false,"schema":{"type":"string"}},{"description":"- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response","in":"query","name":"to","required":false,"schema":{"type":"string"}},{"description":"- list of project ids to look for","in":"query","name":"projectIds","required":false,"schema":{"type":"string"}},{"description":"- list of user ids to look for","in":"query","name":"userIds","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[],"post":{"description":"Store a record in Audit Log","operationId":"addRecord","responses":{"200":{"description":"Successful Response"}}}},"/api/2/avatar/{type}/system":{"get":{"description":"Returns all system avatars of the given type.","operationId":"getAllSystemAvatars","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the avatar type","in":"path","name":"type","required":true,"schema":{"type":"string"}}]},"/api/2/avatar/{type}/temporary":{"parameters":[{"description":"the avatar type","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates temporary avatar","operationId":"storeTemporaryAvatar","parameters":[{"description":"name of file being uploaded","in":"query","name":"filename","required":false,"schema":{"type":"string"}},{"description":"size of file","in":"query","name":"size","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/avatar/{type}/temporaryCrop":{"parameters":[{"description":"the avatar type","in":"path","name":"type","required":true,"schema":{"type":"string"}}],"post":{"description":"Updates the cropping instructions of the temporary avatar.","responses":{"200":{"description":"Successful Response"}}}},"/api/2/cluster/zdu/approve":{"parameters":[],"post":{"operationId":"approveUpgrade","responses":{"200":{"description":"Successful Response"}}}},"/api/2/cluster/zdu/cancel":{"parameters":[],"post":{"operationId":"cancelUpgrade","responses":{"200":{"description":"Successful Response"}}}},"/api/2/cluster/zdu/retryUpgrade":{"parameters":[],"post":{"operationId":"acknowledgeErrors","responses":{"200":{"description":"Successful Response"}}}},"/api/2/cluster/zdu/start":{"parameters":[],"post":{"operationId":"setReadyToUpgrade","responses":{"200":{"description":"Successful Response"}}}},"/api/2/cluster/zdu/state":{"get":{"operationId":"getState","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/comment/{commentId}/properties":{"get":{"description":"Returns the keys of all properties for the comment identified by the key or by the id.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the comment from which keys will be returned.","in":"path","name":"commentId","required":true,"schema":{"type":"string"}}]},"/api/2/comment/{commentId}/properties/{propertyKey}":{"delete":{"description":"Removes the property from the comment identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the comment.","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves\n the property is required to have permissions to read the comment.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the comment from which keys will be returned.","in":"path","name":"commentId","required":true,"schema":{"type":"string"}},{"description":"the key of the property to return.","in":"path","name":"propertyKey","required":true,"schema":{"type":"string"}}],"put":{"description":"Sets the value of the specified comment's property.\n \n You can use this resource to store a custom data against the comment identified by the key or by the id. The user\n who stores the data is required to have permissions to administer the comment.\n ","responses":{"200":{"description":"Successful Response"}}}},"/api/2/component":{"parameters":[],"post":{"description":"Create a component via POST.","operationId":"createComponent","responses":{"200":{"description":"Successful Response"}}}},"/api/2/component/{id}":{"delete":{"description":"Delete a project component.","parameters":[{"description":"The new component applied to issues whose 'id' component will be deleted.\n If this value is null, then the 'id' component is simply removed from the related isues.","in":"query","name":"moveIssuesTo","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns a project component.","operationId":"getComponent","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"The component to delete.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"description":"Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field\n is not present, it is silently ignored.\n \n If leadUserName is an empty string (\"\") the component lead will be removed.","operationId":"updateComponent","responses":{"200":{"description":"Successful Response"}}}},"/api/2/component/{id}/relatedIssueCounts":{"get":{"description":"Returns counts of issues related to this component.","operationId":"getComponentRelatedIssues","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"a String containing the component id","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/configuration":{"get":{"description":"Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled,\n it also returns the detailed information about time tracking configuration.","operationId":"getConfiguration","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/customFieldOption/{id}":{"get":{"description":"Returns a full representation of the Custom Field Option that has the given id.","operationId":"getCustomFieldOption","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"a String containing an Custom Field Option id","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/dashboard":{"get":{"description":"Returns a list of all dashboards, optionally filtering them.","operationId":"list","parameters":[{"description":"an optional filter that is applied to the list of dashboards. Valid values include\n <code>\"favourite\"</code> for returning only favourite dashboards, and <code>\"my\"</code> for returning\n dashboards that are owned by the calling user.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"the index of the first dashboard to return (0-based). must be 0 or a multiple of\n <code>maxResults</code>","in":"query","name":"startAt","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"a hint as to the the maximum number of dashboards to return in each call. Note that the\n JIRA server reserves the right to impose a <code>maxResults</code> limit that is lower than the value that a\n client provides, dues to lack or resources or any other condition. When this happens, your results will be\n truncated. Callers should always check the returned <code>maxResults</code> to determine the value that is\n effectively being used.","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/dashboard/{dashboardId}/items/{itemId}/properties":{"get":{"description":"Returns the keys of all properties for the dashboard item identified by the id.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the dashboard item from which keys will be returned.","in":"path","name":"itemId","required":true,"schema":{"type":"string"}},{"in":"path","name":"dashboardId","required":true,"schema":{"type":"string"}}]},"/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}":{"delete":{"description":"Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the dashboard item.","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns the value of the property with a given key from the dashboard item identified by the id.\n The user who retrieves the property is required to have permissions to read the dashboard item.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the dashboard item from which keys will be returned.","in":"path","name":"itemId","required":true,"schema":{"type":"string"}},{"in":"path","name":"dashboardId","required":true,"schema":{"type":"string"}},{"description":"the key of the property to return.","in":"path","name":"propertyKey","required":true,"schema":{"type":"string"}}],"put":{"description":"Sets the value of the specified dashboard item's property.\n \n You can use this resource to store a custom data against the dashboard item identified by the id.\n The user who stores the data is required to have permissions to administer the dashboard item.\n ","responses":{"200":{"description":"Successful Response"}}}},"/api/2/dashboard/{id}":{"get":{"description":"Returns a single dashboard.","operationId":"getDashboard","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the dashboard id","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"/api/2/field":{"get":{"description":"Returns a list of all fields, both System and Custom","operationId":"getFields","responses":{"200":{"description":"Successful Response"}}},"parameters":[],"post":{"description":"Creates a custom field using a definition (object encapsulating custom field data)","operationId":"createCustomField","responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter":{"parameters":[],"post":{"description":"Creates a new filter, and returns newly created filter.\n Currently sets permissions just using the users default sharing permissions","operationId":"createFilter","parameters":[{"description":"the parameters to expand","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter/defaultShareScope":{"get":{"description":"Returns the default share scope of the logged-in user.","operationId":"getDefaultShareScope","responses":{"200":{"description":"Successful Response"}}},"parameters":[],"put":{"description":"Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.","operationId":"setDefaultShareScope","responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter/favourite":{"get":{"description":"Returns the favourite filters of the logged-in user.","operationId":"getFavouriteFilters","parameters":[{"description":"the parameters to expand","in":"query","name":"expand","required":false,"schema":{"type":"string"}},{"description":"enable calculating shared users collection","in":"query","name":"enableSharedUsers","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/filter/{id}":{"delete":{"description":"Delete a filter.","operationId":"deleteFilter","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns a filter given an id","operationId":"getFilter","parameters":[{"description":"the parameters to expand","in":"query","name":"expand","required":false,"schema":{"type":"string"}},{"description":"enable calculating shared users collection","in":"query","name":"enableSharedUsers","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the id of the filter being looked up","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"put":{"description":"Updates an existing filter, and returns its new value.","operationId":"editFilter","parameters":[{"description":"the parameters to expand","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter/{id}/columns":{"delete":{"description":"Resets the columns for the given filter such that the filter no longer has its own column config.","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns the default columns for the given filter. Currently logged in user will be used as\n the user making such request.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"id of the filter","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"put":{"description":"Sets the default columns for the given filter.","responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter/{id}/permission":{"get":{"description":"Returns all share permissions of the given filter.","operationId":"getSharePermissions","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"post":{"description":"Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.","operationId":"addSharePermission","responses":{"200":{"description":"Successful Response"}}}},"/api/2/filter/{id}/permission/{permission-id}":{"delete":{"description":"Removes a share permissions from the given filter.","operationId":"deleteSharePermission","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"permission-id","required":true,"schema":{"type":"integer","format":"int64"}}]},"/api/2/filter/{id}/permission/{permissionId}":{"get":{"description":"Returns a single share permission of the given filter.","operationId":"getSharePermission","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"in":"path","name":"permissionId","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}]},"/api/2/group":{"delete":{"description":"Deletes a group by given group parameter.\n \n Returns no content","operationId":"removeGroup","parameters":[{"description":"(mandatory) The name of the group to delete.","in":"query","name":"groupname","required":false,"schema":{"type":"string"}},{"description":"If you delete a group and content is restricted to that group, the content will be hidden from all users. \n To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.","in":"query","name":"swapGroup","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns REST representation for the requested group. Allows to get list of active users belonging to the\n specified group and its subgroups if \"users\" expand option is provided. You can page through users list by using\n indexes in expand param. For example to get users from index 10 to index 15 use \"users[10:15]\" expand value. This\n will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.\n \n This resource is deprecated, please use group/member API instead.","operationId":"getGroup","parameters":[{"description":"A name of requested group.","in":"query","name":"groupname","required":false,"schema":{"type":"string"}},{"description":"List of fields to expand. Currently only available expand is \"users\".","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[],"post":{"description":"Creates a group by given group parameter\n \n Returns REST representation for the requested group.","operationId":"createGroup","responses":{"200":{"description":"Successful Response"}}}},"/api/2/group/member":{"get":{"description":"This resource returns a <a href=\"#pagination\">paginated</a> list of users who are members of the specified group and its subgroups.\n Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.","operationId":"getUsersFromGroup","parameters":[{"description":"a name of the group for which members will be returned.","in":"query","name":"groupname","required":false,"schema":{"type":"string"}},{"description":"inactive users will be included in the response if set to true.","in":"query","name":"includeInactiveUsers","required":false,"schema":{"type":"boolean","default":false}},{"description":"the index of the first user in group to return (0 based).","in":"query","name":"startAt","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"description":"the maximum number of users to return (max 50).","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/group/user":{"delete":{"description":"Removes given user from a group.\n \n Returns no content","operationId":"removeUserFromGroup","parameters":[{"description":"A name of requested group.","in":"query","name":"groupname","required":false,"schema":{"type":"string"}},{"description":"User to remove from a group","in":"query","name":"username","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[],"post":{"description":"Adds given user to a group.\n \n Returns the current state of the group.","operationId":"addUserToGroup","parameters":[{"description":"A name of requested group.","in":"query","name":"groupname","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/groups/picker":{"get":{"description":"Returns groups with substrings matching a given query. This is mainly for use with\n the group picker, so the returned groups contain html to be used as picker suggestions.\n The groups are also wrapped in a single response object that also contains a header for\n use in the picker, specifically Showing X of Y matching groups.\n \n The number of groups returned is limited by the system property \"jira.ajax.autocomplete.limit\"\n \n The groups will be unique and sorted.","operationId":"findGroups","parameters":[{"description":"a String to match groups agains","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"in":"query","name":"exclude","required":false,"schema":{"type":"string"}},{"in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/groupuserpicker":{"get":{"description":"Returns a list of users and groups matching query with highlighting. This resource cannot be accessed\n anonymously.","operationId":"findUsersAndGroups","parameters":[{"description":"A string used to search username, Name or e-mail address","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If\n you specify a value that is higher than this number, your search results will be truncated.","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"showAvatar","required":false,"schema":{"type":"boolean"}},{"description":"The custom field id, if this request comes from a custom field, such as a user picker. Optional.","in":"query","name":"fieldId","required":false,"schema":{"type":"string"}},{"description":"The list of project ids to further restrict the search\n This parameter can occur multiple times to pass in multiple project ids.\n Comma separated value is not supported.\n This parameter is only used when fieldId is present.","in":"query","name":"projectId","required":false,"schema":{"type":"string"}},{"description":"The list of issue type ids to further restrict the search.\n This parameter can occur multiple times to pass in multiple issue type ids.\n Comma separated value is not supported.\n Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported.\n This parameter is only used when fieldId is present.","in":"query","name":"issueTypeId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/index/summary":{"get":{"description":"Summarizes index condition of current node.\n \n Returned data consists of:\n <ul>\n <li><code>nodeId</code> - Node identifier.</li>\n <li><code>reportTime</code> - Time of this report creation.</li>\n <li><code>issueIndex</code> - Summary of issue index status.</li>\n <li><code>replicationQueues</code> - Map of index replication queues, where\n keys represent nodes from which replication operations came from.</li>\n </ul>\n \n <code>issueIndex</code> can contain:\n <ul>\n <li><code>indexReadable</code> - If <code>false</code> the end point failed to read data from issue index\n (check JIRA logs for detailed stack trace), otherwise <code>true</code>.\n When <code>false</code> other fields of <code>issueIndex</code> can be not visible.</li>\n <li><code>countInDatabase</code> - Count of issues found in database.</li>\n <li><code>countInIndex</code> - Count of issues found while querying index.</li>\n <li><code>lastUpdatedInDatabase</code> - Time of last update of issue found in database.</li>\n <li><code>lastUpdatedInIndex</code> - Time of last update of issue found while querying index.</li>\n </ul>\n \n <code>replicationQueues</code>'s map values can contain:\n <ul>\n <li><code>lastConsumedOperation</code> - Last executed index replication operation by current node from sending node's queue.</li>\n <li><code>lastConsumedOperation.id</code> - Identifier of the operation.</li>\n <li><code>lastConsumedOperation.replicationTime</code> - Time when the operation was sent to other nodes.</li>\n <li><code>lastOperationInQueue</code> - Last index replication operation in sending node's queue.</li>\n <li><code>lastOperationInQueue.id</code> - Identifier of the operation.</li>\n <li><code>lastOperationInQueue.replicationTime</code> - Time when the operation was sent to other nodes.</li>\n <li><code>queueSize</code> - Number of operations in queue from sending node to current node.</li>\n </ul>","operationId":"getIndexSummary","responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/issue":{"parameters":[],"post":{"description":"Creates an issue or a sub-task from a JSON representation.\n \n The fields that can be set on create, in either the fields parameter or the update parameter can be determined\n using the /rest/api/2/issue/createmeta resource.\n If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field\n validation error will occur if it is submitted.\n \n Creating a sub-task is similar to creating a regular issue, with two important differences:\n <ul>\n <li>the <code>issueType</code> field must correspond to a sub-task issue type (you can use\n <code>/issue/createmeta</code> to discover sub-task issue types), and</li>\n <li>you must provide a <code>parent</code> field in the issue create request containing the id or key of the\n parent issue.</li>\n </ul>","operationId":"createIssue","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/bulk":{"parameters":[],"post":{"description":"Creates issues or sub-tasks from a JSON representation.\n \n Creates many issues in one bulk operation.\n \n Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section:\n {@link IssueResource#createIssue(IssueUpdateBean)}}","operationId":"createIssues","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/createmeta":{"get":{"description":"Returns the meta data for creating issues. This includes the available projects, issue types and fields,\n including field types and whether or not those fields are required.\n Projects will not be returned if the user does not have permission to create issues in that project.\n \n The fields in the createmeta correspond to the fields in the create screen for the project/issuetype.\n Fields not in the screen will not be in the createmeta.\n \n Fields will only be returned if <code>expand=projects.issuetypes.fields</code>.\n \n The results can be filtered by project and/or issue type, given by the query params.","operationId":"getCreateIssueMeta","parameters":[{"description":"combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned.\n This parameter can be specified multiple times, and/or be a comma-separated list.\n Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.","in":"query","name":"projectIds","required":false,"schema":{"type":"string"}},{"description":"combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned.\n This parameter can be specified multiple times, and/or be a comma-separated list.\n Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.","in":"query","name":"projectKeys","required":false,"schema":{"type":"string"}},{"description":"combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned.\n This parameter can be specified multiple times, and/or be a comma-separated list.\n Specifiying an issue type that does not exist is not an error.","in":"query","name":"issuetypeIds","required":false,"schema":{"type":"string"}},{"description":"combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned.\n This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list.\n Specifiying an issue type that does not exist is not an error.","in":"query","name":"issuetypeNames","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/issue/picker":{"get":{"description":"Returns suggested issues which match the auto-completion query for the user which executes this request. This REST\n method will check the user's history and the user's browsing context and select this issues, which match the query.","operationId":"getIssuePickerResource","parameters":[{"description":"the query.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results.","in":"query","name":"currentJQL","required":false,"schema":{"type":"string"}},{"description":"the key of the issue in context of which the request is executed. The issue which is in context will not be included in the auto-completion result, even if it matches the query.","in":"query","name":"currentIssueKey","required":false,"schema":{"type":"string"}},{"description":"the id of the project in context of which the request is executed. Suggested issues will be only from this project.","in":"query","name":"currentProjectId","required":false,"schema":{"type":"string"}},{"description":"if set to false, subtasks will not be included in the list.","in":"query","name":"showSubTasks","required":false,"schema":{"type":"boolean"}},{"description":"if set to false and request is executed in context of a subtask, the parent issue will not be included in the auto-completion result, even if it matches the query.","in":"query","name":"showSubTaskParent","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[]},"/api/2/issue/{issueIdOrKey}":{"delete":{"description":"Delete an issue.\n \n If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue.\n You cannot delete an issue without its subtasks also being deleted.","operationId":"deleteIssue","parameters":[{"description":"a String of true or false indicating that any subtasks should also be deleted. If the\n issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false,\n then the issue will not be deleted and an error will be returned.","in":"query","name":"deleteSubtasks","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns a full representation of the issue for the given issue key.\n \n An issue JSON consists of the issue key, a collection of fields,\n a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it\n (e.g. if wiki syntax is enabled for the description or comments).\n \n The <code>fields</code> param (which can be specified multiple times) gives a comma-separated list of fields\n to include in the response. This can be used to retrieve a subset of fields.\n A particular field can be excluded by prefixing it with a minus.\n \n By default, all (<code>*all</code>) fields are returned in this get-issue resource. Note: the default is different\n when doing a jql search -- the default there is just navigable fields (<code>*navigable</code>).\n <ul>\n <li><code>*all</code> - include all fields</li>\n <li><code>*navigable</code> - include just navigable fields</li>\n <li><code>summary,comment</code> - include just the summary and comments</li>\n <li><code>-comment</code> - include everything except comments (the default is <code>*all</code> for get-issue)</li>\n <li><code>*all,-comment</code> - include everything except comments</li>\n </ul>\n \n The {@code properties} param is similar to {@code fields} and specifies a comma-separated list of issue\n properties to include. Unlike {@code fields}, properties are not included by default. To include them all\n send {@code ?properties=*all}. You can also include only specified properties or exclude some properties\n with a minus (-) sign.\n \n <ul>\n <li>{@code *all} - include all properties</li>\n <li>{@code *all, -prop1} - include all properties except {@code prop1} </li>\n <li>{@code prop1, prop1} - include {@code prop1} and {@code prop2} properties </li>\n </ul>\n \n \n JIRA will attempt to identify the issue by the <code>issueIdOrKey</code> path parameter. This can be an issue id,\n or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or\n by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect\n will not be returned). The issue key contained in the response will indicate the current value of issue's key.\n \n The <code>expand</code> param is used to include, hidden by default, parts of response. This can be used to include:\n <ul>\n <li><code>renderedFields</code> - field values in HTML format</li>\n <li><code>names</code> - display name of each field</li>\n <li><code>schema</code> - schema for each field which describes a type of the field</li>\n <li><code>transitions</code> - all possible transitions for the given issue</li>\n <li><code>operations</code> - all possibles operations which may be applied on issue</li>\n <li><code>editmeta</code> - information about how each field may be edited. It contains field's schema as well.</li>\n <li><code>changelog</code> - history of all changes of the given issue</li>\n <li><code>versionedRepresentations</code> -\n REST representations of all fields. Some field may contain more recent versions. RESET representations are numbered.\n The greatest number always represents the most recent version. It is recommended that the most recent version is used.\n version for these fields which provide a more recent REST representation.\n After including <code>versionedRepresentations</code> \"fields\" field become hidden.</li>\n </ul>","operationId":"getIssue","parameters":[{"description":"the list of fields to return for the issue. By default, all fields are returned.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"in":"query","name":"expand","required":false,"schema":{"type":"string"}},{"description":"the list of properties to return for the issue. By default no properties are returned.","in":"query","name":"properties","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the issue id or key to update (i.e. JRA-1330)","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}],"put":{"description":"Edits an issue from a JSON representation.\n \n The issue can either be updated by setting explicit the field value(s)\n or by using an operation to change the field value.\n \n The fields that can be updated, in either the fields parameter or the update parameter, can be determined\n using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource. \n If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field\n validation error will occur if it is submitted.\n \n Specifying a \"field_id\": field_value in the \"fields\" is a shorthand for a \"set\" operation in the \"update\" section. \n Field should appear either in \"fields\" or \"update\", not in both.","operationId":"editIssue","parameters":[{"description":"send the email with notification that the issue was updated to users that watch it.\n Admin or project admin permissions are required to disable the notification.","in":"query","name":"notifyUsers","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/assignee":{"parameters":[{"description":"a String containing an issue key","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}],"put":{"description":"Assigns an issue to a user.\n You can use this resource to assign issues when the user submitting the request has the assign permission but not the\n edit issue permission.\n If the name is \"-1\" automatic assignee is used. A null name will remove the assignee.","operationId":"assign","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/attachments":{"parameters":[{"description":"the issue that you want to add the attachments to","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}],"post":{"description":"Add one or more attachments to an issue.\n \n This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client\n libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components\n library provides a\n <a href=\"http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html\">MultiPartEntity</a>\n that makes it simple to submit a multipart POST.\n \n In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection\n on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be\n blocked.\n \n The name of the multipart/form-data parameter that contains attachments must be \"file\"\n \n A simple example to upload a file called \"myfile.txt\" to issue REST-123:\n <pre>curl -D- -u admin:admin -X POST -H \"X-Atlassian-Token: no-check\" -F \"file=@myfile.txt\" http://myhost/rest/api/2/issue/TEST-123/attachments</pre>","operationId":"addAttachment","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/comment":{"get":{"description":"Returns all comments for an issue.\n \n Results can be ordered by the \"created\" field which means the date a comment was added.\n ","operationId":"getComments","parameters":[{"description":"the page offset, if not specified then defaults to 0","in":"query","name":"startAt","required":false,"schema":{"type":"integer","format":"int64"}},{"description":"how many results on the page should be included. Defaults to 50.","in":"query","name":"maxResults","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"ordering of the results.","in":"query","name":"orderBy","required":false,"schema":{"type":"string"}},{"description":"optional flags: renderedBody (provides body rendered in HTML)","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"a string containing the issue id or key the comment will be added to","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}],"post":{"description":"Adds a new comment to an issue.","operationId":"addComment","parameters":[{"description":"optional flags: renderedBody (provides body rendered in HTML)","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/comment/{id}":{"delete":{"description":"Deletes an existing comment .","operationId":"deleteComment","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns a single comment.","operationId":"getComment","parameters":[{"description":"optional flags: renderedBody (provides body rendered in HTML)","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"of the issue the comment belongs to","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}},{"description":"the ID of the comment to request","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"put":{"description":"Updates an existing comment using its JSON representation.","operationId":"updateComment","parameters":[{"description":"optional flags: renderedBody (provides body rendered in HTML)","in":"query","name":"expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/editmeta":{"get":{"description":"Returns the meta data for editing an issue.\n \n The fields in the editmeta correspond to the fields in the edit screen for the issue.\n Fields not in the screen will not be in the editmeta.","operationId":"getEditIssueMeta","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the issue whose edit meta data you want to view","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}]},"/api/2/issue/{issueIdOrKey}/notify":{"parameters":[{"description":"a string containing the issue id or key the comment will be added to","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}],"post":{"description":"Sends a notification (email) to the list or recipients defined in the request.","operationId":"notify","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/properties":{"get":{"description":"Returns the keys of all properties for the issue identified by the key or by the id.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the issue from which keys will be returned.","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}}]},"/api/2/issue/{issueIdOrKey}/properties/{propertyKey}":{"delete":{"description":"Removes the property from the issue identified by the key or by the id. Ths user removing the property is required\n to have permissions to edit the issue.","responses":{"200":{"description":"Successful Response"}}},"get":{"description":"Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves\n the property is required to have permissions to read the issue.","responses":{"200":{"description":"Successful Response"}}},"parameters":[{"description":"the issue from which keys will be returned.","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}},{"description":"the key of the property to return.","in":"path","name":"propertyKey","required":true,"schema":{"type":"string"}}],"put":{"description":"Sets the value of the specified issue's property.\n \n You can use this resource to store a custom data against the issue identified by the key or by the id. The user\n who stores the data is required to have permissions to edit the issue.\n ","responses":{"200":{"description":"Successful Response"}}}},"/api/2/issue/{issueIdOrKey}/remotelink":{"delete":{"description":"Delete the remote issue link with the given global id on the issue.","operationId":"deleteRemoteIssueLinkByGlobalId","parameters":[{"description":"the global id of the remote issue link","in":"query","name":"globalId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response"}}},"get":{"description":"A REST sub-resource representing the remote issue links on the issue.","operationId":"getRemoteIssueLinks","parameters":[{"description":"The id of the remote issue link to be returned. If null (not provided) all remote links for the\n issue are returned.\n For a fullexplanation of Issue Link fields please refer to\n <a href=\"https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links\">https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links</a>","in":"query","name":"globalId","required":false,"schema":{"type":"string"}}],"r