Skip to content

Commit

Permalink
Update fields in source-connectors specifications: jira (#8999)
Browse files Browse the repository at this point in the history
  • Loading branch information
igrankova committed Dec 23, 2021
1 parent ea578e8 commit 586f22d
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"sourceDefinitionId": "68e63de2-bb83-4c7e-93fa-a8a9051e3993",
"name": "Jira",
"dockerRepository": "airbyte/source-jira",
"dockerImageTag": "0.2.15",
"dockerImageTag": "0.2.16",
"documentationUrl": "https://docs.airbyte.io/integrations/sources/jira",
"icon": "jira.svg"
}
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@
- name: Jira
sourceDefinitionId: 68e63de2-bb83-4c7e-93fa-a8a9051e3993
dockerRepository: airbyte/source-jira
dockerImageTag: 0.2.15
dockerImageTag: 0.2.16
documentationUrl: https://docs.airbyte.io/integrations/sources/jira
icon: jira.svg
sourceType: api
Expand Down
19 changes: 11 additions & 8 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3109,7 +3109,7 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-jira:0.2.15"
- dockerImage: "airbyte/source-jira:0.2.16"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/jira"
connectionSpecification:
Expand All @@ -3124,18 +3124,21 @@
properties:
api_token:
type: "string"
title: "API Token"
description: "Jira API Token. See the <a href=\"https://docs.airbyte.io/integrations/sources/jira\"\
>docs</a> for more information on how to generate this key."
airbyte_secret: true
domain:
type: "string"
title: "Domain"
examples:
- "domainname.atlassian.net"
pattern: "^[a-zA-Z0-9._-]*\\.atlassian\\.net$"
description: "Domain for your Jira account, e.g. airbyteio.atlassian.net"
description: "The Domain for your Jira account, e.g. airbyteio.atlassian.net"
email:
type: "string"
description: "The user email for your Jira account"
title: "Email"
description: "The user email for your Jira account."
projects:
type: "array"
title: "Projects"
Expand All @@ -3145,7 +3148,7 @@
- "PROJ1"
- "PROJ2"
description: "Comma-separated list of Jira project keys to replicate data\
\ for"
\ for."
start_date:
type: "string"
title: "Start Date"
Expand All @@ -3162,20 +3165,20 @@
items:
type: "string"
description: "Comma-separated list of additional fields to include in replicating\
\ issues"
\ issues."
examples:
- "Field A"
- "Field B"
expand_issue_changelog:
type: "boolean"
title: "Expand Issue Changelog"
description: "Expand the changelog when replicating issues"
description: "Expand the changelog when replicating issues."
default: false
render_fields:
type: "boolean"
title: "Render Issue Fields"
description: "Render issue fields in HTML format in addition to Jira's JSON-like\
\ format"
description: "Render issue fields in HTML format in addition to Jira JSON-like\
\ format."
default: false
supportsNormalization: false
supportsDBT: false
Expand Down
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-jira/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.15
LABEL io.airbyte.version=0.2.16
LABEL io.airbyte.name=airbyte/source-jira
9 changes: 9 additions & 0 deletions airbyte-integrations/connectors/source-jira/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-jira:dev discover --co
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
```

#### Acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
To run your integration tests with acceptance tests, from the connector root, run
```
docker build . --no-cache -t airbyte/source-jira:dev \
&& python -m pytest -p source_acceptance_test.plugin
```

### Integration Tests
1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-jira:integrationTest` to run the standard integration test suite.
1. To run additional integration tests, place your integration tests in a new directory `integration_tests` and run them with `python -m pytest -s integration_tests`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2856,6 +2856,6 @@
}
}
},
"additionalProperties": false,
"additionalProperties": true,
"description": "Details of a filter."
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,21 @@
"properties": {
"api_token": {
"type": "string",
"title": "API Token",
"description": "Jira API Token. See the <a href=\"https://docs.airbyte.io/integrations/sources/jira\">docs</a> for more information on how to generate this key.",
"airbyte_secret": true
},
"domain": {
"type": "string",
"title": "Domain",
"examples": ["domainname.atlassian.net"],
"pattern": "^[a-zA-Z0-9._-]*\\.atlassian\\.net$",
"description": "Domain for your Jira account, e.g. airbyteio.atlassian.net"
"description": "The Domain for your Jira account, e.g. airbyteio.atlassian.net"
},
"email": {
"type": "string",
"description": "The user email for your Jira account"
"title": "Email",
"description": "The user email for your Jira account."
},
"projects": {
"type": "array",
Expand All @@ -29,7 +32,7 @@
"type": "string"
},
"examples": ["PROJ1", "PROJ2"],
"description": "Comma-separated list of Jira project keys to replicate data for"
"description": "Comma-separated list of Jira project keys to replicate data for."
},
"start_date": {
"type": "string",
Expand All @@ -44,19 +47,19 @@
"items": {
"type": "string"
},
"description": "Comma-separated list of additional fields to include in replicating issues",
"description": "Comma-separated list of additional fields to include in replicating issues.",
"examples": ["Field A", "Field B"]
},
"expand_issue_changelog": {
"type": "boolean",
"title": "Expand Issue Changelog",
"description": "Expand the changelog when replicating issues",
"description": "Expand the changelog when replicating issues.",
"default": false
},
"render_fields": {
"type": "boolean",
"title": "Render Issue Fields",
"description": "Render issue fields in HTML format in addition to Jira's JSON-like format",
"description": "Render issue fields in HTML format in addition to Jira JSON-like format.",
"default": false
}
}
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/sources/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The Jira connector should not run into Jira API limitations under normal usage.

| Version | Date | Pull Request | Subject |
| :--- | :--- | :--- | :--- |
| 0.2.16 | 2021-12-21 | [\#8999](https://github.com/airbytehq/airbyte/pull/8999) | Update connector fields title/description |
| 0.2.15 | 2021-11-01 | [\#7398](https://github.com/airbytehq/airbyte/pull/7398) | Add option to render fields in HTML format and fix sprint_issue ids |
| 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 |
Expand Down

0 comments on commit 586f22d

Please sign in to comment.