-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: update jira settings #1897
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pnadolny13
requested review from
tayloramurphy and
edgarrmondragon
as code owners
November 18, 2024 17:47
✅ Deploy Preview for meltano-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Testing plugin
Auto-generated README.md
|
Setting | Required | Default | Description |
---|---|---|---|
start_date | False | None | Earliest record date to sync |
end_date | False | None | Latest record date to sync |
domain | True | None | The Domain for your Jira account, e.g. meltano.atlassian.net |
api_token | True | None | Jira API Token. |
True | None | The user email for your Jira account. | |
page_size | False | None | |
stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
flattening_max_depth | False | None | The max depth to flatten schemas. |
batch_config | False | None |
A full list of supported settings and capabilities is available by running: tap-jira --about
Supported Python Versions
- 3.8
- 3.9
- 3.10
- 3.11
Version info
tap-jira v0.0.1, Meltano SDK v0.34.1
Usage info
melty-bot % tap-jira --help
Usage: tap-jira [OPTIONS]
Execute the Singer tap.
Options:
--version Display the package version.
--about Display package metadata and settings.
--format [json|markdown] Specify output style for --about
--config TEXT Configuration file location or 'ENV' to use
environment variables.
--discover Run the tap in discovery mode.
--test TEXT Use --test to sync a single record for each
stream. Use --test=schema to test schema output
without syncing records.
--catalog PATH Use a Singer catalog file with the tap.
--state PATH Use a bookmarks file for incremental replication.
--help Show this message and exit.
Detected capabilities
- ✅ 'discover'
- ✅ 'catalog'
- ✅ 'state'
- ✅ 'about'
JSON Metadata
{
"name": "tap-jira",
"description": "tap-jira tap class.",
"version": "0.0.1",
"sdk_version": "0.34.1",
"supported_python_versions": [
"3.8",
"3.9",
"3.10",
"3.11"
],
"capabilities": [
"catalog",
"state",
"discover",
"about",
"stream-maps",
"schema-flattening",
"batch"
],
"settings": {
"type": "object",
"properties": {
"start_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Earliest record date to sync"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Latest record date to sync"
},
"domain": {
"type": [
"string"
],
"description": "The Domain for your Jira account, e.g. meltano.atlassian.net"
},
"api_token": {
"type": [
"string"
],
"description": "Jira API Token."
},
"email": {
"type": [
"string"
],
"description": "The user email for your Jira account."
},
"page_size": {
"type": [
"object",
"null"
],
"properties": {
"issues": {
"type": [
"integer",
"null"
],
"default": 100,
"description": "Page size for issues stream"
}
}
},
"stream_maps": {
"type": [
"object",
"null"
],
"properties": {},
"description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
},
"stream_map_config": {
"type": [
"object",
"null"
],
"properties": {},
"description": "User-defined config values to be used within map expressions."
},
"flattening_enabled": {
"type": [
"boolean",
"null"
],
"description": "'True' to enable schema flattening and automatically expand nested properties."
},
"flattening_max_depth": {
"type": [
"integer",
"null"
],
"description": "The max depth to flatten schemas."
},
"batch_config": {
"type": [
"object",
"null"
],
"properties": {
"encoding": {
"type": [
"object",
"null"
],
"properties": {
"format": {
"type": [
"string",
"null"
],
"description": "Format to use for batch files.",
"enum": [
"jsonl",
"parquet"
]
},
"compression": {
"type": [
"string",
"null"
],
"description": "Compression format to use for batch files.",
"enum": [
"gzip",
"none"
]
}
},
"description": "Specifies the format and compression of the batch files."
},
"storage": {
"type": [
"object",
"null"
],
"properties": {
"root": {
"type": [
"string",
"null"
],
"description": "Root path to use when writing batch files."
},
"prefix": {
"type": [
"string",
"null"
],
"description": "Prefix to use when writing batch files."
}
},
"description": "Defines the storage layer to use when writing batch files"
}
}
}
},
"required": [
"domain",
"api_token",
"email"
]
}
}
Discovered streams
audit_records
boards
dashboards
fields
filter_default_share_scopes
filter_searches
groups_pickers
issue_changelog
issue_comments
issue_types
issue_watchers
issue_worklogs
issues
licenses
permission_holders
permissions
priorities
project_role_actors
project_roles
projects
resolutions
screen_schemes
screens
server_info
sprints
statuses_searches
users
workflow_searches
workflow_statuses
workflows
edgarrmondragon
approved these changes
Nov 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to MeltanoLabs/tap-jira#86 (comment)