From 4f1e385725a0bfec2e7e3752c1ecda56c0cae47b Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 14:04:32 +0300 Subject: [PATCH 1/8] Fix schemas. Fix streams.py. Fix acceptance test config. --- .../connectors/source-jira/README.md | 2 +- .../source-jira/acceptance-test-config.yml | 2 + .../source_jira/schemas/board_issues.json | 43 +- .../source_jira/schemas/dashboards.json | 437 +++++------------- .../source_jira/schemas/groups.json | 54 +-- .../source_jira/schemas/permissions.json | 15 +- .../schemas/project_permission_schemes.json | 57 +-- .../source_jira/schemas/screens.json | 5 +- .../source_jira/schemas/sprint_issues.json | 41 +- .../source-jira/source_jira/streams.py | 253 +++++++--- 10 files changed, 416 insertions(+), 493 deletions(-) diff --git a/airbyte-integrations/connectors/source-jira/README.md b/airbyte-integrations/connectors/source-jira/README.md index 97720a51637d..59a5af05d7b2 100644 --- a/airbyte-integrations/connectors/source-jira/README.md +++ b/airbyte-integrations/connectors/source-jira/README.md @@ -80,7 +80,7 @@ Then run any of the connector commands as follows: docker run --rm airbyte/source-jira:dev spec docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-jira:dev check --config /secrets/config.json docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-jira:dev discover --config /secrets/config.json -docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-jira:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-jira:dev read --config secrets/config.json --catalog sample_files/configured_catalog.json ``` ### Integration Tests diff --git a/airbyte-integrations/connectors/source-jira/acceptance-test-config.yml b/airbyte-integrations/connectors/source-jira/acceptance-test-config.yml index 8a30e88bb3d5..29ddbe8d6647 100644 --- a/airbyte-integrations/connectors/source-jira/acceptance-test-config.yml +++ b/airbyte-integrations/connectors/source-jira/acceptance-test-config.yml @@ -23,10 +23,12 @@ tests: configured_catalog_path: "integration_tests/issue_worklogs_configured_catalog.json" - config_path: "secrets/config.json" configured_catalog_path: "integration_tests/projects_configured_catalog.json" + empty_streams: ["project_permission_schemes"] - config_path: "secrets/config.json" configured_catalog_path: "integration_tests/workflows_configured_catalog.json" - config_path: "secrets/config.json" configured_catalog_path: "integration_tests/configured_catalog.json" + empty_streams: ["epics", "screen_tab_fields", "sprint_issues", "sprints"] # incremental: # - config_path: "secrets/config.json" # configured_catalog_path: "integration_tests/inc_configured_catalog.json" diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/board_issues.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/board_issues.json index d0cf486ec441..ffd6e813a76c 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/board_issues.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/board_issues.json @@ -15,10 +15,49 @@ "type": "string" }, "fields": { - "type": "object" + "type": "object", + "properties": { + "flagged": { + "type": ["null", "boolean"] + }, + "sprint": { + "type": ["null", "object"] + }, + "closedSprints": { + "type": ["null", "object"] + }, + "description": { + "type": ["null", "string"] + }, + "project": { + "type": ["null", "object"] + }, + "comment": { + "type": ["null", "array"], + "items": { + "type": "object" + } + }, + "epic": { + "type": ["null", "object"] + }, + "worklog": { + "type": ["null", "array"], + "items": { + "type": "object" + } + }, + "updated": { + "type": ["null", "string"], + "format": "date-time" + }, + "timetracking": { + "type": ["null", "object"] + } + } }, "boardId": { - "type": "string" + "type": "integer" } } } diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/dashboards.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/dashboards.json index 2c628e39069a..c71b9a70a204 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/dashboards.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/dashboards.json @@ -7,22 +7,18 @@ }, "id": { "type": "string", - "description": "The ID of the dashboard.", - "readOnly": true + "description": "The ID of the dashboard." }, "isFavourite": { "type": "boolean", - "description": "Whether the dashboard is selected as a favorite by the user.", - "readOnly": true + "description": "Whether the dashboard is selected as a favorite by the user." }, "name": { "type": "string", - "description": "The name of the dashboard.", - "readOnly": true + "description": "The name of the dashboard." }, "owner": { "description": "The owner of the dashboard.", - "readOnly": true, "type": "object", "properties": { "key": { @@ -82,33 +78,28 @@ "popularity": { "type": "integer", "description": "The number of users who have this dashboard as a favorite.", - "format": "int64", - "readOnly": true + "format": "int64" }, "rank": { "type": "integer", "description": "The rank of this dashboard.", - "format": "int32", - "readOnly": true + "format": "int32" }, "self": { "type": "string", "description": "The URL of these dashboard details.", - "format": "uri", - "readOnly": true + "format": "uri" }, "sharePermissions": { "type": "array", "description": "The details of any share permissions for the dashboard.", - "readOnly": true, "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true + "format": "int64" }, "type": { "type": "string", @@ -130,7 +121,6 @@ "expand": { "type": "string", "description": "Expand options that include additional project details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -138,8 +128,7 @@ "self": { "type": "string", "description": "The URL of the project details.", - "format": "uri", - "readOnly": true + "format": "uri" }, "id": { "type": "string", @@ -147,24 +136,20 @@ }, "key": { "type": "string", - "description": "The key of the project.", - "readOnly": true + "description": "The key of the project." }, "description": { "type": "string", - "description": "A brief description of the project.", - "readOnly": true + "description": "A brief description of the project." }, "lead": { "description": "The username of the project lead.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -178,7 +163,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -187,12 +171,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -219,27 +201,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -261,8 +238,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -285,7 +261,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -380,7 +355,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -390,20 +364,17 @@ "components": { "type": "array", "description": "List of the components contained in the project.", - "readOnly": true, "items": { "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the component.", - "format": "uri", - "readOnly": true + "format": "uri" }, "id": { "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true + "description": "The unique identifier for the component." }, "name": { "type": "string", @@ -415,14 +386,12 @@ }, "lead": { "description": "The user details for the component's lead user.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -436,7 +405,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -445,12 +413,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -477,27 +443,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -519,8 +480,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -543,7 +503,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -638,7 +597,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -667,14 +625,12 @@ }, "assignee": { "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -688,7 +644,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -697,12 +652,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -729,27 +682,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -771,8 +719,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -795,7 +742,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -890,7 +836,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -900,7 +845,6 @@ "realAssigneeType": { "type": "string", "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, "enum": [ "PROJECT_DEFAULT", "COMPONENT_LEAD", @@ -910,14 +854,12 @@ }, "realAssignee": { "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -931,7 +873,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -940,12 +881,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -972,27 +911,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -1014,8 +948,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -1038,7 +971,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -1133,7 +1065,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -1142,8 +1073,7 @@ }, "isAssigneeTypeValid": { "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true + "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned." }, "project": { "type": "string", @@ -1152,8 +1082,7 @@ "projectId": { "type": "integer", "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true + "format": "int64" } } } @@ -1161,78 +1090,64 @@ "issueTypes": { "type": "array", "description": "List of the issue types available in the project.", - "readOnly": true, "items": { "type": "object", "properties": { "self": { "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true + "description": "The URL of these issue type details." }, "id": { "type": "string", - "description": "The ID of the issue type.", - "readOnly": true + "description": "The ID of the issue type." }, "description": { "type": "string", - "description": "The description of the issue type.", - "readOnly": true + "description": "The description of the issue type." }, "iconUrl": { "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true + "description": "The URL of the issue type's avatar." }, "name": { "type": "string", - "description": "The name of the issue type.", - "readOnly": true + "description": "The name of the issue type." }, "subtask": { "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true + "description": "Whether this issue type is used to create subtasks." }, "avatarId": { "type": "integer", "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true + "format": "int64" }, "entityId": { "type": "string", "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true + "format": "uuid" }, "hierarchyLevel": { "type": "integer", "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true + "format": "int32" }, "scope": { "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, "type": "object", "properties": { "type": { "type": "string", "description": "The type of scope.", - "readOnly": true, "enum": ["PROJECT", "TEMPLATE"] }, "project": { "description": "The project the item has scope in.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", - "description": "The URL of the project details.", - "readOnly": true + "description": "The URL of the project details." }, "id": { "type": "string", @@ -1240,28 +1155,23 @@ }, "key": { "type": "string", - "description": "The key of the project.", - "readOnly": true + "description": "The key of the project." }, "name": { "type": "string", - "description": "The name of the project.", - "readOnly": true + "description": "The name of the project." }, "projectTypeKey": { "type": "string", "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, "enum": ["software", "service_desk", "business"] }, "simplified": { "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true + "description": "Whether or not the project is simplified." }, "avatarUrls": { "description": "The URLs of the project's avatars.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -1288,28 +1198,23 @@ }, "projectCategory": { "description": "The category the project belongs to.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", - "description": "The URL of the project category.", - "readOnly": true + "description": "The URL of the project category." }, "id": { "type": "string", - "description": "The ID of the project category.", - "readOnly": true + "description": "The ID of the project category." }, "description": { "type": "string", - "description": "The name of the project category.", - "readOnly": true + "description": "The name of the project category." }, "name": { "type": "string", - "description": "The description of the project category.", - "readOnly": true + "description": "The description of the project category." } } } @@ -1322,8 +1227,7 @@ }, "url": { "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true + "description": "A link to information about this project, such as project documentation." }, "email": { "type": "string", @@ -1332,13 +1236,11 @@ "assigneeType": { "type": "string", "description": "The default assignee when creating issues for this project.", - "readOnly": true, "enum": ["PROJECT_LEAD", "UNASSIGNED"] }, "versions": { "type": "array", "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, "items": { "type": "object", "properties": { @@ -1352,13 +1254,11 @@ "self": { "type": "string", "description": "The URL of the version.", - "format": "uri", - "readOnly": true + "format": "uri" }, "id": { "type": "string", - "description": "The ID of the version.", - "readOnly": true + "description": "The ID of the version." }, "description": { "type": "string", @@ -1388,18 +1288,15 @@ }, "overdue": { "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true + "description": "Indicates that the version is overdue." }, "userStartDate": { "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true + "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format." }, "userReleaseDate": { "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true + "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format." }, "project": { "type": "string", @@ -1418,7 +1315,6 @@ "operations": { "type": "array", "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, "items": { "type": "object", "properties": { @@ -1449,32 +1345,27 @@ }, "issuesStatusForFixVersion": { "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, "type": "object", "properties": { "unmapped": { "type": "integer", "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true + "format": "int64" }, "toDo": { "type": "integer", "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true + "format": "int64" }, "inProgress": { "type": "integer", "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true + "format": "int64" }, "done": { "type": "integer", "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true + "format": "int64" } } } @@ -1483,22 +1374,18 @@ }, "name": { "type": "string", - "description": "The name of the project.", - "readOnly": true + "description": "The name of the project." }, "roles": { "type": "object", "additionalProperties": { "type": "string", - "format": "uri", - "readOnly": true + "format": "uri" }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true + "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post)." }, "avatarUrls": { "description": "The URLs of the project's avatars.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -1525,19 +1412,16 @@ }, "projectCategory": { "description": "The category the project belongs to.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the project category.", - "format": "uri", - "readOnly": true + "format": "uri" }, "id": { "type": "string", - "description": "The ID of the project category.", - "readOnly": true + "description": "The ID of the project category." }, "name": { "type": "string", @@ -1552,18 +1436,15 @@ "projectTypeKey": { "type": "string", "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, "enum": ["software", "service_desk", "business"] }, "simplified": { "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true + "description": "Whether the project is simplified." }, "style": { "type": "string", "description": "The type of the project.", - "readOnly": true, "enum": ["classic", "next-gen"] }, "favourite": { @@ -1572,12 +1453,10 @@ }, "isPrivate": { "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true + "description": "Whether the project is private." }, "issueTypeHierarchy": { "description": "The issue type hierarchy for the project", - "readOnly": true, "type": "object", "properties": { "level": { @@ -1630,76 +1509,61 @@ }, "permissions": { "description": "User permissions on the project", - "readOnly": true, "type": "object", "properties": { "canEdit": { "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true + "description": "Whether the logged user can edit the project." } } }, "properties": { "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true + "description": "Map of project properties" }, "uuid": { "type": "string", "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true + "format": "uuid" }, "insight": { "description": "Insights about the project.", - "readOnly": true, "type": "object", "properties": { "totalIssueCount": { "type": "integer", "description": "Total issue count.", - "format": "int64", - "readOnly": true + "format": "int64" }, "lastIssueUpdateTime": { "type": "string", "description": "The last issue update time.", - "format": "date-time", - "readOnly": true + "format": "date-time" } } }, "deleted": { "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true + "description": "Whether the project is marked as deleted." }, "retentionTillDate": { "type": "string", "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true + "format": "date-time" }, "deletedDate": { "type": "string", "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true + "format": "date-time" }, "deletedBy": { "description": "The user who marked the project as deleted.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -1713,7 +1577,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -1722,12 +1585,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -1754,27 +1615,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -1796,8 +1652,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -1820,7 +1675,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -1915,7 +1769,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -1924,25 +1777,21 @@ }, "archived": { "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true + "description": "Whether the project is archived." }, "archivedDate": { "type": "string", "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true + "format": "date-time" }, "archivedBy": { "description": "The user who archived the project.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", "description": "The URL of the user.", - "format": "uri", - "readOnly": true + "format": "uri" }, "key": { "type": "string", @@ -1956,7 +1805,6 @@ "accountType": { "type": "string", "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, "enum": ["atlassian", "app", "customer", "unknown"] }, "name": { @@ -1965,12 +1813,10 @@ }, "emailAddress": { "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "avatarUrls": { "description": "The avatars of the user.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -1997,27 +1843,22 @@ }, "displayName": { "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true + "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." }, "active": { "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true + "description": "Whether the user is active." }, "timeZone": { "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null." }, "locale": { "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true + "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null." }, "groups": { "description": "The groups that the user belongs to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -2039,8 +1880,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -2063,7 +1903,6 @@ }, "applicationRoles": { "description": "The application roles the user is assigned to.", - "readOnly": true, "type": "object", "properties": { "size": { @@ -2158,7 +1997,6 @@ "expand": { "type": "string", "description": "Expand options that include additional user details in the response.", - "readOnly": true, "xml": { "attribute": true } @@ -2174,8 +2012,7 @@ "self": { "type": "string", "description": "The URL the project role details.", - "format": "uri", - "readOnly": true + "format": "uri" }, "name": { "type": "string", @@ -2184,36 +2021,30 @@ "id": { "type": "integer", "description": "The ID of the project role.", - "format": "int64", - "readOnly": true + "format": "int64" }, "description": { "type": "string", - "description": "The description of the project role.", - "readOnly": true + "description": "The description of the project role." }, "actors": { "type": "array", "description": "The list of users who act in this role.", - "readOnly": true, "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true + "format": "int64" }, "displayName": { "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true + "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name." }, "type": { "type": "string", "description": "The type of role actor.", - "readOnly": true, "enum": [ "atlassian-group-role-actor", "atlassian-user-role-actor" @@ -2221,29 +2052,24 @@ }, "name": { "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true + "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "avatarUrl": { "type": "string", "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true + "format": "uri" }, "actorUser": { - "readOnly": true, "type": "object", "properties": { "accountId": { "maxLength": 128, "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true + "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import." } } }, "actorGroup": { - "readOnly": true, "type": "object", "properties": { "displayName": { @@ -2261,24 +2087,20 @@ }, "scope": { "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, "type": "object", "properties": { "type": { "type": "string", "description": "The type of scope.", - "readOnly": true, "enum": ["PROJECT", "TEMPLATE"] }, "project": { "description": "The project the item has scope in.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", - "description": "The URL of the project details.", - "readOnly": true + "description": "The URL of the project details." }, "id": { "type": "string", @@ -2286,28 +2108,23 @@ }, "key": { "type": "string", - "description": "The key of the project.", - "readOnly": true + "description": "The key of the project." }, "name": { "type": "string", - "description": "The name of the project.", - "readOnly": true + "description": "The name of the project." }, "projectTypeKey": { "type": "string", "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, "enum": ["software", "service_desk", "business"] }, "simplified": { "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true + "description": "Whether or not the project is simplified." }, "avatarUrls": { "description": "The URLs of the project's avatars.", - "readOnly": true, "type": "object", "properties": { "16x16": { @@ -2334,28 +2151,23 @@ }, "projectCategory": { "description": "The category the project belongs to.", - "readOnly": true, "type": "object", "properties": { "self": { "type": "string", - "description": "The URL of the project category.", - "readOnly": true + "description": "The URL of the project category." }, "id": { "type": "string", - "description": "The ID of the project category.", - "readOnly": true + "description": "The ID of the project category." }, "description": { "type": "string", - "description": "The name of the project category.", - "readOnly": true + "description": "The name of the project category." }, "name": { "type": "string", - "description": "The description of the project category.", - "readOnly": true + "description": "The description of the project category." } } } @@ -2373,18 +2185,15 @@ }, "admin": { "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true + "description": "Whether this role is the admin role for the project." }, "roleConfigurable": { "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true + "description": "Whether the roles are configurable for this project." }, "default": { "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true + "description": "Whether this role is the default role for the project" } } }, @@ -2399,8 +2208,7 @@ "self": { "type": "string", "description": "The URL for these group details.", - "format": "uri", - "readOnly": true + "format": "uri" } } } @@ -2409,10 +2217,9 @@ }, "view": { "type": "string", - "description": "The URL of the dashboard.", - "readOnly": true + "description": "The URL of the dashboard." } }, - "additionalProperties": false, + "additionalProperties": true, "description": "Details of a dashboard." } diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/groups.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/groups.json index cbd51394eb82..4a9e86de5de0 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/groups.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/groups.json @@ -2,55 +2,13 @@ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { - "header": { - "type": "string", - "description": "Header text indicating the number of groups in the response and the total number of groups found in the search." + "name": { + "type": ["null", "string"], + "description": "The name of the group." }, - "total": { - "type": "integer", - "description": "The total number of groups found in the search.", - "format": "int32" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the group." - }, - "html": { - "type": "string", - "description": "The group name with the matched query string highlighted with the HTML bold tag." - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The group label name." - }, - "title": { - "type": "string", - "description": "The title of the group label." - }, - "type": { - "type": "string", - "description": "The type of the group label.", - "enum": ["ADMIN", "SINGLE", "MULTIPLE"] - } - } - } - }, - "groupId": { - "type": "string", - "description": "The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*." - } - } - } + "groupId": { + "type": ["null", "string"], + "description": "The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*." } }, "additionalProperties": false, diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/permissions.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/permissions.json index 1955930991a9..348968eabad9 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/permissions.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/permissions.json @@ -2,10 +2,17 @@ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { - "permissions": { - "type": "object", - "description": "List of permissions.", - "readOnly": true + "key": { + "type": ["null", "string"] + }, + "name": { + "type": ["null", "string"] + }, + "type": { + "type": ["null", "string"] + }, + "description": { + "type": ["null", "string"] } }, "additionalProperties": false, diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/project_permission_schemes.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/project_permission_schemes.json index 9d359975aaf0..db200073f372 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/project_permission_schemes.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/project_permission_schemes.json @@ -3,59 +3,20 @@ "type": "object", "properties": { "self": { - "type": "string", - "description": "The URL of the issue security scheme.", - "readOnly": true + "type": ["null", "string"], + "description": "The URL of the issue level security item." }, "id": { - "type": "integer", - "description": "The ID of the issue security scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue security scheme.", - "readOnly": true + "type": ["null", "string"], + "description": "The ID of the issue level security item." }, "description": { - "type": "string", - "description": "The description of the issue security scheme.", - "readOnly": true + "type": ["null", "string"], + "description": "The description of the issue level security item." }, - "defaultSecurityLevelId": { - "type": "integer", - "description": "The ID of the default security level.", - "format": "int64", - "readOnly": true - }, - "levels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue level security item.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue level security item.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue level security item.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue level security item.", - "readOnly": true - } - } - } + "name": { + "type": ["null", "string"], + "description": "The name of the issue level security item." } }, "additionalProperties": false, diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/screens.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/screens.json index e9bcf309c8ab..c8a73d25ec6d 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/screens.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/screens.json @@ -118,10 +118,9 @@ } } } - }, - "additionalProperties": true + } } } }, - "readOnly": true + "additionalProperties": true } diff --git a/airbyte-integrations/connectors/source-jira/source_jira/schemas/sprint_issues.json b/airbyte-integrations/connectors/source-jira/source_jira/schemas/sprint_issues.json index 8a2c8307fdab..124802cf1442 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/schemas/sprint_issues.json +++ b/airbyte-integrations/connectors/source-jira/source_jira/schemas/sprint_issues.json @@ -15,7 +15,46 @@ "type": "string" }, "fields": { - "type": "object" + "type": "object", + "properties": { + "flagged": { + "type": ["null", "boolean"] + }, + "sprint": { + "type": ["null", "object"] + }, + "closedSprints": { + "type": ["null", "object"] + }, + "description": { + "type": ["null", "string"] + }, + "project": { + "type": ["null", "object"] + }, + "comment": { + "type": ["null", "array"], + "items": { + "type": "object" + } + }, + "epic": { + "type": ["null", "object"] + }, + "worklog": { + "type": ["null", "array"], + "items": { + "type": "object" + } + }, + "updated": { + "type": ["null", "string"], + "format": "date-time" + }, + "timetracking": { + "type": ["null", "object"] + } + } }, "sprintId": { "type": "number" diff --git a/airbyte-integrations/connectors/source-jira/source_jira/streams.py b/airbyte-integrations/connectors/source-jira/source_jira/streams.py index 6534e8e4203a..286ea96bad5b 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/streams.py +++ b/airbyte-integrations/connectors/source-jira/source_jira/streams.py @@ -3,8 +3,8 @@ # import urllib.parse as urlparse -from abc import ABC, abstractmethod -from typing import Any, Iterable, List, Mapping, MutableMapping, Optional +from abc import ABC +from typing import Any, Dict, Iterable, List, Mapping, MutableMapping, Optional from urllib.parse import parse_qs import pendulum @@ -20,8 +20,8 @@ class JiraStream(HttpStream, ABC): Jira API Reference: https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/ """ - primary_key = "id" - parse_response_root = None + primary_key: Optional[str] = "id" + parse_response_root: Optional[str] = None def __init__(self, domain: str, projects: List[str], **kwargs): super(JiraStream, self).__init__(**kwargs) @@ -52,19 +52,17 @@ def next_page_token(self, response: requests.Response) -> Optional[Mapping[str, def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Mapping[str, Any] = None, - next_page_token: Mapping[str, Any] = None, + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: - params = {} + params: Dict[str, str] = {} if next_page_token: params.update(next_page_token) return params - def request_headers( - self, stream_state: Mapping[str, Any], stream_slice: Mapping[str, Any] = None, next_page_token: Mapping[str, Any] = None - ) -> Mapping[str, Any]: + def request_headers(self, **kwargs) -> Mapping[str, Any]: return {"Accept": "application/json"} def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapping]: @@ -76,7 +74,7 @@ def parse_response(self, response: requests.Response, **kwargs) -> Iterable[Mapp else: yield self.transform(record=records, **kwargs) - def transform(self, record: MutableMapping[str, Any], **kwargs) -> MutableMapping[str, Any]: + def transform(self, record: MutableMapping[str, Any], stream_slice: Mapping[str, Any], **kwargs) -> MutableMapping[str, Any]: return record @@ -91,36 +89,42 @@ def __init__(self, start_date: str = "", **kwargs): super().__init__(**kwargs) self._start_date = start_date - def jql_compare_date(self, stream_state: Mapping[str, any] = {}) -> Optional[str]: + def jql_compare_date(self, stream_state: Mapping[str, Any]) -> Optional[str]: issues_state = None - if stream_state.get(self.cursor_field): - issues_state = pendulum.parse(stream_state.get(self.cursor_field, self._start_date)) + cursor_exist_in_state: Any = False + cursor_field = self.cursor_field + if isinstance(self.cursor_field, str): + cursor_exist_in_state = stream_state.get(self.cursor_field) + elif isinstance(self.cursor_field, list) and self.cursor_field: + cursor_exist_in_state = stream_state + for cursor_part in self.cursor_field: + cursor_exist_in_state = stream_state.get(cursor_part) + cursor_field = cursor_field[-1] + if cursor_exist_in_state: + issues_state = pendulum.parse(stream_state.get(cursor_field, self._start_date)) elif self._start_date: issues_state = pendulum.parse(self._start_date) if issues_state: issues_state_row = issues_state.strftime("%Y/%m/%d %H:%M") - return f"{self.cursor_field} > '{issues_state_row}'" + return f"{cursor_field} > '{issues_state_row}'" return None class IncrementalJiraStream(StartDateJiraStream, ABC): - @property - @abstractmethod - def cursor_field(self) -> str: - """ - Defining a cursor field indicates that a stream is incremental, so any incremental stream must extend this class - and define a cursor field. - """ - pass - def get_updated_state(self, current_stream_state: MutableMapping[str, Any], latest_record: Mapping[str, Any]) -> Mapping[str, Any]: - latest_record_date = pendulum.parse(latest_record.get("fields", {}).get(self.cursor_field)) - if current_stream_state: - current_stream_state = current_stream_state.get(self.cursor_field) - if current_stream_state: - return {self.cursor_field: str(max(latest_record_date, pendulum.parse(current_stream_state)))} + cursor_field = self.cursor_field + if isinstance(cursor_field, str): + latest_record.get(self.cursor_field) + elif isinstance(cursor_field, list): + for cursor_part in cursor_field: + latest_record = latest_record.get(cursor_part, {}) + cursor_field = cursor_field[-1] + latest_record_date = pendulum.parse(latest_record) + stream_state = current_stream_state.get(cursor_field) + if stream_state: + return {cursor_field: str(max(latest_record_date, pendulum.parse(stream_state)))} else: - return {self.cursor_field: str(latest_record_date)} + return {cursor_field: str(latest_record_date)} class ApplicationRoles(JiraStream): @@ -128,6 +132,8 @@ class ApplicationRoles(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/#api-rest-api-3-applicationrole-key-get """ + primary_key = None + def path(self, **kwargs) -> str: return "applicationrole" @@ -139,7 +145,8 @@ class Avatars(JiraStream): parse_response_root = "system" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} avatar_type = stream_slice["avatar_type"] return f"avatar/{avatar_type}/system" @@ -160,8 +167,14 @@ class Boards(V1ApiJiraStream): def path(self, **kwargs) -> str: return "board" - def request_params(self, stream_slice: Mapping[str, Any], **kwargs): - params = super().request_params(stream_slice=stream_slice, **kwargs) + def request_params( + self, + stream_state: Mapping[str, Any], + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, + ) -> MutableMapping[str, Any]: + stream_slice = stream_slice or {} + params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["projectKeyOrId"] = stream_slice["project_id"] return params @@ -181,15 +194,22 @@ class BoardIssues(V1ApiJiraStream, IncrementalJiraStream): https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-agile-1-0-board-boardid-issue-get """ - cursor_field = "updated" + cursor_field = ["fields", "updated"] parse_response_root = "issues" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} board_id = stream_slice["board_id"] return f"board/{board_id}/issue" - def request_params(self, stream_state: Mapping[str, Any] = {}, **kwargs): - params = super().request_params(stream_state=stream_state, **kwargs) + def request_params( + self, + stream_state: Mapping[str, Any], + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, + ) -> MutableMapping[str, Any]: + stream_state = stream_state or {} + params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = ["key", "updated"] jql = self.jql_compare_date(stream_state) if jql: @@ -222,15 +242,21 @@ class Epics(IncrementalJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-get """ - cursor_field = "updated" + cursor_field = ["fields", "updated"] parse_response_root = "issues" def path(self, **kwargs) -> str: return "search" - def request_params(self, stream_state: Mapping[str, Any] = {}, stream_slice: Mapping[str, Any] = None, **kwargs): + def request_params( + self, + stream_state: Mapping[str, Any], + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, + ) -> MutableMapping[str, Any]: + stream_slice = stream_slice or {} project_id = stream_slice["project_id"] - params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, **kwargs) + params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = ["summary", "description", "status", "updated"] jql_parts = ["issuetype = 'Epic'", f"project = '{project_id}'", self.jql_compare_date(stream_state)] params["jql"] = " and ".join([p for p in jql_parts if p]) @@ -265,7 +291,8 @@ class FilterSharing(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing/#api-rest-api-3-filter-id-permission-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} filter_id = stream_slice["filter_id"] return f"filter/{filter_id}/permission" @@ -281,6 +308,7 @@ class Groups(JiraStream): """ parse_response_root = "values" + primary_key = "groupId" def path(self, **kwargs) -> str: return "group/bulk" @@ -291,11 +319,11 @@ class Issues(IncrementalJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-get """ - cursor_field = "updated" + cursor_field = ["fields", "updated"] parse_response_root = "issues" use_cache = True - def __init__(self, additional_fields: List[str] = [], expand_changelog: bool = False, **kwargs): + def __init__(self, additional_fields: List[str], expand_changelog: bool = False, **kwargs): super().__init__(**kwargs) self._additional_fields = additional_fields self._expand_changelog = expand_changelog @@ -303,9 +331,15 @@ def __init__(self, additional_fields: List[str] = [], expand_changelog: bool = F def path(self, **kwargs) -> str: return "search" - def request_params(self, stream_state: Mapping[str, Any] = {}, stream_slice: Mapping[str, Any] = None, **kwargs): + def request_params( + self, + stream_state: Mapping[str, Any], + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, + ) -> MutableMapping[str, Any]: + stream_slice = stream_slice or {} project_id = stream_slice["project_id"] - params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, **kwargs) + params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = stream_slice["fields"] jql_parts = [f"project = '{project_id}'", self.jql_compare_date(stream_state)] params["jql"] = " and ".join([p for p in jql_parts if p]) @@ -357,12 +391,19 @@ class IssueComments(StartDateJiraStream): parse_response_root = "comments" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/comment" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): yield from super().read_records(stream_slice={"key": issue["key"]}, **kwargs) @@ -399,7 +440,8 @@ class IssueCustomFieldContexts(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} field_id = stream_slice["field_id"] return f"field/{field_id}/context" @@ -426,6 +468,8 @@ class IssueNavigatorSettings(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings/#api-rest-api-3-settings-columns-get """ + primary_key = None + def path(self, **kwargs) -> str: return "settings/columns" @@ -458,11 +502,13 @@ class IssuePropertyKeys(JiraStream): parse_response_root = "key" use_cache = True - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/properties" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: + stream_slice = stream_slice or {} issue_key = stream_slice["key"] yield from super().read_records(stream_slice={"key": issue_key}, **kwargs) @@ -472,13 +518,20 @@ class IssueProperties(StartDateJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties/#api-rest-api-3-issue-issueidorkey-properties-propertykey-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] issue_key = stream_slice["issue_key"] return f"issue/{issue_key}/properties/{key}" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) issue_property_keys_stream = IssuePropertyKeys(authenticator=self.authenticator, domain=self._domain, projects=self._projects) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): for property_key in issue_property_keys_stream.read_records(stream_slice={"key": issue["key"]}, **kwargs): @@ -490,12 +543,19 @@ class IssueRemoteLinks(StartDateJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links/#api-rest-api-3-issue-issueidorkey-remotelink-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/remotelink" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): yield from super().read_records(stream_slice={"key": issue["key"]}, **kwargs) @@ -553,13 +613,21 @@ class IssueVotes(StartDateJiraStream): """ # parse_response_root = "voters" + primary_key = None - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/votes" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): yield from super().read_records(stream_slice={"key": issue["key"]}, **kwargs) @@ -572,13 +640,21 @@ class IssueWatchers(StartDateJiraStream): """ # parse_response_root = "watchers" + primary_key = None - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/watchers" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): yield from super().read_records(stream_slice={"key": issue["key"]}, **kwargs) @@ -589,13 +665,21 @@ class IssueWorklogs(StartDateJiraStream): """ parse_response_root = "worklogs" + primary_key = None - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"issue/{key}/worklog" def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - issues_stream = Issues(authenticator=self.authenticator, domain=self._domain, projects=self._projects, start_date=self._start_date) + issues_stream = Issues( + additional_fields=[], + authenticator=self.authenticator, + domain=self._domain, + projects=self._projects, + start_date=self._start_date, + ) for issue in issues_stream.read_records(sync_mode=SyncMode.full_refresh): yield from super().read_records(stream_slice={"key": issue["key"]}, **kwargs) @@ -624,6 +708,7 @@ class Permissions(JiraStream): """ parse_response_root = "permissions" + primary_key = None def path(self, **kwargs) -> str: return "permissions" @@ -673,7 +758,8 @@ class ProjectAvatars(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars/#api-rest-api-3-project-projectidorkey-avatars-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"project/{key}/avatars" @@ -704,7 +790,8 @@ class ProjectComponents(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"project/{key}/component" @@ -719,7 +806,10 @@ class ProjectEmail(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email/#api-rest-api-3-project-projectid-email-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + primary_key = None + + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} project_id = stream_slice["project_id"] return f"project/{project_id}/email" @@ -734,7 +824,10 @@ class ProjectPermissionSchemes(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/#api-rest-api-3-project-projectkeyorid-securitylevel-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + parse_response_root = "levels" + + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"project/{key}/securitylevel" @@ -749,6 +842,8 @@ class ProjectTypes(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types/#api-rest-api-3-project-type-get """ + primary_key = None + def path(self, **kwargs) -> str: return "project/type" @@ -760,7 +855,8 @@ class ProjectVersions(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} key = stream_slice["key"] return f"project/{key}/version" @@ -790,7 +886,8 @@ class ScreenTabs(JiraStream): raise_on_http_errors = False use_cache = True - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} screen_id = stream_slice["screen_id"] return f"screens/{screen_id}/tabs" @@ -800,6 +897,7 @@ def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwarg yield from self.read_tab_records(stream_slice={"screen_id": screen["id"]}, **kwargs) def read_tab_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: + stream_slice = stream_slice or {} screen_id = stream_slice["screen_id"] yield from super().read_records(stream_slice={"screen_id": screen_id}, **kwargs) @@ -809,7 +907,8 @@ class ScreenTabFields(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/#api-rest-api-3-screens-screenid-tabs-tabid-fields-get """ - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} screen_id = stream_slice["screen_id"] tab_id = stream_slice["tab_id"] return f"screens/{screen_id}/tabs/{tab_id}/fields" @@ -842,7 +941,8 @@ class Sprints(V1ApiJiraStream): parse_response_root = "values" use_cache = True - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} board_id = stream_slice["board_id"] return f"board/{board_id}/sprint" @@ -859,15 +959,22 @@ class SprintIssues(V1ApiJiraStream, IncrementalJiraStream): https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-agile-1-0-sprint-sprintid-issue-get """ - cursor_field = "updated" + cursor_field = ["fields", "updated"] parse_response_root = "issues" - def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str: + def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: + stream_slice = stream_slice or {} sprint_id = stream_slice["sprint_id"] return f"sprint/{sprint_id}/issue" - def request_params(self, stream_state: Mapping[str, Any] = {}, stream_slice: Mapping[str, Any] = None, **kwargs): - params = super().request_params(stream_state=stream_state, **kwargs) + def request_params( + self, + stream_state: Mapping[str, Any], + stream_slice: Optional[Mapping[str, Any]] = None, + next_page_token: Optional[Mapping[str, Any]] = None, + ) -> MutableMapping[str, Any]: + stream_slice = stream_slice or {} + params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = stream_slice["fields"] jql = self.jql_compare_date(stream_state) if jql: @@ -895,6 +1002,8 @@ class TimeTracking(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking/#api-rest-api-3-configuration-timetracking-list-get """ + primary_key = None + def path(self, **kwargs) -> str: return "configuration/timetracking/list" @@ -904,6 +1013,8 @@ class Users(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get """ + primary_key = None + def path(self, **kwargs) -> str: return "user/search?query=" From c79102263a0216d95def94891b8ae8bf718be445 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 14:12:02 +0300 Subject: [PATCH 2/8] Delete sample_files dir. --- .../sample_config.json | 0 .../sample_files/configured_catalog.json | 12778 ---------------- .../sample_files/full_configured_catalog.json | 12085 --------------- .../sample_files/sample_state.json | 10 - 4 files changed, 24873 deletions(-) rename airbyte-integrations/connectors/source-jira/{sample_files => integration_tests}/sample_config.json (100%) delete mode 100644 airbyte-integrations/connectors/source-jira/sample_files/configured_catalog.json delete mode 100644 airbyte-integrations/connectors/source-jira/sample_files/full_configured_catalog.json delete mode 100644 airbyte-integrations/connectors/source-jira/sample_files/sample_state.json diff --git a/airbyte-integrations/connectors/source-jira/sample_files/sample_config.json b/airbyte-integrations/connectors/source-jira/integration_tests/sample_config.json similarity index 100% rename from airbyte-integrations/connectors/source-jira/sample_files/sample_config.json rename to airbyte-integrations/connectors/source-jira/integration_tests/sample_config.json diff --git a/airbyte-integrations/connectors/source-jira/sample_files/configured_catalog.json b/airbyte-integrations/connectors/source-jira/sample_files/configured_catalog.json deleted file mode 100644 index 4ecb74035c8c..000000000000 --- a/airbyte-integrations/connectors/source-jira/sample_files/configured_catalog.json +++ /dev/null @@ -1,12778 +0,0 @@ -{ - "streams": [ - { - "stream": { - "name": "application_roles", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - }, - "additionalProperties": false, - "description": "Details of an application role." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "avatars", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "system": { - "type": "array", - "description": "A list of avatar details.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "List of system avatars." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "dashboards", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "id": { - "type": "string", - "description": "The ID of the dashboard.", - "readOnly": true - }, - "isFavourite": { - "type": "boolean", - "description": "Whether the dashboard is selected as a favorite by the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the dashboard.", - "readOnly": true - }, - "owner": { - "description": "The owner of the dashboard.", - "readOnly": true, - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user." - }, - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri" - }, - "name": { - "type": "string", - "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user." - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." - }, - "active": { - "type": "boolean", - "description": "Whether the user is active." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "avatarUrls": { - "description": "The avatars of the user.", - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the user's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the user's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the user's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the user's 48x48 pixel avatar.", - "format": "uri" - } - } - } - } - }, - "popularity": { - "type": "integer", - "description": "The number of users who have this dashboard as a favorite.", - "format": "int64", - "readOnly": true - }, - "rank": { - "type": "integer", - "description": "The rank of this dashboard.", - "format": "int32", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of these dashboard details.", - "format": "uri", - "readOnly": true - }, - "sharePermissions": { - "type": "array", - "description": "The details of any share permissions for the dashboard.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "styleClass": { - "type": "string" - }, - "iconClass": { - "type": "string" - }, - "label": { - "type": "string" - }, - "title": { - "type": "string" - }, - "href": { - "type": "string" - }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { - "type": "integer", - "format": "int32" - }, - "issueTypeIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - }, - "view": { - "type": "string", - "description": "The URL of the dashboard.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details of a dashboard." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "filters", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the filter.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the filter.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the filter. Must be unique." - }, - "description": { - "type": "string", - "description": "A description of the filter." - }, - "owner": { - "description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "jql": { - "type": "string", - "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.", - "readOnly": true - }, - "viewUrl": { - "type": "string", - "description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.", - "format": "uri", - "readOnly": true - }, - "searchUrl": { - "type": "string", - "description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.", - "format": "uri", - "readOnly": true - }, - "favourite": { - "type": "boolean", - "description": "Whether the filter is selected as a favorite by any users, not including the filter owner.", - "readOnly": true - }, - "favouritedCount": { - "type": "integer", - "description": "The count of how many users have selected this filter as a favorite, including the filter owner.", - "format": "int64", - "readOnly": true - }, - "sharePermissions": { - "type": "array", - "description": "The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "styleClass": { - "type": "string" - }, - "iconClass": { - "type": "string" - }, - "label": { - "type": "string" - }, - "title": { - "type": "string" - }, - "href": { - "type": "string" - }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { - "type": "integer", - "format": "int32" - }, - "issueTypeIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - }, - "subscriptions": { - "type": "array", - "description": "The users that are subscribed to the filter.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the filter subscription.", - "format": "int64", - "readOnly": true - }, - "user": { - "description": "The user subscribing to filter.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "group": { - "description": "The group subscribing to filter.", - "readOnly": true, - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details of a filter." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "filter_sharing", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "styleClass": { - "type": "string" - }, - "iconClass": { - "type": "string" - }, - "label": { - "type": "string" - }, - "title": { - "type": "string" - }, - "href": { - "type": "string" - }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { - "type": "integer", - "format": "int32" - }, - "issueTypeIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "additionalProperties": false, - "description": "Details of a share permission for the filter." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "groups", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "header": { - "type": "string", - "description": "Header text indicating the number of groups in the response and the total number of groups found in the search." - }, - "total": { - "type": "integer", - "description": "The total number of groups found in the search.", - "format": "int32" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the group." - }, - "html": { - "type": "string", - "description": "The group name with the matched query string highlighted with the HTML bold tag." - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The group label name." - }, - "title": { - "type": "string", - "description": "The title of the group label." - }, - "type": { - "type": "string", - "description": "The type of the group label.", - "enum": ["ADMIN", "SINGLE", "MULTIPLE"] - } - } - } - }, - "groupId": { - "type": "string", - "description": "The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*." - } - } - } - } - }, - "additionalProperties": false, - "description": "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issues", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional issue details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "id": { - "type": "string", - "description": "The ID of the issue.", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the issue details.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the issue.", - "readOnly": true - }, - "renderedFields": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "The rendered value of each field present on the issue.", - "readOnly": true - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Details of the issue properties identified in the request.", - "readOnly": true - }, - "names": { - "type": "object", - "additionalProperties": { - "type": "string", - "readOnly": true - }, - "description": "The ID and name of each field present on the issue.", - "readOnly": true - }, - "schema": { - "type": "object", - "description": "The schema describing each field present on the issue.", - "readOnly": true - }, - "transitions": { - "type": "array", - "description": "The transitions that can be performed on the issue.", - "readOnly": true - }, - "operations": { - "description": "The operations that can be performed on the issue.", - "readOnly": true - }, - "editmeta": { - "description": "The metadata for the fields on the issue that can be amended.", - "readOnly": true - }, - "changelog": { - "description": "Details of changelogs associated with the issue.", - "readOnly": true - }, - "versionedRepresentations": { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "readOnly": true - }, - "description": "The versions of each field on the issue.", - "readOnly": true - }, - "fieldsToInclude": { - "type": "object" - }, - "fields": { - "type": "object", - "additionalProperties": {} - } - }, - "additionalProperties": false - }, - "supported_sync_modes": ["incremental"], - "source_defined_cursor": true, - "default_cursor_field": ["fields", "updated"] - }, - "sync_mode": "incremental", - "cursor_field": ["fields", "updated"], - "destination_sync_mode": "append" - }, - { - "stream": { - "name": "issue_comments", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the comment.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the comment.", - "readOnly": true - }, - "author": { - "description": "The ID of the user who created the comment.", - "readOnly": true - }, - "body": { - "description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)." - }, - "renderedBody": { - "type": "string", - "description": "The rendered version of the comment.", - "readOnly": true - }, - "updateAuthor": { - "description": "The ID of the user who updated the comment last.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date and time at which the comment was created.", - "format": "date-time", - "readOnly": true - }, - "updated": { - "type": "string", - "description": "The date and time at which the comment was updated last.", - "format": "date-time", - "readOnly": true - }, - "visibility": { - "description": "The group or role to which this comment is visible. Optional on create and update." - }, - "jsdPublic": { - "type": "boolean", - "description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.", - "readOnly": true - }, - "properties": { - "type": "array", - "description": "A list of comment properties. Optional on create and update." - } - }, - "additionalProperties": true, - "description": "A comment." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_fields", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the field." - }, - "key": { - "type": "string", - "description": "The key of the field." - }, - "name": { - "type": "string", - "description": "The name of the field." - }, - "custom": { - "type": "boolean", - "description": "Whether the field is a custom field." - }, - "orderable": { - "type": "boolean", - "description": "Whether the content of the field can be used to order lists." - }, - "navigable": { - "type": "boolean", - "description": "Whether the field can be used as a column on the issue navigator." - }, - "searchable": { - "type": "boolean", - "description": "Whether the content of the field can be searched." - }, - "clauseNames": { - "uniqueItems": true, - "type": "array", - "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).", - "items": { - "type": "string" - } - }, - "scope": { - "description": "The scope of the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "schema": { - "description": "The data schema for the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The data type of the field.", - "readOnly": true - }, - "items": { - "type": "string", - "description": "When the data type is an array, the name of the field items within the array.", - "readOnly": true - }, - "system": { - "type": "string", - "description": "If the field is a system field, the name of the field.", - "readOnly": true - }, - "custom": { - "type": "string", - "description": "If the field is a custom field, the URI of the field.", - "readOnly": true - }, - "customId": { - "type": "integer", - "description": "If the field is a custom field, the custom ID of the field.", - "format": "int64", - "readOnly": true - }, - "configuration": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "If the field is a custom field, the configuration of the field.", - "readOnly": true - } - } - } - }, - "additionalProperties": false, - "description": "Details about a field." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_field_configurations", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the field configuration.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the field configuration." - }, - "description": { - "type": "string", - "description": "The description of the field configuration." - }, - "isDefault": { - "type": "boolean", - "description": "Whether the field configuration is the default." - } - }, - "additionalProperties": false, - "description": "Details of a field configuration." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_custom_field_contexts", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the context." - }, - "name": { - "type": "string", - "description": "The name of the context." - }, - "description": { - "type": "string", - "description": "The description of the context." - }, - "isGlobalContext": { - "type": "boolean", - "description": "Whether the context is global." - }, - "isAnyIssueType": { - "type": "boolean", - "description": "Whether the context apply to all issue types." - } - }, - "additionalProperties": false, - "description": "The details of a custom field context." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_link_types", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "issueLinkTypes": { - "type": "array", - "description": "The issue link type bean.", - "readOnly": true, - "xml": { - "name": "issueLinkTypes" - }, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only." - }, - "name": { - "type": "string", - "description": "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "inward": { - "type": "string", - "description": "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "outward": { - "type": "string", - "description": "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "self": { - "type": "string", - "description": "The URL of the issue link type. Read only.", - "format": "uri", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "A list of issue link type beans." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_navigator_settings", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "label": { - "type": "string", - "description": "The issue navigator column label." - }, - "value": { - "type": "string", - "description": "The issue navigator column value." - } - }, - "additionalProperties": false, - "description": "Details of an issue navigator column item." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_notification_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional notification scheme details in the response." - }, - "id": { - "type": "integer", - "description": "The ID of the notification scheme.", - "format": "int64" - }, - "self": { - "type": "string" - }, - "name": { - "type": "string", - "description": "The name of the notification scheme." - }, - "description": { - "type": "string", - "description": "The description of the notification scheme." - }, - "notificationSchemeEvents": { - "type": "array", - "description": "The notification events and associated recipients.", - "items": { - "type": "object", - "properties": { - "event": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the event." - }, - "description": { - "type": "string", - "description": "The description of the event." - } - } - }, - "notifications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional event notification details in the response." - }, - "id": { - "type": "integer", - "description": "The ID of the notification.", - "format": "int64" - }, - "notificationType": { - "type": "string", - "description": "Identifies the recipients of the notification.", - "enum": [ - "CurrentAssignee", - "Reporter", - "CurrentUser", - "ProjectLead", - "ComponentLead", - "User", - "Group", - "ProjectRole", - "EmailAddress", - "AllWatchers", - "UserCustomField", - "GroupCustomField" - ] - }, - "parameter": { - "type": "string", - "description": "The value of the `notificationType`:\n\n * `User` The `parameter` is the user account ID.\n * `Group` The `parameter` is the group name.\n * `ProjectRole` The `parameter` is the project role ID.\n * `UserCustomField` The `parameter` is the ID of the custom field.\n * `GroupCustomField` The `parameter` is the ID of the custom field." - }, - "group": { - "description": "The specified group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - }, - "field": { - "description": "The custom user or group field.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the field." - }, - "key": { - "type": "string", - "description": "The key of the field." - }, - "name": { - "type": "string", - "description": "The name of the field." - }, - "custom": { - "type": "boolean", - "description": "Whether the field is a custom field." - }, - "orderable": { - "type": "boolean", - "description": "Whether the content of the field can be used to order lists." - }, - "navigable": { - "type": "boolean", - "description": "Whether the field can be used as a column on the issue navigator." - }, - "searchable": { - "type": "boolean", - "description": "Whether the content of the field can be searched." - }, - "clauseNames": { - "uniqueItems": true, - "type": "array", - "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).", - "items": { - "type": "string" - } - }, - "scope": { - "description": "The scope of the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "schema": { - "description": "The data schema for the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The data type of the field.", - "readOnly": true - }, - "items": { - "type": "string", - "description": "When the data type is an array, the name of the field items within the array.", - "readOnly": true - }, - "system": { - "type": "string", - "description": "If the field is a system field, the name of the field.", - "readOnly": true - }, - "custom": { - "type": "string", - "description": "If the field is a custom field, the URI of the field.", - "readOnly": true - }, - "customId": { - "type": "integer", - "description": "If the field is a custom field, the custom ID of the field.", - "format": "int64", - "readOnly": true - }, - "configuration": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "If the field is a custom field, the configuration of the field.", - "readOnly": true - } - } - } - } - }, - "emailAddress": { - "type": "string", - "description": "The email address." - }, - "projectRole": { - "description": "The specified project role.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "user": { - "description": "The specified user.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - } - } - } - } - } - } - }, - "scope": { - "description": "The scope of the notification scheme.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details about a notification scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_priorities", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue priority." - }, - "statusColor": { - "type": "string", - "description": "The color used to indicate the issue priority." - }, - "description": { - "type": "string", - "description": "The description of the issue priority." - }, - "iconUrl": { - "type": "string", - "description": "The URL of the icon for the issue priority." - }, - "name": { - "type": "string", - "description": "The name of the issue priority." - }, - "id": { - "type": "string", - "description": "The ID of the issue priority." - } - }, - "additionalProperties": true, - "description": "An issue priority." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_properties", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the property. Required on create and update." - }, - "value": { - "description": "The value of the property. Required on create and update." - } - }, - "additionalProperties": false, - "description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_remote_links", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the link.", - "format": "int64" - }, - "self": { - "type": "string", - "description": "The URL of the link.", - "format": "uri" - }, - "globalId": { - "type": "string", - "description": "The global ID of the link, such as the ID of the item on the remote system." - }, - "application": { - "description": "Details of the remote application the linked item is in.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The name-spaced type of the application, used by registered rendering apps." - }, - "name": { - "type": "string", - "description": "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last." - } - } - }, - "relationship": { - "type": "string", - "description": "Description of the relationship between the issue and the linked item." - }, - "object": { - "description": "Details of the item linked to.", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL of the item." - }, - "title": { - "type": "string", - "description": "The title of the item." - }, - "summary": { - "type": "string", - "description": "The summary details of the item." - }, - "icon": { - "description": "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.", - "type": "object", - "properties": { - "url16x16": { - "type": "string", - "description": "The URL of an icon that displays at 16x16 pixel in Jira." - }, - "title": { - "type": "string", - "description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"." - }, - "link": { - "type": "string", - "description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable." - } - } - }, - "status": { - "description": "The status of the item.", - "type": "object", - "properties": { - "resolved": { - "type": "boolean", - "description": "Whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font." - }, - "icon": { - "description": "Details of the icon representing the status. If not provided, no status icon displays in Jira.", - "type": "object", - "properties": { - "url16x16": { - "type": "string", - "description": "The URL of an icon that displays at 16x16 pixel in Jira." - }, - "title": { - "type": "string", - "description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"." - }, - "link": { - "type": "string", - "description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable." - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details of an issue remote link." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_resolutions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue resolution.", - "format": "uri" - }, - "id": { - "type": "string", - "description": "The ID of the issue resolution." - }, - "description": { - "type": "string", - "description": "The description of the issue resolution." - }, - "name": { - "type": "string", - "description": "The name of the issue resolution." - } - }, - "additionalProperties": false, - "description": "Details of an issue resolution." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_security_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "issueSecuritySchemes": { - "type": "array", - "description": "List of security schemes.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue security scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the issue security scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue security scheme.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue security scheme.", - "readOnly": true - }, - "defaultSecurityLevelId": { - "type": "integer", - "description": "The ID of the default security level.", - "format": "int64", - "readOnly": true - }, - "levels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue level security item.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue level security item.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue level security item.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue level security item.", - "readOnly": true - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "List of security schemes." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_type_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue type scheme." - }, - "name": { - "type": "string", - "description": "The name of the issue type scheme." - }, - "description": { - "type": "string", - "description": "The description of the issue type scheme." - }, - "defaultIssueTypeId": { - "type": "string", - "description": "The ID of the default issue type of the issue type scheme." - }, - "isDefault": { - "type": "boolean", - "description": "Whether the issue type scheme is the default." - } - }, - "additionalProperties": false, - "description": "Details of an issue type scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_type_screen_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue type screen scheme." - }, - "name": { - "type": "string", - "description": "The name of the issue type screen scheme." - }, - "description": { - "type": "string", - "description": "The description of the issue type screen scheme." - } - }, - "additionalProperties": false, - "description": "Details of an issue type screen scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_votes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue vote details.", - "format": "uri", - "readOnly": true - }, - "votes": { - "type": "integer", - "description": "The number of votes on the issue.", - "format": "int64", - "readOnly": true - }, - "hasVoted": { - "type": "boolean", - "description": "Whether the user making this request has voted on the issue.", - "readOnly": true - }, - "voters": { - "type": "array", - "description": "List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - } - } - }, - "additionalProperties": false, - "description": "The details of votes on an issue." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_watchers", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue watcher details.", - "readOnly": true - }, - "isWatching": { - "type": "boolean", - "description": "Whether the calling user is watching this issue.", - "readOnly": true - }, - "watchCount": { - "type": "integer", - "description": "The number of users watching this issue.", - "format": "int32", - "readOnly": true - }, - "watchers": { - "type": "array", - "description": "Details of the users watching this issue.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "The details of watchers on an issue." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_worklogs", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the worklog item.", - "format": "uri", - "readOnly": true - }, - "author": { - "description": "Details of the user who created the worklog.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - }, - "updateAuthor": { - "description": "Details of the user who last updated the worklog.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - }, - "comment": { - "description": "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog." - }, - "created": { - "type": "string", - "description": "The datetime on which the worklog was created.", - "format": "date-time", - "readOnly": true - }, - "updated": { - "type": "string", - "description": "The datetime on which the worklog was last updated.", - "format": "date-time", - "readOnly": true - }, - "visibility": { - "description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Whether visibility of this item is restricted to a group or role.", - "enum": ["group", "role"] - }, - "value": { - "type": "string", - "description": "The name of the group or role to which visibility of this item is restricted." - } - } - }, - "started": { - "type": "string", - "description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.", - "format": "date-time" - }, - "timeSpent": { - "type": "string", - "description": "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided." - }, - "timeSpentSeconds": { - "type": "integer", - "description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "The ID of the worklog record.", - "readOnly": true - }, - "issueId": { - "type": "string", - "description": "The ID of the issue this worklog is for.", - "readOnly": true - }, - "properties": { - "type": "array", - "description": "Details of properties for the worklog. Optional when creating or updating a worklog.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the property. Required on create and update." - }, - "value": { - "description": "The value of the property. Required on create and update." - } - } - } - } - }, - "additionalProperties": true, - "description": "Details of a worklog." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "jira_settings", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the application property. The ID and key are the same." - }, - "key": { - "type": "string", - "description": "The key of the application property. The ID and key are the same." - }, - "value": { - "type": "string", - "description": "The new value." - }, - "name": { - "type": "string", - "description": "The name of the application property." - }, - "desc": { - "type": "string", - "description": "The description of the application property." - }, - "type": { - "type": "string", - "description": "The data type of the application property." - }, - "defaultValue": { - "type": "string", - "description": "The default value of the application property." - }, - "example": { - "type": "string" - }, - "allowedValues": { - "type": "array", - "description": "The allowed values, if applicable.", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false, - "description": "Details of an application property." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "labels", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": ["object", "null"], - "properties": { - "id": { - "type": ["string", "null"] - }, - "key": { - "type": ["string", "null"] - }, - "value": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "desc": { - "type": ["string", "null"] - }, - "type": { - "type": ["string", "null"] - } - }, - "additionalProperties": true - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "permissions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "permissions": { - "type": "object", - "description": "List of permissions.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about permissions." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "permission_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "permissionSchemes": { - "type": "array", - "description": "Permission schemes list.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "The expand options available for the permission scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the permission scheme.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the permission scheme.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the permission scheme. Must be unique." - }, - "description": { - "type": "string", - "description": "A description for the permission scheme." - }, - "scope": { - "description": "The scope of the permission scheme.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "permissions": { - "type": "array", - "description": "The permission scheme to create or update. See [About permission schemes and grants](#about-permission-schemes-and-grants) for more information.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the permission granted details.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the permission granted details.", - "format": "uri", - "readOnly": true - }, - "holder": { - "description": "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](#holder-object) in *Get all permission schemes* for more information.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of permission holder." - }, - "parameter": { - "type": "string", - "description": "The identifier of permission holder." - }, - "expand": { - "type": "string", - "description": "Expand options that include additional permission holder details in the response.", - "readOnly": true - } - } - }, - "permission": { - "type": "string", - "description": "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions." - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "List of all permission schemes." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "projects", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about a project." - }, - "supported_sync_modes": ["full_refresh"] - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_avatars", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "system": { - "type": "array", - "description": "List of avatars included with Jira. These avatars cannot be deleted.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - }, - "custom": { - "type": "array", - "description": "List of avatars added to Jira. These avatars may be deleted.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "List of project avatars." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_categories", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - }, - "additionalProperties": false, - "description": "A project category." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_components", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "issueCount": { - "type": "integer", - "description": "Count of issues for the component.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL for this count of the issues contained in the component.", - "format": "uri", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description for the component.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project to which the component is assigned.", - "readOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "lead": { - "description": "The user details for the component's lead user.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "projectId": { - "type": "integer", - "description": "Not used.", - "format": "int64", - "readOnly": true - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "name": { - "type": "string", - "description": "The name for the component.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - } - }, - "description": "Details about a component with a count of the issues it contains." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_email", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address." - } - }, - "additionalProperties": false, - "description": "A project's sender email address." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_permission_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue security scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the issue security scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue security scheme.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue security scheme.", - "readOnly": true - }, - "defaultSecurityLevelId": { - "type": "integer", - "description": "The ID of the default security level.", - "format": "int64", - "readOnly": true - }, - "levels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue level security item.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue level security item.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue level security item.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue level security item.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "Details about a security scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_types", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the project type.", - "readOnly": true - }, - "formattedKey": { - "type": "string", - "description": "The formatted key of the project type.", - "readOnly": true - }, - "descriptionI18nKey": { - "type": "string", - "description": "The key of the project type's description.", - "readOnly": true - }, - "icon": { - "type": "string", - "description": "The icon of the project type.", - "readOnly": true - }, - "color": { - "type": "string", - "description": "The color of the project type.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about a project type." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_versions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "styleClass": { - "type": "string" - }, - "iconClass": { - "type": "string" - }, - "label": { - "type": "string" - }, - "title": { - "type": "string" - }, - "href": { - "type": "string" - }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - }, - "xml": { - "name": "version" - } - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screens", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the screen.", - "readOnly": true - }, - "scope": { - "description": "The scope of the screen.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - }, - "description": "A screen." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_tabs", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "required": ["name"], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen tab.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen tab. The maximum length is 255 characters." - } - }, - "additionalProperties": false, - "description": "A screen tab." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_tab_fields", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the screen tab field.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen tab field. Required on create and update. The maximum length is 255 characters." - } - }, - "additionalProperties": false, - "description": "A screen tab field." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen scheme.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the screen scheme." - }, - "description": { - "type": "string", - "description": "The description of the screen scheme." - }, - "screens": { - "description": "The IDs of the screens for the screen types of the screen scheme.", - "type": "object", - "properties": { - "edit": { - "type": "integer", - "description": "The ID of the edit screen.", - "format": "int64" - }, - "create": { - "type": "integer", - "description": "The ID of the create screen.", - "format": "int64" - }, - "view": { - "type": "integer", - "description": "The ID of the view screen.", - "format": "int64" - }, - "default": { - "type": "integer", - "description": "The ID of the default screen. Required when creating a screen scheme.", - "format": "int64" - } - } - } - }, - "description": "A screen scheme." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "time_tracking", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "required": ["key"], - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key for the time tracking provider. For example, *JIRA*." - }, - "name": { - "type": "string", - "description": "The name of the time tracking provider. For example, *JIRA provided time tracking*." - }, - "url": { - "type": "string", - "description": "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about the time tracking provider." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "users", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - }, - "additionalProperties": false, - "description": "A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values." - }, - "supported_sync_modes": ["full_refresh"] - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflows", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the workflow." - } - } - }, - "description": { - "type": "string", - "description": "The description of the workflow." - }, - "transitions": { - "type": "array", - "description": "The transitions of the workflow.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the transition." - }, - "name": { - "type": "string", - "description": "The name of the transition." - }, - "description": { - "type": "string", - "description": "The description of the transition." - }, - "from": { - "type": "array", - "description": "The statuses the transition can start from.", - "items": { - "type": "string", - "description": "The statuses the transition can start from." - } - }, - "to": { - "type": "string", - "description": "The status the transition goes to." - }, - "type": { - "type": "string", - "description": "The type of the transition.", - "enum": ["global", "initial", "directed"] - }, - "screen": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the screen." - } - } - }, - "rules": { - "type": "object", - "properties": { - "conditions": { - "type": "array", - "description": "The workflow conditions.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - }, - "validators": { - "type": "array", - "description": "The workflow validators.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - }, - "postFunctions": { - "type": "array", - "description": "The workflow post functions.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - } - } - } - } - } - }, - "statuses": { - "type": "array", - "description": "The statuses of the workflow.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue status." - }, - "name": { - "type": "string", - "description": "The name of the status in the workflow." - }, - "properties": { - "type": "object", - "properties": { - "issueEditable": { - "type": "boolean", - "description": "Whether issues are editable in this status." - } - } - } - } - } - } - }, - "description": "Details about a workflow." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme." - }, - "description": { - "type": "string", - "description": "The description of the workflow scheme." - }, - "defaultWorkflow": { - "type": "string", - "description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*." - }, - "issueTypeMappings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme." - }, - "originalDefaultWorkflow": { - "type": "string", - "description": "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.", - "readOnly": true - }, - "originalIssueTypeMappings": { - "type": "object", - "additionalProperties": { - "type": "string", - "readOnly": true - }, - "description": "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.", - "readOnly": true - }, - "draft": { - "type": "boolean", - "description": "Whether the workflow scheme is a draft or not.", - "readOnly": true - }, - "lastModifiedUser": { - "description": "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { - "attribute": true - } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { - "type": "string" - } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { - "type": "string" - } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { - "type": "object" - }, - "callback": { - "type": "object" - }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - } - }, - "lastModified": { - "type": "string", - "description": "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", - "readOnly": true - }, - "self": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "updateDraftIfNeeded": { - "type": "boolean", - "description": "Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`." - }, - "issueTypes": { - "type": "object", - "description": "The issue types available in Jira.", - "readOnly": true - } - }, - "description": "Details about a workflow scheme." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_statuses", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the status.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the icon used to represent the status.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the status.", - "readOnly": true - }, - "statusCategory": { - "description": "The category assigned to the status.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status category.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the status category.", - "format": "int64", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the status category.", - "readOnly": true - }, - "colorName": { - "type": "string", - "description": "The name of the color used to represent the status category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status category.", - "readOnly": true - } - } - } - }, - "additionalProperties": true, - "description": "A status." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_status_categories", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status category.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the status category.", - "format": "int64", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the status category.", - "readOnly": true - }, - "colorName": { - "type": "string", - "description": "The name of the color used to represent the status category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status category.", - "readOnly": true - } - }, - "additionalProperties": true, - "description": "A status category." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - } - ] -} diff --git a/airbyte-integrations/connectors/source-jira/sample_files/full_configured_catalog.json b/airbyte-integrations/connectors/source-jira/sample_files/full_configured_catalog.json deleted file mode 100644 index 423a9e5ebc3c..000000000000 --- a/airbyte-integrations/connectors/source-jira/sample_files/full_configured_catalog.json +++ /dev/null @@ -1,12085 +0,0 @@ -{ - "streams": [ - { - "stream": { - "name": "application_roles", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { "type": "boolean", "description": "Deprecated." }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - }, - "additionalProperties": false, - "description": "Details of an application role." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "avatars", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "system": { - "type": "array", - "description": "A list of avatar details.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "List of system avatars." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "dashboards", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "description": { "type": "string" }, - "id": { - "type": "string", - "description": "The ID of the dashboard.", - "readOnly": true - }, - "isFavourite": { - "type": "boolean", - "description": "Whether the dashboard is selected as a favorite by the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the dashboard.", - "readOnly": true - }, - "owner": { - "description": "The owner of the dashboard.", - "readOnly": true, - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user." - }, - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri" - }, - "name": { - "type": "string", - "description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user." - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value." - }, - "active": { - "type": "boolean", - "description": "Whether the user is active." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "avatarUrls": { - "description": "The avatars of the user.", - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the user's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the user's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the user's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the user's 48x48 pixel avatar.", - "format": "uri" - } - } - } - } - }, - "popularity": { - "type": "integer", - "description": "The number of users who have this dashboard as a favorite.", - "format": "int64", - "readOnly": true - }, - "rank": { - "type": "integer", - "description": "The rank of this dashboard.", - "format": "int32", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of these dashboard details.", - "format": "uri", - "readOnly": true - }, - "sharePermissions": { - "type": "array", - "description": "The details of any share permissions for the dashboard.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "styleClass": { "type": "string" }, - "iconClass": { "type": "string" }, - "label": { "type": "string" }, - "title": { "type": "string" }, - "href": { "type": "string" }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "integer", "format": "int64" }, - "name": { "type": "string" }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { - "type": "integer", - "format": "int32" - }, - "issueTypeIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { "readOnly": true }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - }, - "view": { - "type": "string", - "description": "The URL of the dashboard.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details of a dashboard." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "filters", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the filter.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the filter.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the filter. Must be unique." - }, - "description": { - "type": "string", - "description": "A description of the filter." - }, - "owner": { - "description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "jql": { - "type": "string", - "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.", - "readOnly": true - }, - "viewUrl": { - "type": "string", - "description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.", - "format": "uri", - "readOnly": true - }, - "searchUrl": { - "type": "string", - "description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.", - "format": "uri", - "readOnly": true - }, - "favourite": { - "type": "boolean", - "description": "Whether the filter is selected as a favorite by any users, not including the filter owner.", - "readOnly": true - }, - "favouritedCount": { - "type": "integer", - "description": "The count of how many users have selected this filter as a favorite, including the filter owner.", - "format": "int64", - "readOnly": true - }, - "sharePermissions": { - "type": "array", - "description": "The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": [ - "atlassian", - "app", - "customer", - "unknown" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { - "type": "boolean" - }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "styleClass": { "type": "string" }, - "iconClass": { "type": "string" }, - "label": { "type": "string" }, - "title": { "type": "string" }, - "href": { "type": "string" }, - "weight": { - "type": "integer", - "format": "int32" - } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "integer", "format": "int64" }, - "name": { "type": "string" }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { - "type": "integer", - "format": "int32" - }, - "issueTypeIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { "readOnly": true }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - }, - "subscriptions": { - "type": "array", - "description": "The users that are subscribed to the filter.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the filter subscription.", - "format": "int64", - "readOnly": true - }, - "user": { - "description": "The user subscribing to filter.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "group": { - "description": "The group subscribing to filter.", - "readOnly": true, - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details of a filter." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "filter_sharing", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the share permission.", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", - "enum": [ - "group", - "project", - "projectRole", - "global", - "loggedin", - "authenticated", - "project-unknown" - ] - }, - "project": { - "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project.", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the component.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." - }, - "description": { - "type": "string", - "description": "The description for the component. Optional when creating or updating a component." - }, - "lead": { - "description": "The user details for the component's lead user.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "leadUserName": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "leadAccountId": { - "maxLength": 128, - "type": "string", - "description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", - "writeOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { - "name": "max-results", - "attribute": true - } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project the component is assigned to.", - "format": "int64", - "readOnly": true - } - } - } - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue type details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue type.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the issue type's avatar.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue type.", - "readOnly": true - }, - "subtask": { - "type": "boolean", - "description": "Whether this issue type is used to create subtasks.", - "readOnly": true - }, - "avatarId": { - "type": "integer", - "description": "The ID of the issue type's avatar.", - "format": "int64", - "readOnly": true - }, - "entityId": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "hierarchyLevel": { - "type": "integer", - "description": "Hierarchy level of the issue type.", - "format": "int32", - "readOnly": true - }, - "scope": { - "description": "Details of the next-gen projects the issue type is available in.", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - } - } - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "styleClass": { "type": "string" }, - "iconClass": { "type": "string" }, - "label": { "type": "string" }, - "title": { "type": "string" }, - "href": { "type": "string" }, - "weight": { "type": "integer", "format": "int32" } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - } - } - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - } - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true, - "type": "object", - "properties": { - "level": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { "type": "integer", "format": "int64" }, - "name": { "type": "string" }, - "aboveLevelId": { - "type": "integer", - "format": "int64" - }, - "belowLevelId": { - "type": "integer", - "format": "int64" - }, - "projectConfigurationId": { - "type": "integer", - "format": "int64" - }, - "level": { "type": "integer", "format": "int32" }, - "issueTypeIds": { - "type": "array", - "items": { "type": "integer", "format": "int64" } - }, - "externalUuid": { - "type": "string", - "format": "uuid" - }, - "globalHierarchyLevel": { - "type": "string", - "enum": ["SUBTASK", "BASE", "EPIC"] - } - } - } - } - } - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true, - "type": "object", - "properties": { - "canEdit": { - "type": "boolean", - "description": "Whether the logged user can edit the project.", - "readOnly": true - } - } - }, - "properties": { - "type": "object", - "additionalProperties": { "readOnly": true }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true, - "type": "object", - "properties": { - "totalIssueCount": { - "type": "integer", - "description": "Total issue count.", - "format": "int64", - "readOnly": true - }, - "lastIssueUpdateTime": { - "type": "string", - "description": "The last issue update time.", - "format": "date-time", - "readOnly": true - } - } - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - } - } - }, - "role": { - "description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "group": { - "description": "The group that the filter is shared with. For a request, specify the `name` property for the group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "additionalProperties": false, - "description": "Details of a share permission for the filter." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "groups", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "header": { - "type": "string", - "description": "Header text indicating the number of groups in the response and the total number of groups found in the search." - }, - "total": { - "type": "integer", - "description": "The total number of groups found in the search.", - "format": "int32" - }, - "groups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the group." - }, - "html": { - "type": "string", - "description": "The group name with the matched query string highlighted with the HTML bold tag." - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The group label name." - }, - "title": { - "type": "string", - "description": "The title of the group label." - }, - "type": { - "type": "string", - "description": "The type of the group label.", - "enum": ["ADMIN", "SINGLE", "MULTIPLE"] - } - } - } - }, - "groupId": { - "type": "string", - "description": "The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*." - } - } - } - } - }, - "additionalProperties": false, - "description": "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issues", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional issue details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "id": { - "type": "string", - "description": "The ID of the issue.", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the issue details.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the issue.", - "readOnly": true - }, - "renderedFields": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "The rendered value of each field present on the issue.", - "readOnly": true - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Details of the issue properties identified in the request.", - "readOnly": true - }, - "names": { - "type": "object", - "additionalProperties": { - "type": "string", - "readOnly": true - }, - "description": "The ID and name of each field present on the issue.", - "readOnly": true - }, - "schema": { - "type": "object", - "description": "The schema describing each field present on the issue.", - "readOnly": true - }, - "transitions": { - "type": "array", - "description": "The transitions that can be performed on the issue.", - "readOnly": true - }, - "operations": { - "description": "The operations that can be performed on the issue.", - "readOnly": true - }, - "editmeta": { - "description": "The metadata for the fields on the issue that can be amended.", - "readOnly": true - }, - "changelog": { - "description": "Details of changelogs associated with the issue.", - "readOnly": true - }, - "versionedRepresentations": { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "readOnly": true - }, - "description": "The versions of each field on the issue.", - "readOnly": true - }, - "fieldsToInclude": { - "type": "object" - }, - "fields": { - "type": "object", - "additionalProperties": {} - } - }, - "additionalProperties": false - }, - "supported_sync_modes": ["incremental"], - "source_defined_cursor": true, - "default_cursor_field": ["fields", "updated"] - }, - "sync_mode": "incremental", - "cursor_field": ["fields", "updated"], - "destination_sync_mode": "append" - }, - { - "stream": { - "name": "issue_comments", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the comment.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the comment.", - "readOnly": true - }, - "author": { - "description": "The ID of the user who created the comment.", - "readOnly": true - }, - "body": { - "description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)." - }, - "renderedBody": { - "type": "string", - "description": "The rendered version of the comment.", - "readOnly": true - }, - "updateAuthor": { - "description": "The ID of the user who updated the comment last.", - "readOnly": true - }, - "created": { - "type": "string", - "description": "The date and time at which the comment was created.", - "format": "date-time", - "readOnly": true - }, - "updated": { - "type": "string", - "description": "The date and time at which the comment was updated last.", - "format": "date-time", - "readOnly": true - }, - "visibility": { - "description": "The group or role to which this comment is visible. Optional on create and update." - }, - "jsdPublic": { - "type": "boolean", - "description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation.", - "readOnly": true - }, - "properties": { - "type": "array", - "description": "A list of comment properties. Optional on create and update." - } - }, - "additionalProperties": true, - "description": "A comment." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_fields", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { "type": "string", "description": "The ID of the field." }, - "key": { "type": "string", "description": "The key of the field." }, - "name": { - "type": "string", - "description": "The name of the field." - }, - "custom": { - "type": "boolean", - "description": "Whether the field is a custom field." - }, - "orderable": { - "type": "boolean", - "description": "Whether the content of the field can be used to order lists." - }, - "navigable": { - "type": "boolean", - "description": "Whether the field can be used as a column on the issue navigator." - }, - "searchable": { - "type": "boolean", - "description": "Whether the content of the field can be searched." - }, - "clauseNames": { - "uniqueItems": true, - "type": "array", - "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).", - "items": { "type": "string" } - }, - "scope": { - "description": "The scope of the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "schema": { - "description": "The data schema for the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The data type of the field.", - "readOnly": true - }, - "items": { - "type": "string", - "description": "When the data type is an array, the name of the field items within the array.", - "readOnly": true - }, - "system": { - "type": "string", - "description": "If the field is a system field, the name of the field.", - "readOnly": true - }, - "custom": { - "type": "string", - "description": "If the field is a custom field, the URI of the field.", - "readOnly": true - }, - "customId": { - "type": "integer", - "description": "If the field is a custom field, the custom ID of the field.", - "format": "int64", - "readOnly": true - }, - "configuration": { - "type": "object", - "additionalProperties": { "readOnly": true }, - "description": "If the field is a custom field, the configuration of the field.", - "readOnly": true - } - } - } - }, - "additionalProperties": false, - "description": "Details about a field." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_field_configurations", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the field configuration.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the field configuration." - }, - "description": { - "type": "string", - "description": "The description of the field configuration." - }, - "isDefault": { - "type": "boolean", - "description": "Whether the field configuration is the default." - } - }, - "additionalProperties": false, - "description": "Details of a field configuration." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_custom_field_contexts", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { "type": "string", "description": "The ID of the context." }, - "name": { - "type": "string", - "description": "The name of the context." - }, - "description": { - "type": "string", - "description": "The description of the context." - }, - "isGlobalContext": { - "type": "boolean", - "description": "Whether the context is global." - }, - "isAnyIssueType": { - "type": "boolean", - "description": "Whether the context apply to all issue types." - } - }, - "additionalProperties": false, - "description": "The details of a custom field context." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_link_types", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "issueLinkTypes": { - "type": "array", - "description": "The issue link type bean.", - "readOnly": true, - "xml": { "name": "issueLinkTypes" }, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only." - }, - "name": { - "type": "string", - "description": "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "inward": { - "type": "string", - "description": "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "outward": { - "type": "string", - "description": "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." - }, - "self": { - "type": "string", - "description": "The URL of the issue link type. Read only.", - "format": "uri", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "A list of issue link type beans." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_navigator_settings", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "label": { - "type": "string", - "description": "The issue navigator column label." - }, - "value": { - "type": "string", - "description": "The issue navigator column value." - } - }, - "additionalProperties": false, - "description": "Details of an issue navigator column item." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_notification_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional notification scheme details in the response." - }, - "id": { - "type": "integer", - "description": "The ID of the notification scheme.", - "format": "int64" - }, - "self": { "type": "string" }, - "name": { - "type": "string", - "description": "The name of the notification scheme." - }, - "description": { - "type": "string", - "description": "The description of the notification scheme." - }, - "notificationSchemeEvents": { - "type": "array", - "description": "The notification events and associated recipients.", - "items": { - "type": "object", - "properties": { - "event": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the event." - }, - "description": { - "type": "string", - "description": "The description of the event." - } - } - }, - "notifications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional event notification details in the response." - }, - "id": { - "type": "integer", - "description": "The ID of the notification.", - "format": "int64" - }, - "notificationType": { - "type": "string", - "description": "Identifies the recipients of the notification.", - "enum": [ - "CurrentAssignee", - "Reporter", - "CurrentUser", - "ProjectLead", - "ComponentLead", - "User", - "Group", - "ProjectRole", - "EmailAddress", - "AllWatchers", - "UserCustomField", - "GroupCustomField" - ] - }, - "parameter": { - "type": "string", - "description": "The value of the `notificationType`:\n\n * `User` The `parameter` is the user account ID.\n * `Group` The `parameter` is the group name.\n * `ProjectRole` The `parameter` is the project role ID.\n * `UserCustomField` The `parameter` is the ID of the custom field.\n * `GroupCustomField` The `parameter` is the ID of the custom field." - }, - "group": { - "description": "The specified group.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - }, - "field": { - "description": "The custom user or group field.", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the field." - }, - "key": { - "type": "string", - "description": "The key of the field." - }, - "name": { - "type": "string", - "description": "The name of the field." - }, - "custom": { - "type": "boolean", - "description": "Whether the field is a custom field." - }, - "orderable": { - "type": "boolean", - "description": "Whether the content of the field can be used to order lists." - }, - "navigable": { - "type": "boolean", - "description": "Whether the field can be used as a column on the issue navigator." - }, - "searchable": { - "type": "boolean", - "description": "Whether the content of the field can be searched." - }, - "clauseNames": { - "uniqueItems": true, - "type": "array", - "description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).", - "items": { "type": "string" } - }, - "scope": { - "description": "The scope of the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "schema": { - "description": "The data schema for the field.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The data type of the field.", - "readOnly": true - }, - "items": { - "type": "string", - "description": "When the data type is an array, the name of the field items within the array.", - "readOnly": true - }, - "system": { - "type": "string", - "description": "If the field is a system field, the name of the field.", - "readOnly": true - }, - "custom": { - "type": "string", - "description": "If the field is a custom field, the URI of the field.", - "readOnly": true - }, - "customId": { - "type": "integer", - "description": "If the field is a custom field, the custom ID of the field.", - "format": "int64", - "readOnly": true - }, - "configuration": { - "type": "object", - "additionalProperties": { "readOnly": true }, - "description": "If the field is a custom field, the configuration of the field.", - "readOnly": true - } - } - } - } - }, - "emailAddress": { - "type": "string", - "description": "The email address." - }, - "projectRole": { - "description": "The specified project role.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL the project role details.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project role." - }, - "id": { - "type": "integer", - "description": "The ID of the project role.", - "format": "int64", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the project role.", - "readOnly": true - }, - "actors": { - "type": "array", - "description": "The list of users who act in this role.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the role actor.", - "format": "int64", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the role actor. For users, depending on the user\u2019s privacy setting, this may return an alternative value for the user's name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The type of role actor.", - "readOnly": true, - "enum": [ - "atlassian-group-role-actor", - "atlassian-user-role-actor" - ] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "avatarUrl": { - "type": "string", - "description": "The avatar of the role actor.", - "format": "uri", - "readOnly": true - }, - "actorUser": { - "readOnly": true, - "type": "object", - "properties": { - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import.", - "readOnly": true - } - } - }, - "actorGroup": { - "readOnly": true, - "type": "object", - "properties": { - "displayName": { - "type": "string", - "description": "The display name of the group." - }, - "name": { - "type": "string", - "description": "The name of the group" - } - } - } - } - } - }, - "scope": { - "description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", - "readOnly": true, - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": [ - "software", - "service_desk", - "business" - ] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "translatedName": { - "type": "string", - "description": "The translated name of the project role." - }, - "currentUserRole": { - "type": "boolean", - "description": "Whether the calling user is part of this role." - }, - "admin": { - "type": "boolean", - "description": "Whether this role is the admin role for the project.", - "readOnly": true - }, - "roleConfigurable": { - "type": "boolean", - "description": "Whether the roles are configurable for this project.", - "readOnly": true - }, - "default": { - "type": "boolean", - "description": "Whether this role is the default role for the project", - "readOnly": true - } - } - }, - "user": { - "description": "The specified user.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - } - } - } - } - } - } - }, - "scope": { - "description": "The scope of the notification scheme.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details about a notification scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_priorities", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue priority." - }, - "statusColor": { - "type": "string", - "description": "The color used to indicate the issue priority." - }, - "description": { - "type": "string", - "description": "The description of the issue priority." - }, - "iconUrl": { - "type": "string", - "description": "The URL of the icon for the issue priority." - }, - "name": { - "type": "string", - "description": "The name of the issue priority." - }, - "id": { - "type": "string", - "description": "The ID of the issue priority." - } - }, - "additionalProperties": true, - "description": "An issue priority." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_properties", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the property. Required on create and update." - }, - "value": { - "description": "The value of the property. Required on create and update." - } - }, - "additionalProperties": false, - "description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_remote_links", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the link.", - "format": "int64" - }, - "self": { - "type": "string", - "description": "The URL of the link.", - "format": "uri" - }, - "globalId": { - "type": "string", - "description": "The global ID of the link, such as the ID of the item on the remote system." - }, - "application": { - "description": "Details of the remote application the linked item is in.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The name-spaced type of the application, used by registered rendering apps." - }, - "name": { - "type": "string", - "description": "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last." - } - } - }, - "relationship": { - "type": "string", - "description": "Description of the relationship between the issue and the linked item." - }, - "object": { - "description": "Details of the item linked to.", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL of the item." - }, - "title": { - "type": "string", - "description": "The title of the item." - }, - "summary": { - "type": "string", - "description": "The summary details of the item." - }, - "icon": { - "description": "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.", - "type": "object", - "properties": { - "url16x16": { - "type": "string", - "description": "The URL of an icon that displays at 16x16 pixel in Jira." - }, - "title": { - "type": "string", - "description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"." - }, - "link": { - "type": "string", - "description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable." - } - } - }, - "status": { - "description": "The status of the item.", - "type": "object", - "properties": { - "resolved": { - "type": "boolean", - "description": "Whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font." - }, - "icon": { - "description": "Details of the icon representing the status. If not provided, no status icon displays in Jira.", - "type": "object", - "properties": { - "url16x16": { - "type": "string", - "description": "The URL of an icon that displays at 16x16 pixel in Jira." - }, - "title": { - "type": "string", - "description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"." - }, - "link": { - "type": "string", - "description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable." - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "Details of an issue remote link." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_resolutions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue resolution.", - "format": "uri" - }, - "id": { - "type": "string", - "description": "The ID of the issue resolution." - }, - "description": { - "type": "string", - "description": "The description of the issue resolution." - }, - "name": { - "type": "string", - "description": "The name of the issue resolution." - } - }, - "additionalProperties": false, - "description": "Details of an issue resolution." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_security_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "issueSecuritySchemes": { - "type": "array", - "description": "List of security schemes.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue security scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the issue security scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue security scheme.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue security scheme.", - "readOnly": true - }, - "defaultSecurityLevelId": { - "type": "integer", - "description": "The ID of the default security level.", - "format": "int64", - "readOnly": true - }, - "levels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue level security item.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue level security item.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue level security item.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue level security item.", - "readOnly": true - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "List of security schemes." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_type_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue type scheme." - }, - "name": { - "type": "string", - "description": "The name of the issue type scheme." - }, - "description": { - "type": "string", - "description": "The description of the issue type scheme." - }, - "defaultIssueTypeId": { - "type": "string", - "description": "The ID of the default issue type of the issue type scheme." - }, - "isDefault": { - "type": "boolean", - "description": "Whether the issue type scheme is the default." - } - }, - "additionalProperties": false, - "description": "Details of an issue type scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_type_screen_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue type screen scheme." - }, - "name": { - "type": "string", - "description": "The name of the issue type screen scheme." - }, - "description": { - "type": "string", - "description": "The description of the issue type screen scheme." - } - }, - "additionalProperties": false, - "description": "Details of an issue type screen scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_votes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue vote details.", - "format": "uri", - "readOnly": true - }, - "votes": { - "type": "integer", - "description": "The number of votes on the issue.", - "format": "int64", - "readOnly": true - }, - "hasVoted": { - "type": "boolean", - "description": "Whether the user making this request has voted on the issue.", - "readOnly": true - }, - "voters": { - "type": "array", - "description": "List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - } - } - }, - "additionalProperties": false, - "description": "The details of votes on an issue." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_watchers", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of these issue watcher details.", - "readOnly": true - }, - "isWatching": { - "type": "boolean", - "description": "Whether the calling user is watching this issue.", - "readOnly": true - }, - "watchCount": { - "type": "integer", - "description": "The number of users watching this issue.", - "format": "int32", - "readOnly": true - }, - "watchers": { - "type": "array", - "description": "Details of the users watching this issue.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "The details of watchers on an issue." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "issue_worklogs", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the worklog item.", - "format": "uri", - "readOnly": true - }, - "author": { - "description": "Details of the user who created the worklog.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - }, - "updateAuthor": { - "description": "Details of the user who last updated the worklog.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", - "readOnly": true - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy settings, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy settings, this may be returned as null.", - "readOnly": true - }, - "accountType": { - "type": "string", - "description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", - "readOnly": true - } - } - }, - "comment": { - "description": "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog." - }, - "created": { - "type": "string", - "description": "The datetime on which the worklog was created.", - "format": "date-time", - "readOnly": true - }, - "updated": { - "type": "string", - "description": "The datetime on which the worklog was last updated.", - "format": "date-time", - "readOnly": true - }, - "visibility": { - "description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Whether visibility of this item is restricted to a group or role.", - "enum": ["group", "role"] - }, - "value": { - "type": "string", - "description": "The name of the group or role to which visibility of this item is restricted." - } - } - }, - "started": { - "type": "string", - "description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.", - "format": "date-time" - }, - "timeSpent": { - "type": "string", - "description": "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided." - }, - "timeSpentSeconds": { - "type": "integer", - "description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.", - "format": "int64" - }, - "id": { - "type": "string", - "description": "The ID of the worklog record.", - "readOnly": true - }, - "issueId": { - "type": "string", - "description": "The ID of the issue this worklog is for.", - "readOnly": true - }, - "properties": { - "type": "array", - "description": "Details of properties for the worklog. Optional when creating or updating a worklog.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the property. Required on create and update." - }, - "value": { - "description": "The value of the property. Required on create and update." - } - } - } - } - }, - "additionalProperties": true, - "description": "Details of a worklog." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "jira_settings", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the application property. The ID and key are the same." - }, - "key": { - "type": "string", - "description": "The key of the application property. The ID and key are the same." - }, - "value": { "type": "string", "description": "The new value." }, - "name": { - "type": "string", - "description": "The name of the application property." - }, - "desc": { - "type": "string", - "description": "The description of the application property." - }, - "type": { - "type": "string", - "description": "The data type of the application property." - }, - "defaultValue": { - "type": "string", - "description": "The default value of the application property." - }, - "example": { "type": "string" }, - "allowedValues": { - "type": "array", - "description": "The allowed values, if applicable.", - "items": { "type": "string" } - } - }, - "additionalProperties": false, - "description": "Details of an application property." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "labels", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": ["object", "null"], - "properties": { - "id": { - "type": ["string", "null"] - }, - "key": { - "type": ["string", "null"] - }, - "value": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "desc": { - "type": ["string", "null"] - }, - "type": { - "type": ["string", "null"] - } - }, - "additionalProperties": true - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "permissions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "permissions": { - "type": "object", - "description": "List of permissions.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about permissions." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "permission_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "permissionSchemes": { - "type": "array", - "description": "Permission schemes list.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "The expand options available for the permission scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the permission scheme.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the permission scheme.", - "format": "uri", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the permission scheme. Must be unique." - }, - "description": { - "type": "string", - "description": "A description for the permission scheme." - }, - "scope": { - "description": "The scope of the permission scheme.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - }, - "permissions": { - "type": "array", - "description": "The permission scheme to create or update. See [About permission schemes and grants](#about-permission-schemes-and-grants) for more information.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the permission granted details.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL of the permission granted details.", - "format": "uri", - "readOnly": true - }, - "holder": { - "description": "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](#holder-object) in *Get all permission schemes* for more information.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of permission holder." - }, - "parameter": { - "type": "string", - "description": "The identifier of permission holder." - }, - "expand": { - "type": "string", - "description": "Expand options that include additional permission holder details in the response.", - "readOnly": true - } - } - }, - "permission": { - "type": "string", - "description": "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions." - } - } - } - } - } - } - } - }, - "additionalProperties": false, - "description": "List of all permission schemes." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "projects", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "expand": { - "type": "string", - "description": "Expand options that include additional project details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - }, - "self": { - "type": "string", - "description": "The URL of the project details.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "A brief description of the project.", - "readOnly": true - }, - "lead": { - "description": "The username of the project lead.", - "readOnly": true - }, - "components": { - "type": "array", - "description": "List of the components contained in the project.", - "readOnly": true - }, - "issueTypes": { - "type": "array", - "description": "List of the issue types available in the project.", - "readOnly": true - }, - "url": { - "type": "string", - "description": "A link to information about this project, such as project documentation.", - "readOnly": true - }, - "email": { - "type": "string", - "description": "An email address associated with the project." - }, - "assigneeType": { - "type": "string", - "description": "The default assignee when creating issues for this project.", - "readOnly": true, - "enum": ["PROJECT_LEAD", "UNASSIGNED"] - }, - "versions": { - "type": "array", - "description": "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "roles": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether the project is simplified.", - "readOnly": true - }, - "style": { - "type": "string", - "description": "The type of the project.", - "readOnly": true, - "enum": ["classic", "next-gen"] - }, - "favourite": { - "type": "boolean", - "description": "Whether the project is selected as a favorite." - }, - "isPrivate": { - "type": "boolean", - "description": "Whether the project is private.", - "readOnly": true - }, - "issueTypeHierarchy": { - "description": "The issue type hierarchy for the project", - "readOnly": true - }, - "permissions": { - "description": "User permissions on the project", - "readOnly": true - }, - "properties": { - "type": "object", - "additionalProperties": { - "readOnly": true - }, - "description": "Map of project properties", - "readOnly": true - }, - "uuid": { - "type": "string", - "description": "Unique ID for next-gen projects.", - "format": "uuid", - "readOnly": true - }, - "insight": { - "description": "Insights about the project.", - "readOnly": true - }, - "deleted": { - "type": "boolean", - "description": "Whether the project is marked as deleted.", - "readOnly": true - }, - "retentionTillDate": { - "type": "string", - "description": "The date when the project is deleted permanently.", - "format": "date-time", - "readOnly": true - }, - "deletedDate": { - "type": "string", - "description": "The date when the project was marked as deleted.", - "format": "date-time", - "readOnly": true - }, - "deletedBy": { - "description": "The user who marked the project as deleted.", - "readOnly": true - }, - "archived": { - "type": "boolean", - "description": "Whether the project is archived.", - "readOnly": true - }, - "archivedDate": { - "type": "string", - "description": "The date when the project was archived.", - "format": "date-time", - "readOnly": true - }, - "archivedBy": { - "description": "The user who archived the project.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about a project." - }, - "supported_sync_modes": ["full_refresh"] - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_avatars", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "system": { - "type": "array", - "description": "List of avatars included with Jira. These avatars cannot be deleted.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - }, - "custom": { - "type": "array", - "description": "List of avatars added to Jira. These avatars may be deleted.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the avatar." - }, - "owner": { - "type": "string", - "description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.", - "readOnly": true - }, - "isSystemAvatar": { - "type": "boolean", - "description": "Whether the avatar is a system avatar.", - "readOnly": true - }, - "isSelected": { - "type": "boolean", - "description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.", - "readOnly": true - }, - "isDeletable": { - "type": "boolean", - "description": "Whether the avatar can be deleted.", - "readOnly": true - }, - "fileName": { - "type": "string", - "description": "The file name of the avatar icon. Returned for system avatars.", - "readOnly": true - }, - "urls": { - "type": "object", - "additionalProperties": { - "type": "string", - "format": "uri", - "readOnly": true - }, - "description": "The list of avatar icon URLs.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "List of project avatars." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_categories", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project category. Required on create, optional on update." - }, - "description": { - "type": "string", - "description": "The description of the project category. Required on create, optional on update." - } - }, - "additionalProperties": false, - "description": "A project category." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_components", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "issueCount": { - "type": "integer", - "description": "Count of issues for the component.", - "format": "int64", - "readOnly": true - }, - "self": { - "type": "string", - "description": "The URL for this count of the issues contained in the component.", - "format": "uri", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description for the component.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "The key of the project to which the component is assigned.", - "readOnly": true - }, - "assigneeType": { - "type": "string", - "description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "lead": { - "description": "The user details for the component's lead user.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "projectId": { - "type": "integer", - "description": "Not used.", - "format": "int64", - "readOnly": true - }, - "realAssignee": { - "description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "isAssigneeTypeValid": { - "type": "boolean", - "description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", - "readOnly": true - }, - "assignee": { - "description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "realAssigneeType": { - "type": "string", - "description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", - "readOnly": true, - "enum": [ - "PROJECT_DEFAULT", - "COMPONENT_LEAD", - "PROJECT_LEAD", - "UNASSIGNED" - ] - }, - "name": { - "type": "string", - "description": "The name for the component.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The unique identifier for the component.", - "readOnly": true - } - }, - "description": "Details about a component with a count of the issues it contains." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_email", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address." - } - }, - "additionalProperties": false, - "description": "A project's sender email address." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_permission_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue security scheme.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the issue security scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue security scheme.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue security scheme.", - "readOnly": true - }, - "defaultSecurityLevelId": { - "type": "integer", - "description": "The ID of the default security level.", - "format": "int64", - "readOnly": true - }, - "levels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the issue level security item.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the issue level security item.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the issue level security item.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the issue level security item.", - "readOnly": true - } - } - } - } - }, - "additionalProperties": false, - "description": "Details about a security scheme." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_types", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the project type.", - "readOnly": true - }, - "formattedKey": { - "type": "string", - "description": "The formatted key of the project type.", - "readOnly": true - }, - "descriptionI18nKey": { - "type": "string", - "description": "The key of the project type's description.", - "readOnly": true - }, - "icon": { - "type": "string", - "description": "The icon of the project type.", - "readOnly": true - }, - "color": { - "type": "string", - "description": "The color of the project type.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about a project type." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "project_versions", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "expand": { - "type": "string", - "description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.", - "xml": { "attribute": true } - }, - "self": { - "type": "string", - "description": "The URL of the version.", - "format": "uri", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the version.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the version. Optional when creating or updating a version." - }, - "name": { - "type": "string", - "description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." - }, - "archived": { - "type": "boolean", - "description": "Indicates that the version is archived. Optional when creating or updating a version." - }, - "released": { - "type": "boolean", - "description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." - }, - "startDate": { - "type": "string", - "description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "releaseDate": { - "type": "string", - "description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", - "format": "date" - }, - "overdue": { - "type": "boolean", - "description": "Indicates that the version is overdue.", - "readOnly": true - }, - "userStartDate": { - "type": "string", - "description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "userReleaseDate": { - "type": "string", - "description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", - "readOnly": true - }, - "project": { - "type": "string", - "description": "Deprecated. Use `projectId`." - }, - "projectId": { - "type": "integer", - "description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", - "format": "int64" - }, - "moveUnfixedIssuesTo": { - "type": "string", - "description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", - "format": "uri" - }, - "operations": { - "type": "array", - "description": "If the expand option `operations` is used, returns the list of operations available for this version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "id": { "type": "string" }, - "styleClass": { "type": "string" }, - "iconClass": { "type": "string" }, - "label": { "type": "string" }, - "title": { "type": "string" }, - "href": { "type": "string" }, - "weight": { "type": "integer", "format": "int32" } - } - } - }, - "issuesStatusForFixVersion": { - "description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", - "readOnly": true, - "type": "object", - "properties": { - "unmapped": { - "type": "integer", - "description": "Count of issues with a status other than *to do*, *in progress*, and *done*.", - "format": "int64", - "readOnly": true - }, - "toDo": { - "type": "integer", - "description": "Count of issues with status *to do*.", - "format": "int64", - "readOnly": true - }, - "inProgress": { - "type": "integer", - "description": "Count of issues with status *in progress*.", - "format": "int64", - "readOnly": true - }, - "done": { - "type": "integer", - "description": "Count of issues with status *done*.", - "format": "int64", - "readOnly": true - } - } - } - }, - "xml": { "name": "version" } - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screens", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the screen.", - "readOnly": true - }, - "scope": { - "description": "The scope of the screen.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of scope.", - "readOnly": true, - "enum": ["PROJECT", "TEMPLATE"] - }, - "project": { - "description": "The project the item has scope in.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project details.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project." - }, - "key": { - "type": "string", - "description": "The key of the project.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the project.", - "readOnly": true - }, - "projectTypeKey": { - "type": "string", - "description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", - "readOnly": true, - "enum": ["software", "service_desk", "business"] - }, - "simplified": { - "type": "boolean", - "description": "Whether or not the project is simplified.", - "readOnly": true - }, - "avatarUrls": { - "description": "The URLs of the project's avatars.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "projectCategory": { - "description": "The category the project belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the project category.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the project category.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The name of the project category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The description of the project category.", - "readOnly": true - } - } - } - } - } - } - } - }, - "description": "A screen." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_tabs", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "required": ["name"], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen tab.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen tab. The maximum length is 255 characters." - } - }, - "additionalProperties": false, - "description": "A screen tab." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_tab_fields", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the screen tab field.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the screen tab field. Required on create and update. The maximum length is 255 characters." - } - }, - "additionalProperties": false, - "description": "A screen tab field." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "screen_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the screen scheme.", - "format": "int64" - }, - "name": { - "type": "string", - "description": "The name of the screen scheme." - }, - "description": { - "type": "string", - "description": "The description of the screen scheme." - }, - "screens": { - "description": "The IDs of the screens for the screen types of the screen scheme.", - "type": "object", - "properties": { - "edit": { - "type": "integer", - "description": "The ID of the edit screen.", - "format": "int64" - }, - "create": { - "type": "integer", - "description": "The ID of the create screen.", - "format": "int64" - }, - "view": { - "type": "integer", - "description": "The ID of the view screen.", - "format": "int64" - }, - "default": { - "type": "integer", - "description": "The ID of the default screen. Required when creating a screen scheme.", - "format": "int64" - } - } - } - }, - "description": "A screen scheme." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "time_tracking", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "required": ["key"], - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key for the time tracking provider. For example, *JIRA*." - }, - "name": { - "type": "string", - "description": "The name of the time tracking provider. For example, *JIRA provided time tracking*." - }, - "url": { - "type": "string", - "description": "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.", - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Details about the time tracking provider." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "users", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { - "attribute": true - } - } - }, - "additionalProperties": false, - "description": "A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values." - }, - "supported_sync_modes": ["full_refresh"] - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflows", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the workflow." - } - } - }, - "description": { - "type": "string", - "description": "The description of the workflow." - }, - "transitions": { - "type": "array", - "description": "The transitions of the workflow.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the transition." - }, - "name": { - "type": "string", - "description": "The name of the transition." - }, - "description": { - "type": "string", - "description": "The description of the transition." - }, - "from": { - "type": "array", - "description": "The statuses the transition can start from.", - "items": { - "type": "string", - "description": "The statuses the transition can start from." - } - }, - "to": { - "type": "string", - "description": "The status the transition goes to." - }, - "type": { - "type": "string", - "description": "The type of the transition.", - "enum": ["global", "initial", "directed"] - }, - "screen": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the screen." - } - } - }, - "rules": { - "type": "object", - "properties": { - "conditions": { - "type": "array", - "description": "The workflow conditions.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - }, - "validators": { - "type": "array", - "description": "The workflow validators.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - }, - "postFunctions": { - "type": "array", - "description": "The workflow post functions.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the transition rule." - }, - "configuration": { - "description": "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." - } - } - } - } - } - } - } - } - }, - "statuses": { - "type": "array", - "description": "The statuses of the workflow.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the issue status." - }, - "name": { - "type": "string", - "description": "The name of the status in the workflow." - }, - "properties": { - "type": "object", - "properties": { - "issueEditable": { - "type": "boolean", - "description": "Whether issues are editable in this status." - } - } - } - } - } - } - }, - "description": "Details about a workflow." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_schemes", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "array", - "description": "The list of items.", - "readOnly": true, - "items": { - "properties": { - "id": { - "type": "integer", - "description": "The ID of the workflow scheme.", - "format": "int64", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme." - }, - "description": { - "type": "string", - "description": "The description of the workflow scheme." - }, - "defaultWorkflow": { - "type": "string", - "description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*." - }, - "issueTypeMappings": { - "type": "object", - "additionalProperties": { "type": "string" }, - "description": "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme." - }, - "originalDefaultWorkflow": { - "type": "string", - "description": "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.", - "readOnly": true - }, - "originalIssueTypeMappings": { - "type": "object", - "additionalProperties": { "type": "string", "readOnly": true }, - "description": "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.", - "readOnly": true - }, - "draft": { - "type": "boolean", - "description": "Whether the workflow scheme is a draft or not.", - "readOnly": true - }, - "lastModifiedUser": { - "description": "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the user.", - "format": "uri", - "readOnly": true - }, - "key": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "accountId": { - "maxLength": 128, - "type": "string", - "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." - }, - "accountType": { - "type": "string", - "description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", - "readOnly": true, - "enum": ["atlassian", "app", "customer", "unknown"] - }, - "name": { - "type": "string", - "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." - }, - "emailAddress": { - "type": "string", - "description": "The email address of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "avatarUrls": { - "description": "The avatars of the user.", - "readOnly": true, - "type": "object", - "properties": { - "16x16": { - "type": "string", - "description": "The URL of the item's 16x16 pixel avatar.", - "format": "uri" - }, - "24x24": { - "type": "string", - "description": "The URL of the item's 24x24 pixel avatar.", - "format": "uri" - }, - "32x32": { - "type": "string", - "description": "The URL of the item's 32x32 pixel avatar.", - "format": "uri" - }, - "48x48": { - "type": "string", - "description": "The URL of the item's 48x48 pixel avatar.", - "format": "uri" - } - } - }, - "displayName": { - "type": "string", - "description": "The display name of the user. Depending on the user\u2019s privacy setting, this may return an alternative value.", - "readOnly": true - }, - "active": { - "type": "boolean", - "description": "Whether the user is active.", - "readOnly": true - }, - "timeZone": { - "type": "string", - "description": "The time zone specified in the user's profile. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "locale": { - "type": "string", - "description": "The locale of the user. Depending on the user\u2019s privacy setting, this may be returned as null.", - "readOnly": true - }, - "groups": { - "description": "The groups that the user belongs to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of group." - }, - "self": { - "type": "string", - "description": "The URL for these group details.", - "format": "uri", - "readOnly": true - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "applicationRoles": { - "description": "The application roles the user is assigned to.", - "readOnly": true, - "type": "object", - "properties": { - "size": { - "type": "integer", - "format": "int32", - "xml": { "attribute": true } - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The key of the application role." - }, - "groups": { - "uniqueItems": true, - "type": "array", - "description": "The groups associated with the application role.", - "items": { "type": "string" } - }, - "name": { - "type": "string", - "description": "The display name of the application role." - }, - "defaultGroups": { - "uniqueItems": true, - "type": "array", - "description": "The groups that are granted default access for this application role.", - "items": { "type": "string" } - }, - "selectedByDefault": { - "type": "boolean", - "description": "Determines whether this application role should be selected by default on user creation." - }, - "defined": { - "type": "boolean", - "description": "Deprecated." - }, - "numberOfSeats": { - "type": "integer", - "description": "The maximum count of users on your license.", - "format": "int32" - }, - "remainingSeats": { - "type": "integer", - "description": "The count of users remaining on your license.", - "format": "int32" - }, - "userCount": { - "type": "integer", - "description": "The number of users counting against your license.", - "format": "int32" - }, - "userCountDescription": { - "type": "string", - "description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." - }, - "hasUnlimitedSeats": { "type": "boolean" }, - "platform": { - "type": "boolean", - "description": "Indicates if the application role belongs to Jira platform (`jira-core`)." - } - } - } - }, - "pagingCallback": { "type": "object" }, - "callback": { "type": "object" }, - "max-results": { - "type": "integer", - "format": "int32", - "xml": { "name": "max-results", "attribute": true } - } - } - }, - "expand": { - "type": "string", - "description": "Expand options that include additional user details in the response.", - "readOnly": true, - "xml": { "attribute": true } - } - } - }, - "lastModified": { - "type": "string", - "description": "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", - "readOnly": true - }, - "self": { "type": "string", "format": "uri", "readOnly": true }, - "updateDraftIfNeeded": { - "type": "boolean", - "description": "Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`." - }, - "issueTypes": { - "type": "object", - "description": "The issue types available in Jira.", - "readOnly": true - } - }, - "description": "Details about a workflow scheme." - } - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_statuses", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "The description of the status.", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "The URL of the icon used to represent the status.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status.", - "readOnly": true - }, - "id": { - "type": "string", - "description": "The ID of the status.", - "readOnly": true - }, - "statusCategory": { - "description": "The category assigned to the status.", - "readOnly": true, - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status category.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the status category.", - "format": "int64", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the status category.", - "readOnly": true - }, - "colorName": { - "type": "string", - "description": "The name of the color used to represent the status category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status category.", - "readOnly": true - } - } - } - }, - "additionalProperties": true, - "description": "A status." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - }, - { - "stream": { - "name": "workflow_status_categories", - "json_schema": { - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "The URL of the status category.", - "readOnly": true - }, - "id": { - "type": "integer", - "description": "The ID of the status category.", - "format": "int64", - "readOnly": true - }, - "key": { - "type": "string", - "description": "The key of the status category.", - "readOnly": true - }, - "colorName": { - "type": "string", - "description": "The name of the color used to represent the status category.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the status category.", - "readOnly": true - } - }, - "additionalProperties": true, - "description": "A status category." - }, - "supported_sync_modes": ["full_refresh"], - "source_defined_cursor": false - }, - "sync_mode": "full_refresh", - "destination_sync_mode": "overwrite" - } - ] -} diff --git a/airbyte-integrations/connectors/source-jira/sample_files/sample_state.json b/airbyte-integrations/connectors/source-jira/sample_files/sample_state.json deleted file mode 100644 index 34de4187323c..000000000000 --- a/airbyte-integrations/connectors/source-jira/sample_files/sample_state.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "issues": { - "updated": "2021-06-02T22:18:39.882Z" - }, - "issue_worklogs": { - "10622": { - "started": "2021-02-14T11:30:22.313Z" - } - } -} From faddca1619efdc570091f6b145b3a7beda0301b6 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 14:15:29 +0300 Subject: [PATCH 3/8] Remove `sample_files` references. --- airbyte-integrations/connectors/source-jira/README.md | 6 +++--- airbyte-integrations/connectors/source-jira/build.gradle | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/airbyte-integrations/connectors/source-jira/README.md b/airbyte-integrations/connectors/source-jira/README.md index 59a5af05d7b2..1df558f15636 100644 --- a/airbyte-integrations/connectors/source-jira/README.md +++ b/airbyte-integrations/connectors/source-jira/README.md @@ -39,7 +39,7 @@ From the Airbyte repository root, run: **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/jira) to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_jira/spec.json` file. Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information. -See `sample_files/sample_config.json` for a sample config file. +See `integration_tests/sample_config.json` for a sample config file. **If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source jira test creds` and place them into `secrets/config.json`. @@ -50,7 +50,7 @@ and place them into `secrets/config.json`. python main.py spec python main.py check --config secrets/config.json python main.py discover --config secrets/config.json -python main.py read --config secrets/config.json --catalog sample_files/configured_catalog.json +python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json ``` ### Unit Tests @@ -80,7 +80,7 @@ Then run any of the connector commands as follows: docker run --rm airbyte/source-jira:dev spec docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-jira:dev check --config /secrets/config.json docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-jira:dev discover --config /secrets/config.json -docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-jira:dev read --config secrets/config.json --catalog sample_files/configured_catalog.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-jira:dev read --config secrets/config.json --catalog integration_tests/configured_catalog.json ``` ### Integration Tests diff --git a/airbyte-integrations/connectors/source-jira/build.gradle b/airbyte-integrations/connectors/source-jira/build.gradle index 7db4ece53215..71342896c337 100644 --- a/airbyte-integrations/connectors/source-jira/build.gradle +++ b/airbyte-integrations/connectors/source-jira/build.gradle @@ -11,7 +11,7 @@ airbytePython { airbyteStandardSourceTestFile { specPath = "source_jira/spec.json" configPath = "secrets/config.json" - configuredCatalogPath = "sample_files/configured_catalog.json" + configuredCatalogPath = "integration_test/configured_catalog.json" } From cbb4ae600172b1205744572d110d3505abc22627 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 14:19:15 +0300 Subject: [PATCH 4/8] Update `jira.md`. --- docs/integrations/sources/jira.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/integrations/sources/jira.md b/docs/integrations/sources/jira.md index e72e68841dc1..22399a54cd4f 100644 --- a/docs/integrations/sources/jira.md +++ b/docs/integrations/sources/jira.md @@ -85,6 +85,7 @@ The Jira connector should not run into Jira API limitations under normal usage. | Version | Date | Pull Request | Subject | | :--- | :--- | :--- | :--- | +| 0.2.14 | 2021-10-27 | [\#7408](https://github.com/airbytehq/airbyte/pull/7408) | Fix normalization step error. Fix schemas. Fix `acceptance-test-config.yml`. Fix `streams.py`. | | 0.2.13 | 2021-10-20 | [\#7222](https://github.com/airbytehq/airbyte/pull/7222) | Source Jira: Make recently added configs optional for backwards compatibility | | 0.2.12 | 2021-10-19 | [\#6621](https://github.com/airbytehq/airbyte/pull/6621) | Add Board, Epic, and Sprint streams | | 0.2.11 | 2021-09-02 | [\#6523](https://github.com/airbytehq/airbyte/pull/6523) | Add cache and more streams \(boards and sprints\) | From 3390d93e7034674facc5ec7f11a883547560771f Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 16:08:41 +0300 Subject: [PATCH 5/8] Fix build.gradle --- .../connectors/source-jira/build.gradle | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/airbyte-integrations/connectors/source-jira/build.gradle b/airbyte-integrations/connectors/source-jira/build.gradle index 71342896c337..2d083520233b 100644 --- a/airbyte-integrations/connectors/source-jira/build.gradle +++ b/airbyte-integrations/connectors/source-jira/build.gradle @@ -1,21 +1,13 @@ plugins { id 'airbyte-python' id 'airbyte-docker' - id 'airbyte-standard-source-test-file' + id 'airbyte-source-acceptance-test' } airbytePython { moduleDirectory 'source_jira' } -airbyteStandardSourceTestFile { - specPath = "source_jira/spec.json" - configPath = "secrets/config.json" - configuredCatalogPath = "integration_test/configured_catalog.json" -} - - dependencies { - implementation files(project(':airbyte-integrations:bases:base-standard-source-test-file').airbyteDocker.outputs) - implementation files(project(':airbyte-integrations:bases:base-python').airbyteDocker.outputs) + implementation files(project(':airbyte-integrations:bases:source-acceptance-test').airbyteDocker.outputs) } From 003c885fd3c9d249e5c98296f1e68e6dd1c22597 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Wed, 27 Oct 2021 19:43:23 +0300 Subject: [PATCH 6/8] Fix stream_slice initialization --- .../source-jira/source_jira/streams.py | 82 +++++++------------ 1 file changed, 28 insertions(+), 54 deletions(-) diff --git a/airbyte-integrations/connectors/source-jira/source_jira/streams.py b/airbyte-integrations/connectors/source-jira/source_jira/streams.py index 286ea96bad5b..bd79c9117bbd 100644 --- a/airbyte-integrations/connectors/source-jira/source_jira/streams.py +++ b/airbyte-integrations/connectors/source-jira/source_jira/streams.py @@ -52,7 +52,7 @@ def next_page_token(self, response: requests.Response) -> Optional[Mapping[str, def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: params: Dict[str, str] = {} @@ -145,8 +145,7 @@ class Avatars(JiraStream): parse_response_root = "system" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: avatar_type = stream_slice["avatar_type"] return f"avatar/{avatar_type}/system" @@ -170,10 +169,9 @@ def path(self, **kwargs) -> str: def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: - stream_slice = stream_slice or {} params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["projectKeyOrId"] = stream_slice["project_id"] return params @@ -197,15 +195,14 @@ class BoardIssues(V1ApiJiraStream, IncrementalJiraStream): cursor_field = ["fields", "updated"] parse_response_root = "issues" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: board_id = stream_slice["board_id"] return f"board/{board_id}/issue" def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: stream_state = stream_state or {} @@ -251,10 +248,9 @@ def path(self, **kwargs) -> str: def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: - stream_slice = stream_slice or {} project_id = stream_slice["project_id"] params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = ["summary", "description", "status", "updated"] @@ -291,8 +287,7 @@ class FilterSharing(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing/#api-rest-api-3-filter-id-permission-get """ - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: filter_id = stream_slice["filter_id"] return f"filter/{filter_id}/permission" @@ -334,10 +329,9 @@ def path(self, **kwargs) -> str: def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: - stream_slice = stream_slice or {} project_id = stream_slice["project_id"] params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = stream_slice["fields"] @@ -391,8 +385,7 @@ class IssueComments(StartDateJiraStream): parse_response_root = "comments" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/comment" @@ -440,8 +433,7 @@ class IssueCustomFieldContexts(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: field_id = stream_slice["field_id"] return f"field/{field_id}/context" @@ -502,13 +494,11 @@ class IssuePropertyKeys(JiraStream): parse_response_root = "key" use_cache = True - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/properties" - def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - stream_slice = stream_slice or {} + def read_records(self, stream_slice: Mapping[str, Any], **kwargs) -> Iterable[Mapping[str, Any]]: issue_key = stream_slice["key"] yield from super().read_records(stream_slice={"key": issue_key}, **kwargs) @@ -518,8 +508,7 @@ class IssueProperties(StartDateJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties/#api-rest-api-3-issue-issueidorkey-properties-propertykey-get """ - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] issue_key = stream_slice["issue_key"] return f"issue/{issue_key}/properties/{key}" @@ -543,8 +532,7 @@ class IssueRemoteLinks(StartDateJiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links/#api-rest-api-3-issue-issueidorkey-remotelink-get """ - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/remotelink" @@ -615,8 +603,7 @@ class IssueVotes(StartDateJiraStream): # parse_response_root = "voters" primary_key = None - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/votes" @@ -642,8 +629,7 @@ class IssueWatchers(StartDateJiraStream): # parse_response_root = "watchers" primary_key = None - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/watchers" @@ -667,8 +653,7 @@ class IssueWorklogs(StartDateJiraStream): parse_response_root = "worklogs" primary_key = None - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"issue/{key}/worklog" @@ -758,8 +743,7 @@ class ProjectAvatars(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars/#api-rest-api-3-project-projectidorkey-avatars-get """ - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"project/{key}/avatars" @@ -790,8 +774,7 @@ class ProjectComponents(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"project/{key}/component" @@ -808,8 +791,7 @@ class ProjectEmail(JiraStream): primary_key = None - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: project_id = stream_slice["project_id"] return f"project/{project_id}/email" @@ -826,8 +808,7 @@ class ProjectPermissionSchemes(JiraStream): parse_response_root = "levels" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"project/{key}/securitylevel" @@ -855,8 +836,7 @@ class ProjectVersions(JiraStream): parse_response_root = "values" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: key = stream_slice["key"] return f"project/{key}/version" @@ -886,8 +866,7 @@ class ScreenTabs(JiraStream): raise_on_http_errors = False use_cache = True - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: screen_id = stream_slice["screen_id"] return f"screens/{screen_id}/tabs" @@ -896,8 +875,7 @@ def read_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwarg for screen in screens_stream.read_records(sync_mode=SyncMode.full_refresh): yield from self.read_tab_records(stream_slice={"screen_id": screen["id"]}, **kwargs) - def read_tab_records(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> Iterable[Mapping[str, Any]]: - stream_slice = stream_slice or {} + def read_tab_records(self, stream_slice: Mapping[str, Any], **kwargs) -> Iterable[Mapping[str, Any]]: screen_id = stream_slice["screen_id"] yield from super().read_records(stream_slice={"screen_id": screen_id}, **kwargs) @@ -907,8 +885,7 @@ class ScreenTabFields(JiraStream): https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/#api-rest-api-3-screens-screenid-tabs-tabid-fields-get """ - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: screen_id = stream_slice["screen_id"] tab_id = stream_slice["tab_id"] return f"screens/{screen_id}/tabs/{tab_id}/fields" @@ -941,8 +918,7 @@ class Sprints(V1ApiJiraStream): parse_response_root = "values" use_cache = True - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: board_id = stream_slice["board_id"] return f"board/{board_id}/sprint" @@ -962,18 +938,16 @@ class SprintIssues(V1ApiJiraStream, IncrementalJiraStream): cursor_field = ["fields", "updated"] parse_response_root = "issues" - def path(self, stream_slice: Optional[Mapping[str, Any]] = None, **kwargs) -> str: - stream_slice = stream_slice or {} + def path(self, stream_slice: Mapping[str, Any], **kwargs) -> str: sprint_id = stream_slice["sprint_id"] return f"sprint/{sprint_id}/issue" def request_params( self, stream_state: Mapping[str, Any], - stream_slice: Optional[Mapping[str, Any]] = None, + stream_slice: Mapping[str, Any], next_page_token: Optional[Mapping[str, Any]] = None, ) -> MutableMapping[str, Any]: - stream_slice = stream_slice or {} params = super().request_params(stream_state=stream_state, stream_slice=stream_slice, next_page_token=next_page_token) params["fields"] = stream_slice["fields"] jql = self.jql_compare_date(stream_state) From 12d744105d0c8cd1fd9b46014ccca9f52554a1d2 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Fri, 29 Oct 2021 14:02:51 +0300 Subject: [PATCH 7/8] Remove unnecessary build.gradle dependencies --- airbyte-integrations/connectors/source-jira/build.gradle | 4 ---- 1 file changed, 4 deletions(-) diff --git a/airbyte-integrations/connectors/source-jira/build.gradle b/airbyte-integrations/connectors/source-jira/build.gradle index 2d083520233b..1d50457b6ecc 100644 --- a/airbyte-integrations/connectors/source-jira/build.gradle +++ b/airbyte-integrations/connectors/source-jira/build.gradle @@ -7,7 +7,3 @@ plugins { airbytePython { moduleDirectory 'source_jira' } - -dependencies { - implementation files(project(':airbyte-integrations:bases:source-acceptance-test').airbyteDocker.outputs) -} From 35dafabf5dc7e7d24a67c1a12338b90460d0ab05 Mon Sep 17 00:00:00 2001 From: Vadym Hevlich Date: Fri, 29 Oct 2021 14:05:52 +0300 Subject: [PATCH 8/8] Bump docker version --- .../68e63de2-bb83-4c7e-93fa-a8a9051e3993.json | 2 +- .../init/src/main/resources/seed/source_definitions.yaml | 2 +- airbyte-integrations/connectors/source-jira/Dockerfile | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/68e63de2-bb83-4c7e-93fa-a8a9051e3993.json b/airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/68e63de2-bb83-4c7e-93fa-a8a9051e3993.json index ef3ecba0efc8..00af067be140 100644 --- a/airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/68e63de2-bb83-4c7e-93fa-a8a9051e3993.json +++ b/airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/68e63de2-bb83-4c7e-93fa-a8a9051e3993.json @@ -2,7 +2,7 @@ "sourceDefinitionId": "68e63de2-bb83-4c7e-93fa-a8a9051e3993", "name": "Jira", "dockerRepository": "airbyte/source-jira", - "dockerImageTag": "0.2.13", + "dockerImageTag": "0.2.14", "documentationUrl": "https://docs.airbyte.io/integrations/sources/jira", "icon": "jira.svg" } diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml index eb7b9a2973f4..1c85891c7bf6 100644 --- a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml @@ -255,7 +255,7 @@ - name: Jira sourceDefinitionId: 68e63de2-bb83-4c7e-93fa-a8a9051e3993 dockerRepository: airbyte/source-jira - dockerImageTag: 0.2.13 + dockerImageTag: 0.2.14 documentationUrl: https://docs.airbyte.io/integrations/sources/jira icon: jira.svg sourceType: api diff --git a/airbyte-integrations/connectors/source-jira/Dockerfile b/airbyte-integrations/connectors/source-jira/Dockerfile index dc9d2e212efa..3582b4622bb1 100644 --- a/airbyte-integrations/connectors/source-jira/Dockerfile +++ b/airbyte-integrations/connectors/source-jira/Dockerfile @@ -12,5 +12,5 @@ RUN pip install . ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py" ENTRYPOINT ["python", "/airbyte/integration_code/main.py"] -LABEL io.airbyte.version=0.2.13 +LABEL io.airbyte.version=0.2.14 LABEL io.airbyte.name=airbyte/source-jira