diff --git a/airbyte-integrations/connectors/source-github/metadata.yaml b/airbyte-integrations/connectors/source-github/metadata.yaml index 9e45ad943bd..649ec7d2c47 100644 --- a/airbyte-integrations/connectors/source-github/metadata.yaml +++ b/airbyte-integrations/connectors/source-github/metadata.yaml @@ -10,7 +10,7 @@ data: connectorSubtype: api connectorType: source definitionId: ef69ef6e-aa7f-4af1-a01d-ef775033524e - dockerImageTag: 1.7.1 + dockerImageTag: 1.7.2 dockerRepository: airbyte/source-github documentationUrl: https://docs.airbyte.com/integrations/sources/github githubIssueLabel: source-github diff --git a/airbyte-integrations/connectors/source-github/poetry.lock b/airbyte-integrations/connectors/source-github/poetry.lock index f185950f28b..7683b941494 100644 --- a/airbyte-integrations/connectors/source-github/poetry.lock +++ b/airbyte-integrations/connectors/source-github/poetry.lock @@ -1,40 +1,39 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. [[package]] name = "airbyte-cdk" -version = "0.72.1" +version = "0.80.0" description = "A framework for writing Airbyte Connectors." optional = false -python-versions = ">=3.8" +python-versions = "<4.0,>=3.9" files = [ - {file = "airbyte-cdk-0.72.1.tar.gz", hash = "sha256:1dbd0a11f3784cfdd5afa9f40315c9a6123e803be91f9f861642a78e7ee14cd9"}, - {file = "airbyte_cdk-0.72.1-py3-none-any.whl", hash = "sha256:849077805442286de99f589ecba4be82491a3d9d3f516ce1a8b0cbaf303db9a4"}, + {file = "airbyte_cdk-0.80.0-py3-none-any.whl", hash = "sha256:060e92323a73674fa4e9e2e4a1eb312b9b9d072c9bbe5fa28f54ef21cb4974f3"}, + {file = "airbyte_cdk-0.80.0.tar.gz", hash = "sha256:1383512a83917fecca5b24cea4c72aa5c561cf96dd464485fbcefda48fe574c5"}, ] [package.dependencies] airbyte-protocol-models = "0.5.1" backoff = "*" cachetools = "*" -Deprecated = ">=1.2,<2.0" +Deprecated = ">=1.2,<1.3" dpath = ">=2.0.1,<2.1.0" genson = "1.2.2" isodate = ">=0.6.1,<0.7.0" Jinja2 = ">=3.1.2,<3.2.0" -jsonref = ">=0.2,<1.0" +jsonref = ">=0.2,<0.3" jsonschema = ">=3.2.0,<3.3.0" pendulum = "<3.0.0" pydantic = ">=1.10.8,<2.0.0" pyrate-limiter = ">=3.1.0,<3.2.0" python-dateutil = "*" -PyYAML = ">=6.0.1" +PyYAML = ">=6.0.1,<7.0.0" requests = "*" -requests-cache = "*" +requests_cache = "*" wcmatch = "8.4" [package.extras] -dev = ["avro (>=1.11.2,<1.12.0)", "cohere (==4.21)", "fastavro (>=1.8.0,<1.9.0)", "freezegun", "langchain (==0.0.271)", "markdown", "mypy", "openai[embeddings] (==0.27.9)", "pandas (==2.0.3)", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "pytest", "pytest-cov", "pytest-httpserver", "pytest-mock", "requests-mock", "tiktoken (==0.4.0)", "unstructured (==0.10.27)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] -file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "unstructured (==0.10.27)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] -sphinx-docs = ["Sphinx (>=4.2,<5.0)", "sphinx-rtd-theme (>=1.0,<2.0)"] +file-based = ["avro (>=1.11.2,<1.12.0)", "fastavro (>=1.8.0,<1.9.0)", "markdown", "pdf2image (==1.16.3)", "pdfminer.six (==20221105)", "pyarrow (>=15.0.0,<15.1.0)", "pytesseract (==0.3.10)", "unstructured.pytesseract (>=0.3.12)", "unstructured[docx,pptx] (==0.10.27)"] +sphinx-docs = ["Sphinx (>=4.2,<4.3)", "sphinx-rtd-theme (>=1.0,<1.1)"] vector-db-based = ["cohere (==4.21)", "langchain (==0.0.271)", "openai[embeddings] (==0.27.9)", "tiktoken (==0.4.0)"] [[package]] @@ -391,13 +390,13 @@ i18n = ["Babel (>=2.7)"] [[package]] name = "jsonref" -version = "0.3.0" -description = "jsonref is a library for automatic dereferencing of JSON Reference objects for Python." +version = "0.2" +description = "An implementation of JSON Reference for Python" optional = false -python-versions = ">=3.3,<4.0" +python-versions = "*" files = [ - {file = "jsonref-0.3.0-py3-none-any.whl", hash = "sha256:9480ad1b500f7e795daeb0ef29f9c55ae3a9ab38fb8d6659b6f4868acb5a5bc8"}, - {file = "jsonref-0.3.0.tar.gz", hash = "sha256:68b330c6815dc0d490dbb3d65ccda265ddde9f7856fd2f3322f971d456ea7549"}, + {file = "jsonref-0.2-py3-none-any.whl", hash = "sha256:b1e82fa0b62e2c2796a13e5401fe51790b248f6d9bf9d7212a3e31a3501b291f"}, + {file = "jsonref-0.2.tar.gz", hash = "sha256:f3c45b121cf6257eafabdc3a8008763aed1cd7da06dbabc59a9e4d2a5e4e6697"}, ] [[package]] @@ -775,6 +774,7 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -1104,4 +1104,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.9,<3.12" -content-hash = "1956fa861a3b061f4c5b4a84025ece587c69e0bada8df463e286cce19d696e7a" +content-hash = "98b8954b1ab0b591e94eef61449f9fa9a00d55ea5c4077ce3fed4df740b07c3e" diff --git a/airbyte-integrations/connectors/source-github/pyproject.toml b/airbyte-integrations/connectors/source-github/pyproject.toml index 4b56030453c..211f2edb5e5 100644 --- a/airbyte-integrations/connectors/source-github/pyproject.toml +++ b/airbyte-integrations/connectors/source-github/pyproject.toml @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",] build-backend = "poetry.core.masonry.api" [tool.poetry] -version = "1.7.1" +version = "1.7.2" name = "source-github" description = "Source implementation for GitHub." authors = [ "Airbyte ",] @@ -17,7 +17,7 @@ include = "source_github" [tool.poetry.dependencies] python = "^3.9,<3.12" -airbyte-cdk = "^0" +airbyte-cdk = "0.80.0" sgqlc = "==16.3" [tool.poetry.scripts] diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/assignees.json b/airbyte-integrations/connectors/source-github/source_github/schemas/assignees.json index e986f61d935..164ef81fcdc 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/assignees.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/assignees.json @@ -3,60 +3,79 @@ "type": "object", "properties": { "repository": { + "description": "Repository where the assignee is assigned", "type": "string" }, "login": { + "description": "Username of the assignee", "type": ["null", "string"] }, "id": { + "description": "Unique identifier of the assignee", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the assignee", "type": ["null", "string"] }, "avatar_url": { + "description": "URL of the assignee's avatar image", "type": ["null", "string"] }, "gravatar_id": { + "description": "Gravatar ID of the assignee", "type": ["null", "string"] }, "url": { + "description": "URL of the assignee's account", "type": ["null", "string"] }, "html_url": { + "description": "URL of the assignee's GitHub profile", "type": ["null", "string"] }, "followers_url": { + "description": "URL of the assignee's followers", "type": ["null", "string"] }, "following_url": { + "description": "URL of the assignee's following", "type": ["null", "string"] }, "gists_url": { + "description": "URL of the assignee's gists", "type": ["null", "string"] }, "starred_url": { + "description": "URL of the assignee's starred items", "type": ["null", "string"] }, "subscriptions_url": { + "description": "URL of the assignee's subscriptions", "type": ["null", "string"] }, "organizations_url": { + "description": "URL of the assignee's organizations", "type": ["null", "string"] }, "repos_url": { + "description": "URL of the assignee's repositories", "type": ["null", "string"] }, "events_url": { + "description": "URL of the assignee's events", "type": ["null", "string"] }, "received_events_url": { + "description": "URL of the assignee's received events", "type": ["null", "string"] }, "type": { + "description": "Type of the assignee's account", "type": ["null", "string"] }, "site_admin": { + "description": "Boolean indicating if the assignee is a site administrator", "type": ["null", "boolean"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/branches.json b/airbyte-integrations/connectors/source-github/source_github/schemas/branches.json index f8eb185d30d..1b48f6b7f0e 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/branches.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/branches.json @@ -3,52 +3,68 @@ "type": "object", "properties": { "repository": { + "description": "Details about the repository associated with the branch.", "type": "string" }, "name": { + "description": "The name of the branch.", "type": ["null", "string"] }, "commit": { + "description": "Details about the commit associated with the branch.", "type": ["null", "object"], "properties": { "sha": { + "description": "The unique identifier of the commit.", "type": ["null", "string"] }, "url": { + "description": "The URL to view details of the commit.", "type": ["null", "string"] } } }, "protected": { + "description": "Indicates if the branch is protected.", "type": ["null", "boolean"] }, "protection": { + "description": "Details about the protection settings of the branch.", "type": ["null", "object"], "properties": { "enabled": { + "description": "Indicates if protection is enabled for the branch.", "type": ["null", "boolean"] }, "required_status_checks": { + "description": "Settings for required status checks on the branch.", "type": ["null", "object"], "properties": { "enforcement_level": { + "description": "Level of enforcement for required status checks.", "type": ["null", "string"] }, "contexts": { + "description": "List of contexts required for status checks to pass.", "type": ["null", "array"], "items": { + "description": "Name of a context.", "type": ["null", "string"] } }, "checks": { + "description": "List of status checks that are required.", "type": ["null", "array"], "items": { + "description": "Details about a specific status check.", "type": "object", "properties": { "context": { + "description": "Context information of the status check.", "type": ["null", "string"] }, "app_id": { + "description": "ID of the application associated with the status check.", "type": ["null", "integer"] } } @@ -59,6 +75,7 @@ } }, "protection_url": { + "description": "URL to manage protection settings for the branch.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/collaborators.json b/airbyte-integrations/connectors/source-github/source_github/schemas/collaborators.json index 97949b9cb86..0da4f3a9f63 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/collaborators.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/collaborators.json @@ -3,81 +3,107 @@ "type": "object", "properties": { "repository": { + "description": "Repository information related to the collaborator", "type": "string" }, "login": { + "description": "Username of the collaborator", "type": ["null", "string"] }, "id": { + "description": "Unique identifier of the collaborator", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the collaborator", "type": ["null", "string"] }, "avatar_url": { + "description": "URL of the collaborator's avatar image", "type": ["null", "string"] }, "gravatar_id": { + "description": "Gravatar ID of the collaborator", "type": ["null", "string"] }, "url": { + "description": "URL of the collaborator's GitHub API endpoint", "type": ["null", "string"] }, "html_url": { + "description": "HTML URL of the collaborator's profile", "type": ["null", "string"] }, "followers_url": { + "description": "URL of the followers of the collaborator", "type": ["null", "string"] }, "following_url": { + "description": "URL of the users followed by the collaborator", "type": ["null", "string"] }, "gists_url": { + "description": "URL of gists created by the collaborator", "type": ["null", "string"] }, "starred_url": { + "description": "URL of the repositories starred by the collaborator", "type": ["null", "string"] }, "subscriptions_url": { + "description": "URL of the repositories subscribed to by the collaborator", "type": ["null", "string"] }, "organizations_url": { + "description": "URL of organizations the collaborator is associated with", "type": ["null", "string"] }, "repos_url": { + "description": "URL of the repositories of the collaborator", "type": ["null", "string"] }, "events_url": { + "description": "URL of the events related to the collaborator", "type": ["null", "string"] }, "received_events_url": { + "description": "URL of events received by the collaborator", "type": ["null", "string"] }, "type": { + "description": "Type of the collaborator (e.g., User)", "type": ["null", "string"] }, "site_admin": { + "description": "Indicates if the collaborator is a site administrator", "type": ["null", "boolean"] }, "role_name": { + "description": "Name of the collaborator's role", "type": ["null", "string"] }, "permissions": { + "description": "The permissions assigned to the collaborators", "type": ["null", "object"], "properties": { "admin": { + "description": "Indicates if the collaborator has admin access", "type": ["null", "boolean"] }, "maintain": { + "description": "Indicates if the collaborator has maintain access", "type": ["null", "boolean"] }, "push": { + "description": "Indicates if the collaborator has push access", "type": ["null", "boolean"] }, "pull": { + "description": "Indicates if the collaborator has pull access", "type": ["null", "boolean"] }, "triage": { + "description": "Indicates if the collaborator has triage access", "type": ["null", "boolean"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/comments.json b/airbyte-integrations/connectors/source-github/source_github/schemas/comments.json index 30290acae3e..f90b4e4838f 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/comments.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/comments.json @@ -3,96 +3,125 @@ "type": "object", "properties": { "repository": { + "description": "Details about the repository to which the comment belongs", "type": "string" }, "id": { + "description": "The unique identifier of the comment", "type": ["null", "integer"] }, "node_id": { + "description": "The unique identifier of the node", "type": ["null", "string"] }, "user": { + "description": "Details about the user who created the comment", "$ref": "user.json" }, "url": { + "description": "The URL of the comment", "type": ["null", "string"] }, "html_url": { + "description": "The URL of the comment on GitHub", "type": ["null", "string"] }, "body": { + "description": "The content of the comment", "type": ["null", "string"] }, "user_id": { + "description": "The unique identifier of the user", "type": ["null", "integer"] }, "created_at": { + "description": "The date and time the comment was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time the comment was last updated", "type": "string", "format": "date-time" }, "issue_url": { + "description": "The URL of the issue to which the comment belongs", "type": ["null", "string"] }, "author_association": { + "description": "The association of the comment author to the repository (e.g., owner, member, collaborator, contributor, etc.)", "type": ["null", "string"] }, "reactions": { + "description": "Reactions (e.g., like, heart, etc.) received on the comment", "$ref": "reactions.json" }, "performed_via_github_app": { + "description": "Details about the GitHub App that performed the action", "type": ["null", "object"], "properties": { "id": { + "description": "The unique identifier of the GitHub App", "type": ["null", "integer"] }, "slug": { + "description": "The slug associated with the GitHub App", "type": ["null", "string"] }, "node_id": { + "description": "The unique identifier of the node for the GitHub App", "type": ["null", "string"] }, "owner": { + "description": "Details about the owner of the GitHub App", "$ref": "user.json" }, "name": { + "description": "The name of the GitHub App", "type": ["null", "string"] }, "description": { + "description": "A description of the GitHub App", "type": ["null", "string"] }, "external_url": { + "description": "The external URL of the GitHub App", "type": ["null", "string"] }, "html_url": { + "description": "The HTML URL of the GitHub App", "type": ["null", "string"] }, "created_at": { + "description": "The date and time the GitHub App was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time the GitHub App was last updated", "type": "string", "format": "date-time" }, "permissions": { + "description": "Permissions granted to the GitHub App", "type": "object", "properties": { "issues": { + "description": "Permission for accessing issues", "type": ["null", "string"] }, "metadata": { + "description": "Permission for accessing metadata", "type": ["null", "string"] }, "pull_requests": { + "description": "Permission for accessing pull requests", "type": ["null", "string"] } } }, "events": { + "description": "Events associated with the GitHub App", "type": "array", "items": { "type": ["null", "string"] diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/commit_comments.json b/airbyte-integrations/connectors/source-github/source_github/schemas/commit_comments.json index a460e60a85c..81a740dd3e8 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/commit_comments.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/commit_comments.json @@ -3,50 +3,65 @@ "type": "object", "properties": { "repository": { + "description": "Details of the repository to which the comment belongs", "type": "string" }, "html_url": { + "description": "The URL to view the comment on GitHub's web interface", "type": ["null", "string"] }, "url": { + "description": "The API URL to fetch the details of the comment", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the comment", "type": ["null", "integer"] }, "node_id": { + "description": "The globally unique identifier for the comment", "type": ["null", "string"] }, "body": { + "description": "The content of the comment", "type": ["null", "string"] }, "path": { + "description": "The file path to which the comment is associated", "type": ["null", "string"] }, "position": { + "description": "The position in the file at which the comment is located", "type": ["null", "integer"] }, "line": { + "description": "The line number in the file at which the comment is located", "type": ["null", "integer"] }, "commit_id": { + "description": "The identifier of the commit to which the comment is associated", "type": ["null", "string"] }, "user": { + "description": "Details of the user who made the comment", "$ref": "user.json" }, "created_at": { + "description": "The date and time when the comment was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time when the comment was last updated", "type": "string", "format": "date-time" }, "author_association": { + "description": "The association of the user who made the comment with the repository (e.g., owner, collaborator, member, contributor)", "type": ["null", "string"] }, "reactions": { + "description": "Reactions (e.g., thumbs up, hooray) associated with the comment", "$ref": "reactions.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/commits.json b/airbyte-integrations/connectors/source-github/source_github/schemas/commits.json index d0016fdc348..185a10d2b7e 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/commits.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/commits.json @@ -3,96 +3,124 @@ "type": "object", "properties": { "repository": { + "description": "The repository where the commit was made.", "type": "string" }, "branch": { + "description": "The branch name where the commit was made.", "type": ["null", "string"] }, "created_at": { + "description": "The creation date and time of the commit.", "type": "string", "format": "date-time" }, "url": { + "description": "URL for accessing the commit data.", "type": ["null", "string"] }, "sha": { + "description": "The SHA of the commit.", "type": ["null", "string"] }, "node_id": { + "description": "The unique identifier of the commit node.", "type": ["null", "string"] }, "html_url": { + "description": "URL for viewing the commit on GitHub.", "type": ["null", "string"] }, "comments_url": { + "description": "URL for accessing comments on the commit.", "type": ["null", "string"] }, "commit": { + "description": "Information about the commit including author, committer, tree, and verification details.", "type": ["null", "object"], "properties": { "author": { + "description": "Information about the author of the commit.", "type": ["null", "object"], "properties": { "name": { + "description": "Name of the author of the commit.", "type": ["null", "string"] }, "email": { + "description": "Email of the author of the commit.", "type": ["null", "string"] }, "date": { + "description": "The date and time of the commit authored.", "type": "string", "format": "date-time" } } }, "committer": { + "description": "Information about the committer who applied the commit.", "type": ["null", "object"], "properties": { "name": { + "description": "Name of the committer of the commit.", "type": ["null", "string"] }, "email": { + "description": "Email of the committer of the commit.", "type": ["null", "string"] }, "date": { + "description": "The date and time of the commit committed.", "type": "string", "format": "date-time" } } }, "message": { + "description": "The commit message.", "type": ["null", "string"] }, "tree": { + "description": "Details about the tree object associated with the commit.", "type": ["null", "object"], "properties": { "sha": { + "description": "SHA of the commit tree.", "type": ["null", "string"] }, "url": { + "description": "URL for accessing the commit tree.", "type": ["null", "string"] } } }, "url": { + "description": "URL for accessing the commit details.", "type": ["null", "string"] }, "comment_count": { + "description": "Number of comments on the commit.", "type": ["null", "integer"] }, "verification": { + "description": "Verification status of the commit.", "type": ["null", "object"], "properties": { "verified": { + "description": "Indicates if the commit is verified.", "type": ["null", "boolean"] }, "reason": { + "description": "Reason for the verification result.", "type": ["null", "string"] }, "signature": { + "description": "The signature used for verification.", "type": ["null", "string"] }, "payload": { + "description": "The payload used for verification.", "type": ["null", "string"] } } @@ -100,23 +128,30 @@ } }, "author": { + "description": "The author of the commit.", "$ref": "user.json" }, "committer": { + "description": "The committer of the commit.", "$ref": "user.json" }, "parents": { + "description": "List of parent commits of the current commit.", "type": ["null", "array"], "items": { + "description": "Details about each parent commit.", "type": ["null", "object"], "properties": { "sha": { + "description": "SHA of the parent commit.", "type": ["null", "string"] }, "url": { + "description": "URL for accessing the parent commit details.", "type": ["null", "string"] }, "html_url": { + "description": "URL for viewing the parent commit on GitHub.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/contributor_activity.json b/airbyte-integrations/connectors/source-github/source_github/schemas/contributor_activity.json index 43bbe08efe1..517b776bc0c 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/contributor_activity.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/contributor_activity.json @@ -4,103 +4,127 @@ "title": "Contributor Activity", "properties": { "name": { + "description": "Name of the contributor", "type": ["null", "string"] }, "email": { + "description": "Email address of the contributor", "type": ["string", "null"] }, "login": { + "description": "GitHub username of the contributor", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the contributor", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the contributor", "type": ["null", "string"] }, "avatar_url": { + "description": "URL of the contributor's avatar image", "type": ["null", "string"], "format": "uri" }, "gravatar_id": { + "description": "ID associated with the contributor's Gravatar image", "type": ["string", "null"] }, "url": { + "description": "URL of the contributor's profile", "type": ["null", "string"], "format": "uri" }, "html_url": { + "description": "URL of the contributor's profile page on GitHub", "type": ["null", "string"], "format": "uri" }, "followers_url": { + "description": "URL of the contributor's followers", "type": ["null", "string"], "format": "uri" }, "following_url": { + "description": "URL of the contributor's following", "type": ["null", "string"] }, "gists_url": { + "description": "URL of the contributor's gists", "type": ["null", "string"] }, "starred_url": { + "description": "URL of the starred repository", "type": ["null", "string"] }, "subscriptions_url": { + "description": "URL of the contributor's subscriptions", "type": ["null", "string"], "format": "uri" }, "organizations_url": { + "description": "URL of the contributor's organizations", "type": ["null", "string"], "format": "uri" }, "repos_url": { + "description": "URL of the contributor's repositories", "type": ["null", "string"], "format": "uri" }, "events_url": { + "description": "URL of the contributor's events", "type": ["null", "string"] }, "repository": { + "description": "Repository the contributor is associated with", "type": ["null", "string"] }, "received_events_url": { + "description": "URL of the events received by the contributor", "type": ["null", "string"], "format": "uri" }, "type": { + "description": "Type of the contributor (e.g., User, Organization)", "type": ["null", "string"] }, "site_admin": { + "description": "Boolean value indicating if the contributor is a site admin", "type": ["null", "boolean"] }, "starred_at": { + "description": "Date and time when the repository was starred by the contributor", "type": ["null", "string"], "format": "date-time" }, "total": { + "description": "Total activity count of the contributor", "type": ["null", "integer"] }, "weeks": { + "description": "Activity data of the contributor per week", "type": "array", "items": { "type": "object", "properties": { "w": { - "type": ["null", "integer"], - "description": "Start of the week, given as a Unix timestamp." + "description": "Start of the week represented as a Unix timestamp", + "type": ["null", "integer"] }, "a": { - "type": ["null", "integer"], - "description": "Number of additions" + "description": "Number of additions made by the contributor", + "type": ["null", "integer"] }, "d": { - "type": ["null", "integer"], - "description": "Number of deletions" + "description": "Number of deletions made by the contributor", + "type": ["null", "integer"] }, "c": { - "type": ["null", "integer"], - "description": "Number of commits" + "description": "Number of commits made by the contributor", + "type": ["null", "integer"] } } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/deployments.json b/airbyte-integrations/connectors/source-github/source_github/schemas/deployments.json index 36fc1945ba3..f5458b46488 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/deployments.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/deployments.json @@ -3,50 +3,65 @@ "type": "object", "properties": { "url": { + "description": "URL to access more details about the deployment.", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the deployment.", "type": ["null", "integer"] }, "node_id": { + "description": "Node identifier for the deployment.", "type": ["null", "string"] }, "task": { + "description": "Indicates the type of task being performed in the deployment.", "type": ["null", "string"] }, "original_environment": { + "description": "Original environment name before promotion or changes.", "type": ["null", "string"] }, "environment": { + "description": "The deployment environment (e.g., staging, production).", "type": ["null", "string"] }, "description": { + "description": "Description provided for the deployment.", "type": ["null", "string"] }, "created_at": { + "description": "The timestamp when the deployment was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The timestamp when the deployment was last updated.", "type": "string", "format": "date-time" }, "statuses_url": { + "description": "URL to retrieve the statuses of the deployment.", "type": ["null", "string"] }, "repository_url": { + "description": "URL of the repository where the deployment originated.", "type": ["null", "string"] }, "creator": { + "description": "Details about the user who created the deployment.", "$ref": "user.json" }, "sha": { + "description": "The SHA hash of the deployment.", "type": ["null", "string"] }, "ref": { + "description": "The Git ref that was deployed.", "type": ["null", "string"] }, "payload": { + "description": "Additional information or data associated with the deployment.", "oneOf": [ { "type": "object", @@ -62,15 +77,19 @@ ] }, "transient_environment": { + "description": "Indicates if the environment is temporary or not persistent.", "type": ["null", "boolean"] }, "production_environment": { + "description": "Indicates if the deployment is in a production environment.", "type": ["null", "boolean"] }, "performed_via_github_app": { + "description": "Indicates if the deployment was performed via a GitHub App.", "type": ["null", "string"] }, "repository": { + "description": "Details about the repository where the deployment originated.", "type": "string" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/events.json b/airbyte-integrations/connectors/source-github/source_github/schemas/events.json index 698933d6d5e..53df88231f1 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/events.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/events.json @@ -3,60 +3,77 @@ "type": "object", "properties": { "repository": { + "description": "Deprecated. Use 'repo' field instead.", "type": "string" }, "type": { + "description": "Type of event that occurred.", "type": ["null", "string"] }, "public": { + "description": "Indicates whether the event is public or not.", "type": ["null", "boolean"] }, "payload": { + "description": "Additional event-specific data.", "type": ["null", "object"], "properties": {} }, "repo": { + "description": "Information about the repository where the event occurred.", "type": ["null", "object"], "properties": { "id": { + "description": "Unique identifier for the repository.", "type": ["null", "integer"] }, "name": { + "description": "Name of the repository.", "type": ["null", "string"] }, "url": { + "description": "URL of the repository.", "type": ["null", "string"] } } }, "actor": { + "description": "Information about the user performing the event.", "$ref": "user.json" }, "org": { + "description": "Information about the organization associated with the event.", "type": ["null", "object"], "properties": { "id": { + "description": "Unique identifier for the organization.", "type": ["null", "integer"] }, "login": { + "description": "Login of the organization.", "type": ["null", "string"] }, "gravatar_id": { + "description": "Gravatar ID of the organization.", "type": ["null", "string"] }, "url": { + "description": "URL of the organization.", "type": ["null", "string"] }, "avatar_url": { + "description": "URL of the organization's avatar.", "type": ["null", "string"] } } }, "created_at": { + "description": "The timestamp when the event occurred.", "type": "string", "format": "date-time" }, "id": { + "description": "Unique identifier for the event.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_events.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_events.json index 9fc4d62fd34..2c01a54b1ea 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_events.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_events.json @@ -3,37 +3,48 @@ "type": "object", "properties": { "repository": { + "description": "Details about a repository", "type": "string" }, "id": { + "description": "The unique ID of the event", "type": ["null", "integer"] }, "node_id": { + "description": "The unique node ID of the event", "type": ["null", "string"] }, "url": { + "description": "The URL of the event", "type": ["null", "string"] }, "actor": { + "description": "The user who performed the event", "$ref": "user.json" }, "event": { + "description": "The type of event that occurred", "type": ["null", "string"] }, "commit_id": { + "description": "The ID of the commit related to the event", "type": ["null", "string"] }, "commit_url": { + "description": "The URL to the commit related to the event", "type": ["null", "string"] }, "created_at": { + "description": "The timestamp when the event was created", "type": "string", "format": "date-time" }, "state_reason": { + "description": "The reason associated with the change in state of the issue event.", "type": ["null", "string"] }, "label": { + "description": "Details about a label", "type": ["null", "object"], "properties": { "name": { @@ -45,45 +56,57 @@ } }, "review_requester": { + "description": "The user who requested a review", "$ref": "user.json" }, "issue": { + "description": "Information about the associated issue", "type": ["null", "object"], "properties": { "active_lock_reason": { + "description": "The reason the issue is locked", "type": ["null", "string"] }, "assignee": { + "description": "The user assigned to the issue", "$ref": "user.json" }, "assignees": { + "description": "List of users assigned to the issue", "type": ["null", "array"], "items": { "$ref": "user.json" } }, "author_association": { + "description": "The association of the event creator to the issue", "type": ["null", "string"] }, "closed_at": { + "description": "The timestamp when the issue was closed", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "The timestamp when the issue was last updated", "type": ["null", "string"], "format": "date-time" }, "comments": { + "description": "Number of comments on the issue", "type": ["null", "integer"] }, "draft": { + "description": "Indicates if the issue is a draft", "type": ["null", "boolean"] }, "created_at": { + "description": "The timestamp when the issue was created", "type": ["null", "string"], "format": "date-time" }, "labels": { + "description": "List of labels attached to the issue", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -113,6 +136,7 @@ } }, "locked": { + "description": "Indicates if the issue is locked", "type": ["null", "boolean"] }, "milestone": { @@ -125,58 +149,81 @@ "type": ["null", "string"] }, "pull_request": { + "description": "Details of the pull request linked to the issue", "type": ["null", "object"], "properties": { "merged_at": { + "description": "The timestamp when the pull request was merged", "type": ["string", "null"], "format": "date-time" }, - "diff_url": { "type": ["string", "null"] }, - "html_url": { "type": ["string", "null"] }, - "patch_url": { "type": ["string", "null"] }, - "url": { "type": ["string", "null"] } + "diff_url": { + "type": ["string", "null"] + }, + "html_url": { + "type": ["string", "null"] + }, + "patch_url": { + "type": ["string", "null"] + }, + "url": { + "type": ["string", "null"] + } } }, "timeline_url": { + "description": "The URL to view the issue timeline", "type": ["null", "string"] }, "reactions": { "$ref": "reactions.json" }, "id": { + "description": "The unique ID of the issue", "type": ["null", "integer"] }, "node_id": { + "description": "The unique node ID of the issue", "type": ["null", "string"] }, "url": { + "description": "The URL of the issue", "type": ["null", "string"] }, "repository_url": { + "description": "The URL of the repository the issue is in", "type": ["null", "string"] }, "labels_url": { + "description": "The URL to view labels on the issue", "type": ["null", "string"] }, "comments_url": { + "description": "The URL to view comments on the issue", "type": ["null", "string"] }, "events_url": { + "description": "The URL to view events related to the issue", "type": ["null", "string"] }, "html_url": { + "description": "The URL to view the issue on GitHub", "type": ["null", "string"] }, "number": { + "description": "The issue number", "type": ["null", "integer"] }, "state": { + "description": "The state of the issue (open, closed, etc.)", "type": ["null", "string"] }, "title": { + "description": "The title of the issue", "type": ["null", "string"] }, "body": { + "description": "The body content of the issue", "type": ["null", "string"] }, "user": { @@ -185,6 +232,7 @@ } }, "performed_via_github_app": { + "description": "Information about the GitHub App that triggered the event", "type": ["null", "object"], "properties": { "id": { @@ -209,17 +257,21 @@ "type": ["null", "string"] }, "html_url": { + "description": "The URL to view the app on GitHub", "type": ["null", "string"] }, "created_at": { + "description": "The timestamp when the app was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The timestamp when the app was last updated", "type": "string", "format": "date-time" }, "permissions": { + "description": "Permissions of the app", "type": ["null", "object"], "properties": { "actions": { @@ -276,6 +328,7 @@ } }, "events": { + "description": "List of events related to the app", "type": "array", "items": { "type": ["null", "string"] @@ -284,6 +337,7 @@ } }, "milestone": { + "description": "Details about a milestone", "type": ["null", "object"], "properties": { "title": { @@ -292,12 +346,15 @@ } }, "assignee": { + "description": "The user assigned to the issue", "$ref": "user.json" }, "assigner": { + "description": "The user who assigned the assignee to the issue", "$ref": "user.json" }, "project_card": { + "description": "Details about a project card", "type": ["null", "object"], "properties": { "id": { @@ -321,20 +378,25 @@ } }, "dismissed_review": { + "description": "Details about a dismissed review", "type": ["null", "object"], "properties": { "state": { + "description": "The state of the review dismissal", "type": ["null", "string"] }, "review_id": { + "description": "The ID of the review that was dismissed", "type": ["null", "integer"] }, "dismissal_message": { + "description": "The message explaining the dismissal of the review", "type": ["null", "string"] } } }, "requested_team": { + "description": "Details about a team requested for review", "type": ["null", "object"], "properties": { "name": { @@ -371,6 +433,7 @@ "type": ["null", "string"] }, "parent": { + "description": "Details about the parent team", "type": ["null", "object"], "properties": { "name": { @@ -411,6 +474,7 @@ } }, "rename": { + "description": "Details about a rename action", "type": ["null", "object"], "properties": { "from": { @@ -422,6 +486,7 @@ } }, "requested_reviewer": { + "description": "The user requested to review", "$ref": "user.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_labels.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_labels.json index 0baf24a95ba..1ad6ec6940f 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_labels.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_labels.json @@ -3,27 +3,35 @@ "type": "object", "properties": { "repository": { + "description": "Information about the repository to which the label belongs.", "type": "string" }, "id": { + "description": "Unique identifier for the label.", "type": ["null", "integer"] }, "node_id": { + "description": "A unique identifier for the label at the GitHub API level.", "type": ["null", "string"] }, "url": { + "description": "URL that provides direct access to the label resource.", "type": ["null", "string"] }, "name": { + "description": "The name of the label used for identification.", "type": ["null", "string"] }, "description": { + "description": "Descriptive text providing additional information about the label.", "type": ["null", "string"] }, "color": { + "description": "The color associated with the label, typically used for visual representation.", "type": ["null", "string"] }, "default": { + "description": "Indicates if the label is the default label for the repository.", "type": ["null", "boolean"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_milestones.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_milestones.json index 28cd6dede99..71e975860ad 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_milestones.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_milestones.json @@ -3,57 +3,74 @@ "type": "object", "properties": { "repository": { + "description": "Repository to which the milestone belongs", "type": "string" }, "url": { + "description": "API endpoint URL for the milestone", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the milestone in a web browser", "type": ["null", "string"] }, "labels_url": { + "description": "URL to fetch labels associated with the milestone", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the milestone", "type": ["null", "integer"] }, "node_id": { + "description": "Unique identifier for the milestone node", "type": ["null", "string"] }, "number": { + "description": "Numeric identifier for the milestone", "type": ["null", "integer"] }, "state": { + "description": "Current state of the milestone (open/closed)", "type": ["null", "string"] }, "title": { + "description": "Title or name of the milestone", "type": ["null", "string"] }, "description": { + "description": "Brief description of the milestone", "type": ["null", "string"] }, "creator": { + "description": "User who created the milestone", "$ref": "user.json" }, "open_issues": { + "description": "Total number of open issues within the milestone", "type": ["null", "integer"] }, "closed_issues": { + "description": "Total number of issues closed within the milestone", "type": ["null", "integer"] }, "created_at": { + "description": "Timestamp indicating when the milestone was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Timestamp indicating when the milestone was last updated", "type": "string", "format": "date-time" }, "closed_at": { + "description": "Timestamp indicating when the milestone was closed", "type": ["null", "string"], "format": "date-time" }, "due_on": { + "description": "Timestamp indicating when the milestone is due", "type": ["null", "string"], "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_reactions.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_reactions.json index dc3700343ef..4cdec0d387b 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_reactions.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_reactions.json @@ -3,25 +3,32 @@ "type": ["null", "object"], "properties": { "id": { + "description": "The unique identifier of the reaction", "type": ["null", "integer"] }, "node_id": { + "description": "The unique identifier of the reaction node", "type": ["null", "string"] }, "content": { + "description": "The type of reaction (e.g., thumbs up, thumbs down, heart)", "type": ["null", "string"] }, "created_at": { + "description": "The date and time when the reaction was created", "type": "string", "format": "date-time" }, "user": { + "description": "The user who created the reaction", "$ref": "user_graphql.json" }, "repository": { + "description": "The repository to which the reaction belongs", "type": "string" }, "issue_number": { + "description": "The issue number to which the reaction belongs", "type": "integer" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_timeline_events.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_timeline_events.json index 9c48fb4dbd6..ee652efce6e 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issue_timeline_events.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issue_timeline_events.json @@ -260,12 +260,15 @@ "additionalProperties": true, "properties": { "repository": { + "description": "The repository associated with the issue", "type": "string" }, "issue_number": { + "description": "The number of the issue", "type": "integer" }, "labeled": { + "description": "Event representing a label being added to the issue", "$ref": "#/definitions/base_event", "label": { "type": ["null", "object"], @@ -280,6 +283,7 @@ } }, "unlabeled": { + "description": "Event representing a label being removed from the issue", "$ref": "#/definitions/base_event", "label": { "type": "object", @@ -294,6 +298,7 @@ } }, "milestoned": { + "description": "Event representing the assignment of a milestone to the issue", "$ref": "#/definitions/base_event", "milestone": { "type": "object", @@ -305,6 +310,7 @@ } }, "demilestoned": { + "description": "Event representing the removal of a milestone", "$ref": "#/definitions/base_event", "milestone": { "type": "object", @@ -316,6 +322,7 @@ } }, "renamed": { + "description": "Event representing the renaming of an entity", "$ref": "#/definitions/base_event", "rename": { "type": "object", @@ -330,6 +337,7 @@ } }, "review_requested": { + "description": "Event representing a review request being made", "$ref": "#/definitions/base_event", "review_requester": { "type": "object", @@ -583,6 +591,7 @@ } }, "review_request_removed": { + "description": "Event representing a review request being removed", "$ref": "#/definitions/base_event", "review_requester": { "type": "object", @@ -836,6 +845,7 @@ } }, "review_dismissed": { + "description": "Event representing a review being dismissed", "$ref": "#/definitions/base_event", "dismissed_review": { "type": "object", @@ -856,26 +866,41 @@ } }, "locked": { + "description": "Event representing the issue being locked", "$ref": "#/definitions/base_event", "lock_reason": { "type": ["string", "null"] } }, "added_to_project": { + "description": "Event representing an issue being added to a project board", "$ref": "#/definitions/base_event", "project_card": { "type": "object", "properties": { - "id": { "type": "integer" }, - "url": { "type": "string" }, - "project_id": { "type": "integer" }, - "project_url": { "type": "string" }, - "column_name": { "type": "string" }, - "previous_column_name": { "type": "string" } + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } } } }, "moved_columns_in_project": { + "description": "Event representing the movement of columns in a project board", "$ref": "#/definitions/base_event", "project_card": { "type": "object", @@ -904,6 +929,7 @@ } }, "removed_from_project": { + "description": "Event representing the removal of the issue from a project board", "$ref": "#/definitions/base_event", "project_card": { "type": "object", @@ -932,124 +958,239 @@ } }, "converted_note_to_issue": { + "description": "Event representing a note being converted to an issue", "$ref": "#/definitions/base_event", "project_card": { "type": "object", "properties": { - "id": { "type": "integer" }, - "url": { "type": "string" }, - "project_id": { "type": "integer" }, - "project_url": { "type": "string" }, - "column_name": { "type": "string" }, - "previous_column_name": { "type": "string" } + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } } } }, "comment": { + "description": "Event representing a comment being added to the issue", "$ref": "events/comment.json" }, "cross-referenced": { + "description": "Event representing a cross reference being made", "$ref": "events/cross_referenced.json" }, "committed": { + "description": "Event representing a commit being made", "$ref": "events/committed.json" }, "closed": { + "description": "Event representing the issue being closed", "$ref": "#/definitions/base_event" }, "head_ref_deleted": { + "description": "Event representing the deletion of a branch", "$ref": "#/definitions/base_event" }, "head_ref_restored": { + "description": "Event representing the restoration of a branch", "$ref": "#/definitions/base_event" }, "reopened": { + "description": "Event representing the reopening of the issue", "$ref": "#/definitions/base_event" }, "reviewed": { + "description": "Event representing a review being completed", "$ref": "events/reviewed.json" }, "commented": { + "description": "Event representing a comment being added to the issue", "$ref": "events/comment.json" }, "commit_commented": { + "description": "Event representing a comment being added to a commit", "$ref": "events/commented.json" }, "assigned": { + "description": "Event representing an issue being assigned to a user", "$ref": "#/definitions/base_event", "assignee": { + "description": "The user who has been assigned to the issue", "title": "Simple User", - "description": "A GitHub user.", "type": "object", "properties": { - "name": { "type": ["string", "null"] }, - "email": { "type": ["string", "null"] }, - "login": { "type": "string" }, - "id": { "type": "integer" }, - "node_id": { "type": "string" }, - "avatar_url": { "type": "string" }, - "gravatar_id": { "type": ["string", "null"] }, - "url": { "type": "string" }, - "html_url": { "type": "string" }, - "followers_url": { "type": "string" }, - "following_url": { "type": "string" }, - "gists_url": { "type": "string" }, - "starred_url": { "type": "string" }, - "subscriptions_url": { "type": "string" }, - "organizations_url": { "type": "string" }, - "repos_url": { "type": "string" }, - "events_url": { "type": "string" }, - "received_events_url": { "type": "string" }, - "type": { "type": "string" }, - "site_admin": { "type": "boolean" }, - "starred_at": { "type": "string", "format": "date-time" } + "name": { + "type": ["string", "null"] + }, + "email": { + "type": ["string", "null"] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": ["string", "null"] + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "format": "date-time" + } } } }, "unassigned": { + "description": "Event representing the unassignment of a user from the issue", "$ref": "#/definitions/base_event", "assignee": { + "description": "The user who was previously assigned to the issue", "title": "Simple User", - "description": "A GitHub user.", "type": "object", "properties": { - "name": { "type": ["string", "null"] }, - "email": { "type": ["string", "null"] }, - "login": { "type": "string" }, - "id": { "type": "integer" }, - "node_id": { "type": "string" }, - "avatar_url": { "type": "string" }, - "gravatar_id": { "type": ["string", "null"] }, - "url": { "type": "string" }, - "html_url": { "type": "string" }, - "followers_url": { "type": "string" }, - "following_url": { "type": "string" }, - "gists_url": { "type": "string" }, - "starred_url": { "type": "string" }, - "subscriptions_url": { "type": "string" }, - "organizations_url": { "type": "string" }, - "repos_url": { "type": "string" }, - "events_url": { "type": "string" }, - "received_events_url": { "type": "string" }, - "type": { "type": "string" }, - "site_admin": { "type": "boolean" }, - "starred_at": { "type": "string", "format": "date-time" } + "name": { + "type": ["string", "null"] + }, + "email": { + "type": ["string", "null"] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": ["string", "null"] + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "format": "date-time" + } } } }, "state_change": { + "description": "Event representing a change in state", "$ref": "#/definitions/base_event", "state_reason": { "type": ["string", "null"] } }, "connected": { + "description": "Event representing a connection being established", "$ref": "#/definitions/base_event" }, "auto_squash_enabled": { + "description": "Event representing auto-squash being enabled on a commit", "$ref": "#/definitions/base_event" }, "merged": { + "description": "Event representing the merging of the issue", "$ref": "#/definitions/base_event" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/issues.json b/airbyte-integrations/connectors/source-github/source_github/schemas/issues.json index d1d86671291..4b77a03c823 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/issues.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/issues.json @@ -3,278 +3,362 @@ "type": "object", "properties": { "repository": { + "description": "Repository where the issue is located.", "type": "string" }, "id": { + "description": "Unique identifier for the issue.", "type": ["null", "integer"] }, "node_id": { + "description": "Unique identifier for the issue node.", "type": ["null", "string"] }, "url": { + "description": "URL to retrieve more details about the issue.", "type": ["null", "string"] }, "repository_url": { + "description": "URL to retrieve more details about the repository.", "type": ["null", "string"] }, "labels_url": { + "description": "URL to retrieve labels associated with the issue.", "type": ["null", "string"] }, "comments_url": { + "description": "URL to retrieve comments on the issue.", "type": ["null", "string"] }, "events_url": { + "description": "URL to retrieve events related to the issue.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the issue on GitHub.", "type": ["null", "string"] }, "number": { + "description": "Number of the issue.", "type": ["null", "integer"] }, "state": { + "description": "State of the issue (open/closed).", "type": ["null", "string"] }, "title": { + "description": "Title of the issue.", "type": ["null", "string"] }, "user": { + "description": "User who opened the issue.", "$ref": "user.json" }, "body": { + "description": "The content of the issue.", "type": ["null", "string"] }, "user_id": { + "description": "Identifier of the user who opened the issue.", "type": ["null", "integer"] }, "labels": { + "description": "List of labels attached to the issue.", "type": ["null", "array"], "items": { "type": ["null", "object"], "properties": { "id": { + "description": "Unique identifier for the label.", "type": ["null", "integer"] }, "node_id": { + "description": "Unique identifier for the label node.", "type": ["null", "string"] }, "url": { + "description": "URL to retrieve more details about the label.", "type": ["null", "string"] }, "name": { + "description": "Name of the label.", "type": ["null", "string"] }, "description": { + "description": "Description of the label.", "type": ["null", "string"] }, "color": { + "description": "Color of the label.", "type": ["null", "string"] }, "default": { + "description": "Flag indicating if the label is a default label.", "type": ["null", "boolean"] } } } }, "assignee": { + "description": "User assigned to the issue.", "$ref": "user.json" }, "assignees": { + "description": "List of users assigned to the issue.", "type": ["null", "array"], "items": { + "description": "List of users assigned to the issue.", "$ref": "user.json" } }, "milestone": { + "description": "Details of the milestone associated with the issue.", "type": ["null", "object"], "properties": { "url": { + "description": "URL to retrieve more details about the milestone.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the milestone on GitHub.", "type": ["null", "string"] }, "labels_url": { + "description": "URL to retrieve labels associated with the milestone.", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the milestone.", "type": ["null", "integer"] }, "node_id": { + "description": "Unique identifier for the milestone node.", "type": ["null", "string"] }, "number": { + "description": "Number of the milestone.", "type": ["null", "integer"] }, "state": { + "description": "State of the milestone (open/closed).", "type": ["null", "string"] }, "title": { + "description": "Title of the milestone.", "type": ["null", "string"] }, "description": { + "description": "Description of the milestone.", "type": ["null", "string"] }, "creator": { + "description": "User who created the milestone.", "$ref": "user.json" }, "open_issues": { + "description": "Number of open issues in the milestone.", "type": ["null", "integer"] }, "closed_issues": { + "description": "Number of closed issues in the milestone.", "type": ["null", "integer"] }, "created_at": { + "description": "Date and time when the milestone was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the milestone was last updated.", "type": "string", "format": "date-time" }, "closed_at": { + "description": "Date and time when the milestone was closed.", "type": ["null", "string"], "format": "date-time" }, "due_on": { + "description": "Date and time when the milestone is due.", "type": ["null", "string"], "format": "date-time" } } }, "locked": { + "description": "Flag indicating if the issue is locked.", "type": ["null", "boolean"] }, "active_lock_reason": { + "description": "Reason for the active lock on the issue, if any.", "type": ["null", "string"] }, "comments": { + "description": "Number of comments on the issue.", "type": ["null", "integer"] }, "pull_request": { + "description": "Details of a linked pull request, if the issue is a pull request.", "type": ["null", "object"], "properties": { "url": { + "description": "URL to retrieve more details about the pull request.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the pull request on GitHub.", "type": ["null", "string"] }, "diff_url": { + "description": "URL to view the diff of the pull request.", "type": ["null", "string"] }, "patch_url": { + "description": "URL to view the patch of the pull request.", "type": ["null", "string"] }, "merged_at": { + "description": "Date and time when the pull request was merged.", "type": ["null", "string"], "format": "date-time" } } }, "closed_at": { + "description": "Date and time when the issue was closed.", "type": ["null", "string"], "format": "date-time" }, "created_at": { + "description": "Date and time when the issue was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the issue was last updated.", "type": "string", "format": "date-time" }, "author_association": { + "description": "The association of the author with the issue.", "type": ["null", "string"] }, "draft": { + "description": "Flag indicating if the issue is a draft.", "type": ["null", "boolean"] }, "reactions": { + "description": "Reactions to the issue.", "$ref": "reactions.json" }, "timeline_url": { + "description": "URL to retrieve the timeline of the issue.", "type": ["null", "string"] }, "performed_via_github_app": { + "description": "Information related to the GitHub App that performed actions on the issue.", "type": ["null", "object"], "properties": { "id": { + "description": "Unique identifier for the GitHub app.", "type": ["null", "integer"] }, "slug": { + "description": "Slug of the GitHub app.", "type": ["null", "string"] }, "node_id": { + "description": "Unique identifier for the GitHub app node.", "type": ["null", "string"] }, "owner": { + "description": "User who owns the GitHub app.", "$ref": "user.json" }, "name": { + "description": "Name of the GitHub app.", "type": ["null", "string"] }, "description": { + "description": "Description of the GitHub app.", "type": ["null", "string"] }, "external_url": { + "description": "External URL associated with the GitHub app.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the GitHub app on GitHub.", "type": ["null", "string"] }, "created_at": { + "description": "Date and time when the GitHub app was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the GitHub app was last updated.", "type": "string", "format": "date-time" }, "permissions": { + "description": "Permissions granted to the GitHub App on the issue.", "type": ["null", "object"], "properties": { "issues": { + "description": "Permissions related to issues for the GitHub app.", "type": ["null", "string"] }, "metadata": { + "description": "Permissions related to metadata for the GitHub app.", "type": ["null", "string"] }, "pull_requests": { + "description": "Permissions related to pull requests for the GitHub app.", "type": ["null", "string"] }, "actions": { + "description": "Permissions related to actions for the GitHub app.", "type": ["null", "string"] }, "checks": { + "description": "Permissions related to checks for the GitHub app.", "type": ["null", "string"] }, "contents": { + "description": "Permissions related to contents for the GitHub app.", "type": ["null", "string"] }, "deployments": { + "description": "Permissions related to deployments for the GitHub app.", "type": ["null", "string"] }, "discussions": { + "description": "Permissions related to discussions for the GitHub app.", "type": ["null", "string"] }, "repository_projects": { + "description": "Permissions related to repository projects for the GitHub app.", "type": ["null", "string"] }, "statuses": { + "description": "Permissions related to statuses for the GitHub app.", "type": ["null", "string"] } } }, "events": { + "description": "List of events performed by the GitHub App on the issue.", "type": "array", "items": { + "description": "List of events performed by the GitHub app.", "type": ["null", "string"] } } } }, "state_reason": { + "description": "Reason for the state of the issue.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/organizations.json b/airbyte-integrations/connectors/source-github/source_github/schemas/organizations.json index cab08b9532c..be6f03d803d 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/organizations.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/organizations.json @@ -3,194 +3,256 @@ "type": "object", "properties": { "login": { + "description": "Login username of the organization.", "type": ["null", "string"] }, "id": { + "description": "Unique identifier of the organization.", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the organization.", "type": ["null", "string"] }, "url": { + "description": "URL to the organization's API endpoint.", "type": ["null", "string"] }, "repos_url": { + "description": "URL to fetch repositories of the organization.", "type": ["null", "string"] }, "events_url": { + "description": "URL to fetch events related to the organization.", "type": ["null", "string"] }, "hooks_url": { + "description": "URL to manage webhooks for the organization.", "type": ["null", "string"] }, "issues_url": { + "description": "URL to fetch issues related to the organization.", "type": ["null", "string"] }, "members_url": { + "description": "URL to fetch members of the organization.", "type": ["null", "string"] }, "public_members_url": { + "description": "URL to fetch public members of the organization.", "type": ["null", "string"] }, "avatar_url": { + "description": "URL to the avatar image of the organization.", "type": ["null", "string"] }, "description": { + "description": "Description of the organization.", "type": ["null", "string"] }, "name": { + "description": "Name of the organization.", "type": ["null", "string"] }, "company": { + "description": "Name of the company associated with the organization.", "type": ["null", "string"] }, "blog": { + "description": "URL to the blog of the organization.", "type": ["null", "string"] }, "location": { + "description": "Physical location of the organization.", "type": ["null", "string"] }, "email": { + "description": "Email address of the organization.", "type": ["null", "string"] }, "twitter_username": { + "description": "Twitter username of the organization.", "type": ["null", "string"] }, "is_verified": { + "description": "Indicates if the organization is verified.", "type": ["null", "boolean"] }, "has_organization_projects": { + "description": "Indicates if the organization has projects.", "type": ["null", "boolean"] }, "has_repository_projects": { + "description": "Indicates if the organization has projects tied to repositories.", "type": ["null", "boolean"] }, "public_repos": { + "description": "Number of public repositories owned by the organization.", "type": ["null", "integer"] }, "public_gists": { + "description": "Number of public gists created by the organization.", "type": ["null", "integer"] }, "followers": { + "description": "Number of followers the organization has.", "type": ["null", "integer"] }, "following": { + "description": "Number of accounts the organization is following.", "type": ["null", "integer"] }, "html_url": { + "description": "URL to the organization's profile page.", "type": ["null", "string"] }, "created_at": { + "description": "Timestamp indicating when the organization was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Timestamp indicating when the organization was last updated.", "type": "string", "format": "date-time" }, "archived_at": { + "description": "Timestamp indicating when the organization was archived.", "type": ["null", "string"], "format": "date-time" }, "type": { + "description": "Type of the organization.", "type": ["null", "string"] }, "total_private_repos": { + "description": "Total number of private repositories owned by the organization.", "type": ["null", "integer"] }, "owned_private_repos": { + "description": "Number of private repositories owned by the organization.", "type": ["null", "integer"] }, "private_gists": { + "description": "Number of private gists created by the organization.", "type": ["null", "integer"] }, "disk_usage": { + "description": "Disk space used by the organization.", "type": ["null", "integer"] }, "collaborators": { + "description": "Number of collaborators the organization has.", "type": ["null", "integer"] }, "billing_email": { + "description": "Email address associated with the organization's billing.", "type": ["null", "string"] }, "default_repository_permission": { + "description": "Default permission level for new repositories.", "type": ["null", "string"] }, "members_can_create_repositories": { + "description": "Indicates if members can create repositories.", "type": ["null", "boolean"] }, "two_factor_requirement_enabled": { + "description": "Indicates if two-factor authentication is required for the organization.", "type": ["null", "boolean"] }, "members_allowed_repository_creation_type": { + "description": "Type of repositories members are allowed to create.", "type": ["null", "string"] }, "members_can_create_public_repositories": { + "description": "Indicates if members can create public repositories.", "type": ["null", "boolean"] }, "members_can_create_private_repositories": { + "description": "Indicates if members can create private repositories.", "type": ["null", "boolean"] }, "members_can_create_internal_repositories": { + "description": "Indicates if members can create internal repositories.", "type": ["null", "boolean"] }, "members_can_create_pages": { + "description": "Indicates if members can create pages.", "type": ["null", "boolean"] }, "members_can_fork_private_repositories": { + "description": "Indicates if members can fork private repositories.", "type": ["null", "boolean"] }, "web_commit_signoff_required": { + "description": "Indicates if web commit signoff is required for the organization.", "type": ["null", "boolean"] }, "members_can_create_public_pages": { + "description": "Indicates if members can create public pages.", "type": ["null", "boolean"] }, "members_can_create_private_pages": { + "description": "Indicates if members can create private pages.", "type": ["null", "boolean"] }, "plan": { + "description": "Information about the subscription plan of the organization.", "type": ["null", "object"], "properties": { "name": { + "description": "Name of the organization's plan.", "type": ["null", "string"] }, "space": { + "description": "Space available in the organization's plan.", "type": ["null", "integer"] }, "private_repos": { + "description": "Number of private repositories allowed in the organization's plan.", "type": ["null", "integer"] }, "filled_seats": { + "description": "Number of filled seats in the organization's plan.", "type": ["null", "integer"] }, "seats": { + "description": "Total number of seats in the organization's plan.", "type": ["null", "integer"] } } }, "advanced_security_enabled_for_new_repositories": { + "description": "Indicates if advanced security features are enabled for new repositories within the organization.", "type": ["null", "boolean"] }, "dependabot_alerts_enabled_for_new_repositories": { + "description": "Indicates if dependabot alerts are enabled for new repositories within the organization.", "type": ["null", "boolean"] }, "dependabot_security_updates_enabled_for_new_repositories": { + "description": "Indicates if dependabot security updates are enabled for new repositories within the organization.", "type": ["null", "boolean"] }, "dependency_graph_enabled_for_new_repositories": { + "description": "Indicates if dependency graph is enabled for new repositories within the organization.", "type": ["null", "boolean"] }, "secret_scanning_enabled_for_new_repositories": { + "description": "Indicates if secret scanning is enabled for new repositories within the organization.", "type": ["null", "boolean"] }, "secret_scanning_push_protection_enabled_for_new_repositories": { + "description": "Indicates if secret scanning push protection is enabled for new repositories.", "type": ["null", "boolean"] }, "secret_scanning_push_protection_custom_link_enabled": { + "description": "Indicates if custom link for secret scanning push protection is enabled.", "type": ["null", "boolean"] }, "secret_scanning_push_protection_custom_link": { + "description": "Custom link for secret scanning push protection.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/project_cards.json b/airbyte-integrations/connectors/source-github/source_github/schemas/project_cards.json index 4c8b809c135..ceed2763677 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/project_cards.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/project_cards.json @@ -3,47 +3,61 @@ "type": "object", "properties": { "url": { + "description": "The URL to access the project card.", "type": ["null", "string"] }, "project_url": { + "description": "The URL to access the project that includes the project card.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the project card.", "type": ["null", "integer"] }, "node_id": { + "description": "The unique Node ID of the project card.", "type": ["null", "string"] }, "note": { + "description": "Any notes associated with the project card.", "type": ["null", "string"] }, "archived": { + "description": "Indicates whether the project card is archived or not.", "type": ["null", "boolean"] }, "creator": { + "description": "The user who created the project card.", "$ref": "user.json" }, "created_at": { + "description": "The date and time when the project card was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time when the project card was last updated.", "type": "string", "format": "date-time" }, "column_url": { + "description": "The URL to access the project column associated with the project card.", "type": ["null", "string"] }, "content_url": { + "description": "The URL that provides direct access to the project card's content.", "type": ["null", "string"] }, "repository": { + "description": "The repository to which the project card is linked.", "type": "string" }, "project_id": { + "description": "The unique identifier of the project to which the project card belongs.", "type": "integer" }, "column_id": { + "description": "The unique identifier of the project column that the project card belongs to.", "type": "integer" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/project_columns.json b/airbyte-integrations/connectors/source-github/source_github/schemas/project_columns.json index 3711516fc76..b9f7ce11935 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/project_columns.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/project_columns.json @@ -3,35 +3,45 @@ "type": "object", "properties": { "url": { + "description": "The API URL to fetch more details about this project column.", "type": ["null", "string"] }, "project_url": { + "description": "The URL to view the project associated with this column.", "type": ["null", "string"] }, "cards_url": { + "description": "The API URL to fetch the cards in this project column.", "type": ["null", "string"] }, "id": { + "description": "The unique identification number of this project column.", "type": ["null", "integer"] }, "node_id": { + "description": "The node ID of this project column used in the GraphQL API.", "type": ["null", "string"] }, "name": { + "description": "The name given to this project column.", "type": ["null", "string"] }, "created_at": { + "description": "The date and time when this project column was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time when this project column was last updated.", "type": "string", "format": "date-time" }, "repository": { + "description": "The repository to which this project column belongs.", "type": "string" }, "project_id": { + "description": "The ID of the project to which this column belongs.", "type": "integer" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/projects.json b/airbyte-integrations/connectors/source-github/source_github/schemas/projects.json index a0b6e091761..fcb29a41b77 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/projects.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/projects.json @@ -3,46 +3,60 @@ "type": "object", "properties": { "repository": { + "description": "The repository associated with the project.", "type": "string" }, "owner_url": { + "description": "The URL to view the owner or creator of the project.", "type": ["null", "string"] }, "url": { + "description": "The URL for accessing the project.", "type": ["null", "string"] }, "html_url": { + "description": "The HTML URL for viewing the project.", "type": ["null", "string"] }, "columns_url": { + "description": "The URL to view the project's columns or categories.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier for the project.", "type": ["null", "integer"] }, "node_id": { + "description": "The Node ID associated with the project.", "type": ["null", "string"] }, "name": { + "description": "The name of the project.", "type": ["null", "string"] }, "body": { + "description": "The description or main content of the project.", "type": ["null", "string"] }, "number": { + "description": "The project number or identifier.", "type": ["null", "integer"] }, "state": { + "description": "The state or status of the project.", "type": ["null", "string"] }, "creator": { + "description": "The user or entity who created the project.", "$ref": "user.json" }, "created_at": { + "description": "The date and time when the project was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time when the project was last updated.", "type": "string", "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/projects_v2.json b/airbyte-integrations/connectors/source-github/source_github/schemas/projects_v2.json index 744fec6d757..e4ef2ea5a3a 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/projects_v2.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/projects_v2.json @@ -3,77 +3,100 @@ "type": "object", "properties": { "closed": { + "description": "Indicates whether the project is closed or not.", "type": ["null", "boolean"] }, "created_at": { + "description": "The date and time when the project was created.", "type": ["null", "string"], "format": "date-time" }, "creator": { + "description": "Information about the user who created the project.", "type": ["null", "object"], "properties": { "avatarUrl": { + "description": "The URL to the creator's avatar image.", "type": ["null", "string"] }, "login": { + "description": "The username of the creator.", "type": ["null", "string"] }, "resourcePath": { + "description": "The resource path for the creator's profile.", "type": ["null", "string"] }, "url": { + "description": "The URL to the creator's profile.", "type": ["null", "string"] } } }, "closed_at": { + "description": "The date and time when the project was closed.", "type": ["null", "string"], "format": "date-time" }, "updated_at": { + "description": "The date and time when the project was last updated.", "type": ["null", "string"], "format": "date-time" }, "node_id": { + "description": "The node ID of the project.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the project.", "type": ["null", "integer"] }, "number": { + "description": "The project number.", "type": ["null", "integer"] }, "public": { + "description": "Indicates whether the project is public or private.", "type": ["null", "boolean"] }, "readme": { + "description": "The README content of the project.", "type": ["null", "string"] }, "short_description": { + "description": "A brief description of the project.", "type": ["null", "string"] }, "template": { + "description": "Indicates whether the project is a template or not.", "type": ["null", "boolean"] }, "title": { + "description": "The title of the project.", "type": ["null", "string"] }, "url": { + "description": "The URL to access the project.", "type": ["null", "string"] }, "viewerCanClose": { + "description": "Indicates whether the current viewer can close the project.", "type": ["null", "boolean"] }, "viewerCanReopen": { + "description": "Indicates whether the current viewer can reopen the project.", "type": ["null", "boolean"] }, "viewerCanUpdate": { + "description": "Indicates whether the current viewer can update the project.", "type": ["null", "boolean"] }, "owner_id": { + "description": "The ID of the project owner.", "type": ["null", "string"] }, "repository": { + "description": "Information about the repository associated with the project.", "type": "string" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_comment_reactions.json b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_comment_reactions.json index e2088e23bea..5d66c37cd29 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_comment_reactions.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_comment_reactions.json @@ -3,25 +3,32 @@ "type": "object", "properties": { "id": { + "description": "The unique identifier for the reaction.", "type": ["null", "integer"] }, "node_id": { + "description": "A unique identifier for the reaction node.", "type": ["null", "string"] }, "content": { + "description": "The type of reaction content, e.g., '+1', 'heart', 'laugh', etc.", "type": ["null", "string"] }, "created_at": { + "description": "The timestamp when the reaction was created.", "type": "string", "format": "date-time" }, "user": { + "description": "The user who reacted to the pull request comment.", "$ref": "user_graphql.json" }, "repository": { + "description": "The repository associated with the pull request comment.", "type": "string" }, "comment_id": { + "description": "The ID of the pull request comment to which the reaction belongs.", "type": "integer" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_commits.json b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_commits.json index eeca3ca8548..3488979ecf2 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_commits.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_commits.json @@ -3,77 +3,99 @@ "type": "object", "properties": { "sha": { + "description": "SHA of the commit.", "type": ["null", "string"] }, "node_id": { + "description": "Node ID of the commit.", "type": ["null", "string"] }, "commit": { + "description": "Details about the commit related to the pull request.", "type": "object", "properties": { "author": { + "description": "Details about the author of the commit.", "type": "object", "properties": { "name": { + "description": "Name of the author.", "type": ["null", "string"] }, "email": { + "description": "Email address of the author.", "type": ["null", "string"] }, "date": { + "description": "Date and time the commit was authored.", "type": "string", "format": "date-time" } } }, "committer": { + "description": "Details about the committer of the commit.", "type": "object", "properties": { "name": { + "description": "Name of the committer.", "type": ["null", "string"] }, "email": { + "description": "Email address of the committer.", "type": ["null", "string"] }, "date": { + "description": "Date and time the commit was committed.", "type": "string", "format": "date-time" } } }, "message": { + "description": "Commit message.", "type": ["null", "string"] }, "tree": { + "description": "Information about the tree associated with the commit.", "type": "object", "properties": { "sha": { + "description": "SHA of the tree.", "type": ["null", "string"] }, "url": { + "description": "URL to retrieve more details about the tree.", "type": ["null", "string"] } } }, "url": { + "description": "URL to access more details about the commit.", "type": ["null", "string"] }, "comment_count": { + "description": "Number of comments on the commit.", "type": ["null", "integer"] }, "verification": { + "description": "Verification status of the commit.", "type": "object", "properties": { "verified": { + "description": "Indicates if the commit is verified.", "type": ["null", "boolean"] }, "reason": { + "description": "Reason for verification status.", "type": ["null", "string"] }, "signature": { + "description": "Signature of the commit for verification.", "type": ["null", "string"] }, "payload": { + "description": "Payload data used for verification.", "type": ["null", "string"] } } @@ -81,41 +103,52 @@ } }, "url": { + "description": "URL to access more details about the commit.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the commit in a web browser.", "type": ["null", "string"] }, "comments_url": { + "description": "URL to retrieve comments related to the commit.", "type": ["null", "string"] }, "author": { + "description": "Details about the author of the commit.", "$ref": "user.json" }, "committer": { + "description": "Details about the committer of the commit.", "$ref": "user.json" }, "parents": { + "description": "List of parent commits associated with the commit.", "type": "array", "items": { "type": "object", "properties": { "sha": { + "description": "SHA of the parent commit.", "type": ["null", "string"] }, "url": { + "description": "URL to access more details about the parent commit.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the parent commit in a web browser.", "type": ["null", "string"] } } } }, "repository": { + "description": "Details about the repository where the commit was made.", "type": "string" }, "pull_number": { + "description": "Number associated with the pull request.", "type": "integer" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_stats.json b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_stats.json index 67fa6fe382c..499427a943d 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_stats.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_request_stats.json @@ -3,80 +3,101 @@ "type": "object", "properties": { "repository": { + "description": "The repository to which the pull request belongs.", "type": "string" }, "id": { + "description": "The unique identifier of the pull request.", "type": ["null", "integer"] }, "node_id": { + "description": "The node ID of the pull request.", "type": ["null", "string"] }, "number": { + "description": "The number of the pull request.", "type": ["null", "integer"] }, "merged": { + "description": "Indicates if the pull request has been merged.", "type": ["null", "boolean"] }, "mergeable": { + "description": "Indicates if the pull request is mergeable.", "type": ["null", "string"] }, "can_be_rebased": { + "description": "Indicates whether the pull request can be rebased onto the base branch.", "type": ["null", "boolean"] }, "merge_state_status": { + "description": "The status of the merge state for the pull request.", "type": ["null", "string"] }, "merged_by": { - "$ref": "user_graphql.json" - }, - "merged_by": { + "description": "The user who merged the pull request.", "type": ["null", "object"], "properties": { "login": { + "description": "The username of the user who merged the pull request.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the user who merged the pull request.", "type": ["null", "integer"] }, "node_id": { + "description": "The node ID of the user who merged the pull request.", "type": ["null", "string"] }, "avatar_url": { + "description": "The URL of the avatar of the user who merged the pull request.", "type": ["null", "string"] }, "html_url": { + "description": "The HTML URL of the user who merged the pull request.", "type": ["null", "string"] }, "type": { + "description": "The type of user who merged the pull request.", "type": ["null", "string"] }, "site_admin": { + "description": "Indicates if the user who merged the pull request is a site admin.", "type": ["null", "boolean"] } } }, "comments": { + "description": "The total number of comments on the pull request.", "type": ["null", "integer"] }, "review_comments": { + "description": "The total number of review comments on the pull request.", "type": ["null", "integer"] }, "maintainer_can_modify": { + "description": "Indicates if maintainers can modify the pull request.", "type": ["null", "boolean"] }, "commits": { + "description": "The total number of commits in the pull request.", "type": ["null", "integer"] }, "additions": { + "description": "The total number of lines added in the pull request.", "type": ["null", "integer"] }, "deletions": { + "description": "The total number of lines deleted in the pull request.", "type": ["null", "integer"] }, "changed_files": { + "description": "The number of files changed in the pull request.", "type": ["null", "integer"] }, "updated_at": { + "description": "The date and time when the pull request was last updated.", "type": "string", "format": "date-time" } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_requests.json b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_requests.json index c0a706660e3..c15e707ce26 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/pull_requests.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/pull_requests.json @@ -3,63 +3,83 @@ "type": "object", "properties": { "repository": { + "description": "Repository information", "type": "string" }, "url": { + "description": "URL for fetching detailed information about this pull request", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the pull request", "type": ["null", "integer"] }, "node_id": { + "description": "Node identifier for the pull request", "type": ["null", "string"] }, "html_url": { + "description": "URL for viewing the pull request on GitHub", "type": ["null", "string"] }, "diff_url": { + "description": "URL to view the diff for this pull request", "type": ["null", "string"] }, "patch_url": { + "description": "URL for fetching the patch file for this pull request", "type": ["null", "string"] }, "issue_url": { + "description": "URL for viewing the issue associated with this pull request", "type": ["null", "string"] }, "commits_url": { + "description": "URL for fetching commits on this pull request", "type": ["null", "string"] }, "review_comments_url": { + "description": "URL for fetching review comments on this pull request", "type": ["null", "string"] }, "review_comment_url": { + "description": "URL for fetching review comments on this pull request", "type": ["null", "string"] }, "comments_url": { + "description": "URL for fetching comments on this pull request", "type": ["null", "string"] }, "statuses_url": { + "description": "URL for fetching status information for this pull request", "type": ["null", "string"] }, "number": { + "description": "Number assigned to the pull request", "type": ["null", "integer"] }, "state": { + "description": "State of the pull request", "type": ["null", "string"] }, "locked": { + "description": "Indicates if the pull request is locked", "type": ["null", "boolean"] }, "title": { + "description": "Title of the pull request", "type": ["null", "string"] }, "user": { + "description": "User who created the pull request", "$ref": "user.json" }, "body": { + "description": "Body content of the pull request", "type": ["null", "string"] }, "labels": { + "description": "Labels attached to this pull request", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -89,100 +109,126 @@ } }, "milestone": { + "description": "Milestone information for this pull request", "type": ["null", "object"], "properties": { "url": { + "description": "URL for fetching milestone information", "type": ["null", "string"] }, "html_url": { + "description": "URL for viewing the milestone on GitHub", "type": ["null", "string"] }, "labels_url": { + "description": "URL for fetching labels on the milestone", "type": ["null", "string"] }, "id": { + "description": "Unique identifier for the milestone", "type": ["null", "integer"] }, "node_id": { "type": ["null", "string"] }, "number": { + "description": "Milestone number", "type": ["null", "integer"] }, "state": { + "description": "State of the milestone", "type": ["null", "string"] }, "title": { + "description": "Title of the milestone", "type": ["null", "string"] }, "description": { + "description": "Description of the milestone", "type": ["null", "string"] }, "creator": { + "description": "User who created the milestone", "$ref": "user.json" }, "open_issues": { + "description": "Number of open issues in the milestone", "type": ["null", "integer"] }, "closed_issues": { + "description": "Number of closed issues in the milestone", "type": ["null", "integer"] }, "created_at": { + "description": "Date and time when the milestone was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the milestone was last updated", "type": "string", "format": "date-time" }, "closed_at": { + "description": "Date and time when the milestone was closed", "type": ["null", "string"], "format": "date-time" }, "due_on": { + "description": "Date when the milestone is due", "type": ["null", "string"], "format": "date-time" } } }, "active_lock_reason": { + "description": "Reason this pull request is locked", "type": ["null", "string"] }, "created_at": { + "description": "Date and time when the pull request was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the pull request was last updated", "type": "string", "format": "date-time" }, "closed_at": { + "description": "Date and time when the pull request was closed", "type": ["null", "string"], "format": "date-time" }, "merged_at": { + "description": "Date and time when the pull request was merged", "type": ["null", "string"], "format": "date-time" }, "merge_commit_sha": { + "description": "SHA hash of the merged commit", "type": ["null", "string"] }, "assignee": { + "description": "User assigned to this pull request", "$ref": "user.json" }, "assignees": { + "description": "Users assigned to this pull request", "type": ["null", "array"], "items": { "$ref": "user.json" } }, "requested_reviewers": { + "description": "Requested reviewers for this pull request", "type": ["null", "array"], "items": { "$ref": "user.json" } }, "requested_teams": { + "description": "Requested teams for this pull request", "type": ["null", "array"], "items": { "type": ["null", "object"], @@ -228,6 +274,7 @@ } }, "head": { + "description": "Head branch information", "type": ["null", "object"], "properties": { "label": { @@ -251,6 +298,7 @@ } }, "base": { + "description": "Base branch information", "type": ["null", "object"], "properties": { "label": { @@ -277,9 +325,11 @@ } }, "_links": { + "description": "Object containing links related to the pull request.", "type": ["null", "object"], "properties": { "self": { + "description": "URL for fetching detailed information about this pull request", "type": ["null", "object"], "properties": { "href": { @@ -288,6 +338,7 @@ } }, "html": { + "description": "URL for viewing the pull request on GitHub", "type": ["null", "object"], "properties": { "href": { @@ -296,6 +347,7 @@ } }, "issue": { + "description": "URL for viewing the issue associated with this pull request", "type": ["null", "object"], "properties": { "href": { @@ -304,6 +356,7 @@ } }, "comments": { + "description": "URL for fetching comments related to this pull request", "type": ["null", "object"], "properties": { "href": { @@ -312,6 +365,7 @@ } }, "review_comments": { + "description": "URL for fetching review comments related to this pull request", "type": ["null", "object"], "properties": { "href": { @@ -320,6 +374,7 @@ } }, "review_comment": { + "description": "URL for fetching review comments related to this pull request", "type": ["null", "object"], "properties": { "href": { @@ -328,6 +383,7 @@ } }, "commits": { + "description": "URL for fetching commits related to this pull request", "type": ["null", "object"], "properties": { "href": { @@ -336,6 +392,7 @@ } }, "statuses": { + "description": "URL for fetching status information for this pull request", "type": ["null", "object"], "properties": { "href": { @@ -346,9 +403,11 @@ } }, "author_association": { + "description": "Association of the author with this pull request", "type": ["null", "string"] }, "auto_merge": { + "description": "Details about automatic merging of this pull request", "type": ["null", "object"], "properties": { "enabled_by": { @@ -366,6 +425,7 @@ } }, "draft": { + "description": "Indicates if the pull request is a draft", "type": ["null", "boolean"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/releases.json b/airbyte-integrations/connectors/source-github/source_github/schemas/releases.json index 3fbbc8e3c6a..55b10293d61 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/releases.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/releases.json @@ -3,123 +3,161 @@ "type": "object", "properties": { "repository": { + "description": "The repository associated with the release.", "type": "string" }, "url": { + "description": "The URL for the release.", "type": ["null", "string"] }, "html_url": { + "description": "The HTML URL for the release.", "type": ["null", "string"] }, "assets_url": { + "description": "The URL to fetch information about the assets linked to this release.", "type": ["null", "string"] }, "upload_url": { + "description": "The URL for uploading assets to the release.", "type": ["null", "string"] }, "tarball_url": { + "description": "The URL for the tarball file of the release.", "type": ["null", "string"] }, "zipball_url": { + "description": "The URL for the zipball file of the release.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier for the release", "type": ["null", "integer"] }, "node_id": { + "description": "The node ID of the release.", "type": ["null", "string"] }, "tag_name": { + "description": "The tag name of the release.", "type": ["null", "string"] }, "target_commitish": { + "description": "The commit SHA or branch name for the release.", "type": ["null", "string"] }, "name": { + "description": "The name of the release.", "type": ["null", "string"] }, "body": { + "description": "The body of the release.", "type": ["null", "string"] }, "draft": { + "description": "Indicates if the release is a draft.", "type": ["null", "boolean"] }, "prerelease": { + "description": "Indicates if the release is a prerelease.", "type": ["null", "boolean"] }, "created_at": { + "description": "The timestamp of when the release was created.", "type": "string", "format": "date-time" }, "published_at": { + "description": "The timestamp of when the release was published.", "type": ["null", "string"], "format": "date-time" }, "author": { + "description": "The author of the release.", "$ref": "user.json" }, "assets": { + "description": "List of assets (e.g., downloadable files) associated with the release", "type": ["null", "array"], "items": { + "description": "Details of an individual asset", "type": ["null", "object"], "properties": { "url": { + "description": "The URL of the asset.", "type": ["null", "string"] }, "browser_download_url": { + "description": "The URL for downloading the asset linked to this release.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier for the asset.", "type": ["null", "integer"] }, "node_id": { + "description": "The node ID of the asset.", "type": ["null", "string"] }, "name": { + "description": "The name of the asset.", "type": ["null", "string"] }, "label": { + "description": "The label assigned to the asset.", "type": ["null", "string"] }, "state": { + "description": "The state of the asset.", "type": ["null", "string"] }, "content_type": { + "description": "The content type of the asset.", "type": ["null", "string"] }, "size": { + "description": "The size of the asset in bytes.", "type": ["null", "integer"] }, "download_count": { + "description": "The number of times the asset has been downloaded.", "type": ["null", "integer"] }, "created_at": { + "description": "The timestamp of when the asset was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The timestamp of when the asset was last updated.", "type": "string", "format": "date-time" }, "uploader_id": { + "description": "The ID of the user who uploaded the asset.", "type": ["null", "integer"] } } } }, "body_html": { + "description": "The HTML body of the release.", "type": ["null", "string"] }, "body_text": { + "description": "The text body of the release.", "type": ["null", "string"] }, "mentions_count": { + "description": "The count of mentions in the release.", "type": ["null", "integer"] }, "discussion_url": { + "description": "The URL for the discussion related to the release.", "type": ["null", "string"] }, "reactions": { + "description": "The reactions associated with the release.", "$ref": "reactions.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/repositories.json b/airbyte-integrations/connectors/source-github/source_github/schemas/repositories.json index d4e5d270d4b..e8c82aae0c9 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/repositories.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/repositories.json @@ -3,295 +3,390 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository.", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the repository.", "type": ["null", "string"] }, "name": { + "description": "Name of the repository.", "type": ["null", "string"] }, "full_name": { + "description": "Full name of the repository.", "type": ["null", "string"] }, "owner": { + "description": "Owner of the repository.", "$ref": "user.json" }, "private": { + "description": "Indicates if the repository is private.", "type": ["null", "boolean"] }, "html_url": { + "description": "URL of the repository's GitHub page.", "type": ["null", "string"] }, "description": { + "description": "Brief description of the repository.", "type": ["null", "string"] }, "fork": { + "description": "Indicates if the repository is a fork.", "type": ["null", "boolean"] }, "url": { + "description": "URL of the repository.", "type": ["null", "string"] }, "archive_url": { + "description": "URL to archive the repository.", "type": ["null", "string"] }, "assignees_url": { + "description": "URL to fetch assignees for issues in the repository.", "type": ["null", "string"] }, "blobs_url": { + "description": "URL to fetch blobs within the repository.", "type": ["null", "string"] }, "branches_url": { + "description": "URL to fetch branches within the repository.", "type": ["null", "string"] }, "collaborators_url": { + "description": "URL to fetch collaborators of the repository.", "type": ["null", "string"] }, "comments_url": { + "description": "URL to fetch comments within the repository.", "type": ["null", "string"] }, "commits_url": { + "description": "URL to fetch commits within the repository.", "type": ["null", "string"] }, "compare_url": { + "description": "URL to compare references within the repository.", "type": ["null", "string"] }, "contents_url": { + "description": "URL to fetch contents within the repository.", "type": ["null", "string"] }, "contributors_url": { + "description": "URL to fetch contributors to the repository.", "type": ["null", "string"] }, "deployments_url": { + "description": "URL to fetch deployments related to the repository.", "type": ["null", "string"] }, "downloads_url": { + "description": "URL to fetch downloads linked to the repository.", "type": ["null", "string"] }, "events_url": { + "description": "URL to fetch events related to the repository.", "type": ["null", "string"] }, "forks_url": { + "description": "URL to fetch forks of the repository.", "type": ["null", "string"] }, "git_commits_url": { + "description": "URL to fetch git commits within the repository.", "type": ["null", "string"] }, "git_refs_url": { + "description": "URL to fetch git references within the repository.", "type": ["null", "string"] }, "git_tags_url": { + "description": "URL to fetch git tags within the repository.", "type": ["null", "string"] }, "git_url": { + "description": "URL for Git protocol to interact with the repository.", "type": ["null", "string"] }, "issue_comment_url": { + "description": "URL to fetch issue comments within the repository.", "type": ["null", "string"] }, "issue_events_url": { + "description": "URL to fetch issue events within the repository.", "type": ["null", "string"] }, "issues_url": { + "description": "URL to fetch issues within the repository.", "type": ["null", "string"] }, "keys_url": { + "description": "URL to fetch keys associated with the repository.", "type": ["null", "string"] }, "labels_url": { + "description": "URL to fetch labels associated with the repository.", "type": ["null", "string"] }, "languages_url": { + "description": "URL to fetch languages used in the repository.", "type": ["null", "string"] }, "merges_url": { + "description": "URL to fetch merges related to the repository.", "type": ["null", "string"] }, "milestones_url": { + "description": "URL to fetch milestones within the repository.", "type": ["null", "string"] }, "notifications_url": { + "description": "URL to manage notifications for the repository.", "type": ["null", "string"] }, "pulls_url": { + "description": "URL to fetch pull requests within the repository.", "type": ["null", "string"] }, "releases_url": { + "description": "URL to fetch releases related to the repository.", "type": ["null", "string"] }, "ssh_url": { + "description": "SSH URL of the repository.", "type": ["null", "string"] }, "stargazers_url": { + "description": "URL to fetch users who starred the repository.", "type": ["null", "string"] }, "statuses_url": { + "description": "URL to fetch commit statuses within the repository.", "type": ["null", "string"] }, "subscribers_url": { + "description": "URL to fetch subscribers of the repository.", "type": ["null", "string"] }, "subscription_url": { + "description": "URL to manage subscriptions to notifications for the repository.", "type": ["null", "string"] }, "tags_url": { + "description": "URL to fetch tags within the repository.", "type": ["null", "string"] }, "teams_url": { + "description": "URL to manage repository teams.", "type": ["null", "string"] }, "trees_url": { + "description": "URL to fetch trees within the repository.", "type": ["null", "string"] }, "clone_url": { + "description": "URL to clone the repository.", "type": ["null", "string"] }, "mirror_url": { + "description": "URL of the mirror repository.", "type": ["null", "string"] }, "hooks_url": { + "description": "URL to manage webhooks for the repository.", "type": ["null", "string"] }, "svn_url": { + "description": "SVN URL of the repository.", "type": ["null", "string"] }, "homepage": { + "description": "URL of the repository's homepage.", "type": ["null", "string"] }, "language": { + "description": "Main programming language used in the repository.", "type": ["null", "string"] }, "forks_count": { + "description": "Count of forks for the repository.", "type": ["null", "integer"] }, "stargazers_count": { + "description": "Number of stars the repository has received.", "type": ["null", "integer"] }, "watchers_count": { + "description": "Count of watchers for the repository.", "type": ["null", "integer"] }, "size": { + "description": "Size of the repository in kilobytes.", "type": ["null", "integer"] }, "default_branch": { + "description": "Default branch of the repository.", "type": ["null", "string"] }, "open_issues_count": { + "description": "Count of open issues in the repository.", "type": ["null", "integer"] }, "is_template": { + "description": "Indicates if the repository is a template.", "type": ["null", "boolean"] }, "topics": { + "description": "Topics associated with the repository.", "type": ["null", "array"], "items": { + "description": "Individual topic related to the repository.", "type": ["null", "string"] } }, "license": { + "description": "License information of the repository.", "type": ["null", "object"], "properties": { "key": { + "description": "Key identifier of the license.", "type": ["null", "string"] }, "name": { + "description": "Name of the license.", "type": ["null", "string"] }, "url": { + "description": "URL to access license details.", "type": ["null", "string"] }, "spdx_id": { + "description": "SPDX identifier of the license.", "type": ["null", "string"] }, "node_id": { + "description": "Node ID of the license.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view license details on the web.", "type": ["null", "string"] } } }, "has_issues": { + "description": "Indicates if the repository has issues enabled.", "type": ["null", "boolean"] }, "has_projects": { + "description": "Indicates if the repository has projects enabled.", "type": ["null", "boolean"] }, "has_wiki": { + "description": "Indicates if the repository has a wiki enabled.", "type": ["null", "boolean"] }, "has_pages": { + "description": "Indicates if the repository has GitHub Pages enabled.", "type": ["null", "boolean"] }, "has_downloads": { + "description": "Indicates if the repository has downloads available.", "type": ["null", "boolean"] }, "archived": { + "description": "Indicates if the repository is archived.", "type": ["null", "boolean"] }, "disabled": { + "description": "Indicates if the repository is disabled.", "type": ["null", "boolean"] }, "visibility": { + "description": "Visibility status of the repository.", "type": ["null", "string"] }, "pushed_at": { + "description": "Date and time when the repository was last pushed to.", "type": "string", "format": "date-time" }, "created_at": { + "description": "Date and time when the repository was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the repository was last updated.", "type": "string", "format": "date-time" }, "permissions": { + "description": "Permissions granted to different roles for the repository.", "type": ["null", "object"], "properties": { "admin": { + "description": "Admin permission level.", "type": ["null", "boolean"] }, "push": { + "description": "Push permission level.", "type": ["null", "boolean"] }, "pull": { + "description": "Pull permission level.", "type": ["null", "boolean"] }, "maintain": { + "description": "Maintain permission level.", "type": ["null", "boolean"] }, "triage": { + "description": "Triage permission level.", "type": ["null", "boolean"] } } }, "allow_forking": { + "description": "Indicates if forking is allowed for the repository.", "type": ["null", "boolean"] }, "forks": { + "description": "Forks information related to the repository.", "type": ["null", "integer"] }, "has_discussions": { + "description": "Indicates if the repository has discussions.", "type": ["null", "boolean"] }, "open_issues": { + "description": "Number of open issues in the repository.", "type": ["null", "integer"] }, "organization": { + "description": "Organization the repository belongs to.", "type": ["null", "string"] }, "watchers": { + "description": "Watchers of the repository.", "type": ["null", "integer"] }, "web_commit_signoff_required": { + "description": "Indicates if web commit sign-off is required for contributions.", "type": ["null", "boolean"] }, "security_and_analysis": { + "description": "Security and analysis settings of the repository.", "type": ["null", "object"], "properties": { "secret_scanning": { + "description": "Secret scanning status.", "type": ["null", "object"], "properties": { "status": { @@ -300,6 +395,7 @@ } }, "secret_scanning_push_protection": { + "description": "Secret scanning push protection status.", "type": ["null", "object"], "properties": { "status": { @@ -308,6 +404,7 @@ } }, "secret_scanning_validity_checks": { + "description": "Secret scanning validity checks status.", "type": ["null", "object"], "properties": { "status": { @@ -316,6 +413,7 @@ } }, "dependabot_security_updates": { + "description": "Dependabot security updates status.", "type": ["null", "object"], "properties": { "status": { diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/review_comments.json b/airbyte-integrations/connectors/source-github/source_github/schemas/review_comments.json index 9e9add96148..9a12da5f0d9 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/review_comments.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/review_comments.json @@ -3,87 +3,113 @@ "type": "object", "properties": { "repository": { + "description": "Information about the repository where the comment was made", "type": "string" }, "url": { + "description": "The URL of the API resource for the comment", "type": ["null", "string"] }, "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs", "type": ["null", "integer"] }, "id": { + "description": "The unique identifier of the comment", "type": ["null", "integer"] }, "node_id": { + "description": "The unique identifier for the comment node", "type": ["null", "string"] }, "diff_hunk": { + "description": "A snippet of the diff where the comment was made", "type": ["null", "string"] }, "path": { + "description": "The file path where the comment was made", "type": ["null", "string"] }, "position": { + "description": "The position of the comment relative to the diff", "type": ["null", "integer"] }, "original_position": { + "description": "The original position of the comment relative to the diff", "type": ["null", "integer"] }, "commit_id": { + "description": "The ID of the commit the comment is associated with", "type": ["null", "string"] }, "original_commit_id": { + "description": "The original commit ID associated with the comment", "type": ["null", "string"] }, "in_reply_to_id": { + "description": "The ID of the comment being replied to", "type": ["null", "integer"] }, "user": { + "description": "Information about the user who made the comment", "$ref": "user.json" }, "body": { + "description": "The content of the comment", "type": ["null", "string"] }, "created_at": { + "description": "The timestamp when the comment was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The timestamp when the comment was last updated", "type": "string", "format": "date-time" }, "html_url": { + "description": "The URL for viewing the comment on GitHub", "type": ["null", "string"] }, "pull_request_url": { + "description": "The URL of the pull request to which the comment belongs", "type": ["null", "string"] }, "author_association": { + "description": "The association of the author of the comment with the repository", "type": ["null", "string"] }, "_links": { + "description": "Contains links to related resources for the review comment", "type": ["null", "object"], "properties": { "self": { + "description": "URL for the review comment itself", "type": ["null", "object"], "properties": { "href": { + "description": "The URL of the comment itself", "type": ["null", "string"] } } }, "html": { + "description": "URL for the HTML representation of the review comment", "type": ["null", "object"], "properties": { "href": { + "description": "The URL for viewing the comment in a browser", "type": ["null", "string"] } } }, "pull_request": { + "description": "URL for the pull request associated with the review comment", "type": ["null", "object"], "properties": { "href": { + "description": "The URL for the associated pull request", "type": ["null", "string"] } } @@ -91,27 +117,35 @@ } }, "start_line": { + "description": "The starting line of the comment reference", "type": ["null", "integer"] }, "original_start_line": { + "description": "The original starting line of the comment reference", "type": ["null", "integer"] }, "start_side": { + "description": "The side in the diff where the comment reference started", "type": ["null", "string"] }, "line": { + "description": "The line in the diff where the comment was made", "type": ["null", "integer"] }, "original_line": { + "description": "The original line for the comment reference", "type": ["null", "integer"] }, "side": { + "description": "The side of the diff where the comment was made (e.g., left or right)", "type": ["null", "string"] }, "subject_type": { + "description": "The type of subject the comment is associated with", "type": ["null", "string"] }, "reactions": { + "description": "Reactions to the comment (e.g., thumbs up, thumbs down)", "$ref": "reactions.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/reviews.json b/airbyte-integrations/connectors/source-github/source_github/schemas/reviews.json index 5317674f97e..f9da4612e5e 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/reviews.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/reviews.json @@ -3,44 +3,57 @@ "type": "object", "properties": { "repository": { + "description": "Information about the repository where the review is posted.", "type": "string" }, "id": { + "description": "The unique identifier of the review.", "type": ["null", "integer"] }, "node_id": { + "description": "The node identifier of the review.", "type": ["null", "string"] }, "user": { + "description": "Information about the user who submitted the review.", "$ref": "user_graphql.json" }, "body": { + "description": "The content of the review comment.", "type": ["null", "string"] }, "state": { + "description": "The state of the review (e.g., open, closed).", "type": ["null", "string"] }, "html_url": { + "description": "The URL of the review comment.", "type": ["null", "string"] }, "pull_request_url": { + "description": "The URL of the pull request associated with the review.", "type": ["null", "string"] }, "_links": { + "description": "Contains relevant hyperlinks related to the review data.", "type": ["null", "object"], "properties": { "html": { + "description": "URL for viewing the review data in HTML format.", "type": ["null", "object"], "properties": { "href": { + "description": "The URL of the HTML page for the review.", "type": ["null", "string"] } } }, "pull_request": { + "description": "URL for accessing the pull request associated with the review data.", "type": ["null", "object"], "properties": { "href": { + "description": "The URL of the pull request associated with the review.", "type": ["null", "string"] } } @@ -48,21 +61,26 @@ } }, "submitted_at": { + "description": "The date and time when the review was submitted.", "type": "string", "format": "date-time" }, "created_at": { + "description": "The date and time when the review was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The date and time when the review was last updated.", "type": "string", "format": "date-time" }, "commit_id": { + "description": "The unique identifier of the commit associated with the review.", "type": ["null", "string"] }, "author_association": { + "description": "The association of the author of the review with the repository.", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/stargazers.json b/airbyte-integrations/connectors/source-github/source_github/schemas/stargazers.json index b1a1149e00a..05b5aaab4d1 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/stargazers.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/stargazers.json @@ -3,16 +3,20 @@ "type": "object", "properties": { "repository": { + "description": "The repository that was starred by a user.", "type": "string" }, "user_id": { + "description": "The unique identifier of the user who starred the repository.", "type": ["null", "integer"] }, "starred_at": { + "description": "The date and time when the user starred the repository.", "type": "string", "format": "date-time" }, "user": { + "description": "The user who starred the repository.", "$ref": "user.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/tags.json b/airbyte-integrations/connectors/source-github/source_github/schemas/tags.json index a77157f7241..7c3d8c640b5 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/tags.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/tags.json @@ -3,29 +3,37 @@ "type": "object", "properties": { "repository": { + "description": "Repository information related to the tag", "type": "string" }, "name": { + "description": "Name of the tag", "type": ["null", "string"] }, "commit": { + "description": "Information about the commit associated with this tag", "type": ["null", "object"], "properties": { "sha": { + "description": "The unique SHA of the commit", "type": ["null", "string"] }, "url": { + "description": "URL to view details of the commit", "type": ["null", "string"] } } }, "zipball_url": { + "description": "URL to download a zipball archive of the repository at this tag", "type": ["null", "string"] }, "tarball_url": { + "description": "URL to download a tarball archive of the repository at this tag", "type": ["null", "string"] }, "node_id": { + "description": "Unique identifier of the tag", "type": ["null", "string"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/team_members.json b/airbyte-integrations/connectors/source-github/source_github/schemas/team_members.json index b4722701fed..10ac4e4fc18 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/team_members.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/team_members.json @@ -3,63 +3,83 @@ "type": "object", "properties": { "login": { + "description": "Username of the user", "type": ["null", "string"] }, "id": { + "description": "Unique identifier of the user", "type": "integer" }, "node_id": { + "description": "Node ID associated with the user", "type": ["null", "string"] }, "avatar_url": { + "description": "URL of the user's avatar image", "type": ["null", "string"] }, "gravatar_id": { + "description": "Unique identifier of the user's Gravatar image", "type": ["null", "string"] }, "url": { + "description": "URL of the user's GitHub API endpoint", "type": ["null", "string"] }, "html_url": { + "description": "URL of the user's GitHub profile", "type": ["null", "string"] }, "followers_url": { + "description": "URL of the user's followers", "type": ["null", "string"] }, "following_url": { + "description": "URL of the users that the user is following", "type": ["null", "string"] }, "gists_url": { + "description": "URL of the user's gists", "type": ["null", "string"] }, "starred_url": { + "description": "URL of the repositories starred by the user", "type": ["null", "string"] }, "subscriptions_url": { + "description": "URL of the repositories the user is subscribed to", "type": ["null", "string"] }, "organizations_url": { + "description": "URL of the organizations the user belongs to", "type": ["null", "string"] }, "repos_url": { + "description": "URL of the user's repositories", "type": ["null", "string"] }, "events_url": { + "description": "URL of the events performed by the user", "type": ["null", "string"] }, "received_events_url": { + "description": "URL of the received events by the user", "type": ["null", "string"] }, "type": { + "description": "Type of user account (e.g., User or Organization)", "type": ["null", "string"] }, "site_admin": { + "description": "Boolean indicating if the user is a site administrator", "type": ["null", "boolean"] }, "organization": { + "description": "Name of the organization the user is a part of", "type": "string" }, "team_slug": { + "description": "Slug identifier of the user's team", "type": "string" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/team_memberships.json b/airbyte-integrations/connectors/source-github/source_github/schemas/team_memberships.json index bf692c2c456..7290affbccf 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/team_memberships.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/team_memberships.json @@ -3,21 +3,27 @@ "type": "object", "properties": { "state": { + "description": "The current state of the team membership (active, pending, etc.).", "type": ["null", "string"] }, "role": { + "description": "The role or position of the user within the team.", "type": ["null", "string"] }, "url": { + "description": "The URL link to access more details about the team membership.", "type": "string" }, "organization": { + "description": "The name of the organization the team membership belongs to.", "type": "string" }, "team_slug": { + "description": "The unique identifier (slug) of the team the user belongs to.", "type": "string" }, "username": { + "description": "The username of the user associated with the team membership.", "type": "string" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/teams.json b/airbyte-integrations/connectors/source-github/source_github/schemas/teams.json index b0b5b03abba..1ea2b0df8a5 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/teams.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/teams.json @@ -3,45 +3,59 @@ "type": "object", "properties": { "organization": { + "description": "The organization to which the team belongs.", "type": ["null", "string"] }, "id": { + "description": "The unique identifier of the team.", "type": ["null", "integer"] }, "node_id": { + "description": "The node identifier of the team.", "type": ["null", "string"] }, "url": { + "description": "The API URL of the team.", "type": ["null", "string"] }, "html_url": { + "description": "The URL of the team on GitHub.", "type": ["null", "string"] }, "name": { + "description": "The name of the team.", "type": ["null", "string"] }, "slug": { + "description": "The unique URL-friendly name of the team.", "type": ["null", "string"] }, "description": { + "description": "The description of the team.", "type": ["null", "string"] }, "privacy": { + "description": "The privacy setting of the team.", "type": ["null", "string"] }, "notification_setting": { + "description": "The notification setting of the team.", "type": ["null", "string"] }, "permission": { + "description": "The permission level of the team.", "type": ["null", "string"] }, "members_url": { + "description": "The URL to fetch members of the team.", "type": ["null", "string"] }, "repositories_url": { + "description": "The URL to fetch repositories of the team.", "type": ["null", "string"] }, "parent": { + "description": "The parent team of the team.", "type": ["null", "object"], "properties": {}, "additionalProperties": true diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/users.json b/airbyte-integrations/connectors/source-github/source_github/schemas/users.json index 5236cd36232..161f026b5df 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/users.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/users.json @@ -3,60 +3,79 @@ "type": ["null", "object"], "properties": { "organization": { + "description": "The organization the user belongs to", "type": ["null", "string"] }, "login": { + "description": "The username of the user", "type": ["null", "string"] }, "id": { + "description": "The unique identification number of the user", "type": ["null", "integer"] }, "node_id": { + "description": "The ID assigned to the user in the GraphQL API", "type": ["null", "string"] }, "avatar_url": { + "description": "The URL of the user's avatar image", "type": ["null", "string"] }, "gravatar_id": { + "description": "The Gravatar ID associated with the user's email", "type": ["null", "string"] }, "url": { + "description": "The user's GitHub API URL", "type": ["null", "string"] }, "html_url": { + "description": "The URL of the user's GitHub page", "type": ["null", "string"] }, "followers_url": { + "description": "The URL listing the user's followers", "type": ["null", "string"] }, "following_url": { + "description": "The URL listing the users being followed by the user", "type": ["null", "string"] }, "gists_url": { + "description": "The URL of the user's gists", "type": ["null", "string"] }, "starred_url": { + "description": "The URL listing repositories starred by the user", "type": ["null", "string"] }, "subscriptions_url": { + "description": "The URL listing repositories the user is subscribed to", "type": ["null", "string"] }, "organizations_url": { + "description": "The URL listing organizations the user belongs to", "type": ["null", "string"] }, "repos_url": { + "description": "The URL listing repositories owned by the user", "type": ["null", "string"] }, "events_url": { + "description": "The URL of the events that the user has been involved in", "type": ["null", "string"] }, "received_events_url": { + "description": "The URL of events received by the user", "type": ["null", "string"] }, "type": { + "description": "The type of user account (e.g., User or Organization)", "type": ["null", "string"] }, "site_admin": { + "description": "Specifies if the user is a GitHub site administrator", "type": ["null", "boolean"] } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_jobs.json b/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_jobs.json index a46ed3cf54d..90635a6b09a 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_jobs.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_jobs.json @@ -3,78 +3,101 @@ "type": "object", "properties": { "id": { + "description": "Identifier of the job", "type": "integer" }, "run_id": { + "description": "Identifier of the run associated with the job", "type": "integer" }, "workflow_name": { + "description": "Name of the workflow associated with the job", "type": ["null", "string"] }, "head_branch": { + "description": "Name of the branch where the job was triggered", "type": ["null", "string"] }, "run_url": { + "description": "URL to view the run details associated with the job", "type": "string" }, "run_attempt": { + "description": "Number of the run attempt for the job", "type": "integer" }, "node_id": { + "description": "Node ID of the job", "type": "string" }, "head_sha": { + "description": "Commit SHA associated with the job", "type": "string" }, "url": { + "description": "URL to fetch the details of the job", "type": "string" }, "html_url": { + "description": "URL to view the job details in a web browser", "type": ["null", "string"] }, "status": { + "description": "Status of the job (e.g., in_progress, completed)", "type": "string" }, "conclusion": { + "description": "Conclusion of the job execution (e.g., success, failure)", "type": ["null", "string"] }, "created_at": { + "description": "Timestamp when the job was created", "type": "string", "format": "date-time" }, "started_at": { + "description": "Timestamp when the job was started", "type": "string", "format": "date-time" }, "completed_at": { + "description": "Timestamp when the job was completed", "type": ["null", "string"], "format": "date-time" }, "name": { + "description": "Name of the job", "type": "string" }, "steps": { + "description": "List of steps within the job", "type": "array", "items": { "type": "object", "properties": { "status": { + "description": "Status of the step (e.g., in_progress, completed)", "type": "string" }, "conclusion": { + "description": "Conclusion of the step execution (e.g., success, failure)", "type": ["null", "string"] }, "name": { + "description": "Name of the step", "type": "string" }, "number": { + "description": "Number of the step", "type": "integer" }, "started_at": { + "description": "Timestamp when the step was started", "type": ["null", "string"], "format": "date-time" }, "completed_at": { + "description": "Timestamp when the step was completed", "type": ["null", "string"], "format": "date-time" } @@ -82,27 +105,34 @@ } }, "check_run_url": { + "description": "URL to view the check run associated with the job", "type": "string" }, "labels": { + "description": "Labels associated with the job", "type": "array", "items": { "type": "string" } }, "runner_id": { + "description": "Identifier of the runner", "type": ["integer", "null"] }, "runner_name": { + "description": "Name of the runner", "type": ["null", "string"] }, "runner_group_id": { + "description": "Identifier of the runner group", "type": ["integer", "null"] }, "runner_group_name": { + "description": "Name of the runner group", "type": ["null", "string"] }, "repository": { + "description": "Repository information associated with the job", "type": "string" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_runs.json b/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_runs.json index 0ece8990919..647446ccbf2 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_runs.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/workflow_runs.json @@ -3,54 +3,71 @@ "type": "object", "properties": { "id": { + "description": "ID of the workflow run.", "type": ["null", "integer"] }, "name": { + "description": "Name of the workflow.", "type": ["null", "string"] }, "node_id": { + "description": "Node ID of the workflow run.", "type": ["null", "string"] }, "head_branch": { + "description": "The branch associated with the head commit.", "type": ["null", "string"] }, "head_sha": { + "description": "SHA of the head commit.", "type": ["null", "string"] }, "path": { + "description": "The path where the workflow file is located.", "type": ["null", "string"] }, "display_title": { + "description": "Title to display for the workflow run.", "type": ["null", "string"] }, "run_number": { + "description": "The unique number assigned to the workflow run.", "type": ["null", "integer"] }, "event": { + "description": "The event that triggered the workflow run.", "type": ["null", "string"] }, "status": { + "description": "The current status of the workflow run.", "type": ["null", "string"] }, "conclusion": { + "description": "The outcome or result of the workflow run.", "type": ["null", "string"] }, "workflow_id": { + "description": "ID of the workflow associated with the run.", "type": ["null", "integer"] }, "check_suite_id": { + "description": "ID of the associated GitHub check suite.", "type": ["null", "integer"] }, "check_suite_node_id": { + "description": "Node ID of the associated GitHub check suite.", "type": ["null", "string"] }, "url": { + "description": "URL to access details of the workflow run.", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the workflow run on GitHub.", "type": ["null", "string"] }, "pull_requests": { + "description": "List of all pull requests associated with the workflow run.", "type": "array", "items": { "type": ["null", "object"], @@ -59,77 +76,99 @@ } }, "created_at": { + "description": "The timestamp when the workflow run was created.", "type": "string", "format": "date-time" }, "updated_at": { + "description": "The timestamp when the workflow run was last updated.", "type": "string", "format": "date-time" }, "run_attempt": { + "description": "Specifies the attempt number of the workflow run.", "type": ["null", "integer"] }, "referenced_workflows": { + "description": "List of workflows referenced by the workflow runs", "type": "array", "items": { "type": "object", "properties": { "path": { + "description": "Path of the referenced workflow file", "type": "string" }, "sha": { + "description": "SHA hash of the referenced workflow", "type": "string" }, "ref": { + "description": "Type of reference to the workflow", "type": "string" } } } }, "run_started_at": { + "description": "The timestamp when the workflow run started.", "type": "string", "format": "date-time" }, "jobs_url": { + "description": "URL to access jobs associated with the workflow run.", "type": ["null", "string"] }, "logs_url": { + "description": "URL to access logs generated by the workflow run.", "type": ["null", "string"] }, "check_suite_url": { + "description": "URL to access the check suite details.", "type": ["null", "string"] }, "artifacts_url": { + "description": "URL to access artifacts generated by the workflow run.", "type": ["null", "string"] }, "cancel_url": { + "description": "URL to cancel the workflow run if supported.", "type": ["null", "string"] }, "rerun_url": { + "description": "URL to rerun the workflow.", "type": ["null", "string"] }, "previous_attempt_url": { + "description": "URL to access the previous attempt of the workflow run.", "type": ["null", "string"] }, "workflow_url": { + "description": "URL to access details of the workflow.", "type": ["null", "string"] }, "head_commit": { + "description": "Details about the commit associated with the workflow run.", "type": "object", "properties": { "id": { + "description": "ID of the head commit.", "type": ["null", "string"] }, "tree_id": { + "description": "ID of the tree associated with the head commit.", "type": ["null", "string"] }, "message": { + "description": "The commit message of the head commit.", "type": ["null", "string"] }, "timestamp": { + "description": "Timestamp of the head commit.", "type": ["null", "string"] }, "author": { + "description": "The author details of the head commit.", "type": "object", "properties": { "name": { @@ -141,6 +180,7 @@ } }, "committer": { + "description": "The committer details of the head commit.", "type": "object", "properties": { "name": { @@ -154,295 +194,391 @@ } }, "repository": { + "description": "Details about the repository where the workflow run is executed.", "type": "object", "properties": { "id": { + "description": "ID of the repository.", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the repository.", "type": ["null", "string"] }, "name": { + "description": "Name of the repository.", "type": ["null", "string"] }, "full_name": { + "description": "Full name of the repository.", "type": "string" }, "private": { + "description": "Indicates if the repository is private.", "type": ["null", "boolean"] }, "owner": { + "description": "The owner of the repository.", "$ref": "user.json" }, "html_url": { + "description": "HTML URL of the repository.", "type": ["null", "string"] }, "description": { + "description": "Description of the repository.", "type": ["null", "string"] }, "fork": { + "description": "Indicates if the repository is a fork.", "type": ["null", "boolean"] }, "url": { + "description": "URL of the repository.", "type": ["null", "string"] }, "forks_url": { + "description": "URL to access forks of the repository.", "type": ["null", "string"] }, "keys_url": { + "description": "URL to access keys of the repository.", "type": ["null", "string"] }, "collaborators_url": { + "description": "URL to access collaborators of the repository.", "type": ["null", "string"] }, "teams_url": { + "description": "URL to access teams in the repository.", "type": ["null", "string"] }, "hooks_url": { + "description": "URL to access hooks in the repository.", "type": ["null", "string"] }, "issue_events_url": { + "description": "URL to access issue events in the repository.", "type": ["null", "string"] }, "events_url": { + "description": "URL to access events associated with the repository.", "type": ["null", "string"] }, "assignees_url": { + "description": "URL to access assignees of the repository.", "type": ["null", "string"] }, "branches_url": { + "description": "URL to access branches of the repository.", "type": ["null", "string"] }, "tags_url": { + "description": "URL to access tags in the repository.", "type": ["null", "string"] }, "blobs_url": { + "description": "URL to access blobs in the repository.", "type": ["null", "string"] }, "git_tags_url": { + "description": "URL to access git tags in the repository.", "type": ["null", "string"] }, "git_refs_url": { + "description": "URL to access git refs in the repository.", "type": ["null", "string"] }, "trees_url": { + "description": "URL to access trees in the repository.", "type": ["null", "string"] }, "statuses_url": { + "description": "URL to access commit statuses in the repository.", "type": ["null", "string"] }, "languages_url": { + "description": "URL to access languages used in the repository.", "type": ["null", "string"] }, "stargazers_url": { + "description": "URL to access stargazers of the repository.", "type": ["null", "string"] }, "contributors_url": { + "description": "URL to access contributors of the repository.", "type": ["null", "string"] }, "subscribers_url": { + "description": "URL to access subscribers of the repository.", "type": ["null", "string"] }, "subscription_url": { + "description": "URL for subscription to the repository.", "type": ["null", "string"] }, "commits_url": { + "description": "URL to access commits in the repository.", "type": ["null", "string"] }, "git_commits_url": { + "description": "URL to access git commits in the repository.", "type": ["null", "string"] }, "comments_url": { + "description": "URL to access comments in the repository.", "type": ["null", "string"] }, "issue_comment_url": { + "description": "URL to access issue comments in the repository.", "type": ["null", "string"] }, "contents_url": { + "description": "URL to access contents of the repository.", "type": ["null", "string"] }, "compare_url": { + "description": "URL to compare the repository with another ref/commit.", "type": ["null", "string"] }, "merges_url": { + "description": "URL to access merges in the repository.", "type": ["null", "string"] }, "archive_url": { + "description": "URL to access the repository's archive.", "type": ["null", "string"] }, "downloads_url": { + "description": "URL to access downloads in the repository.", "type": ["null", "string"] }, "issues_url": { + "description": "URL to access issues in the repository.", "type": ["null", "string"] }, "pulls_url": { + "description": "URL to access pulls in the repository.", "type": ["null", "string"] }, "milestones_url": { + "description": "URL to access milestones in the repository.", "type": ["null", "string"] }, "notifications_url": { + "description": "URL to access notifications in the repository.", "type": ["null", "string"] }, "labels_url": { + "description": "URL to access labels in the repository.", "type": ["null", "string"] }, "releases_url": { + "description": "URL to access releases in the repository.", "type": ["null", "string"] }, "deployments_url": { + "description": "URL to access deployments of the repository.", "type": ["null", "string"] } } }, "head_repository": { + "description": "Information about the repository where the workflow was triggered.", "type": ["null", "object"], "properties": { "id": { + "description": "ID of the repository.", "type": ["null", "integer"] }, "node_id": { + "description": "Node ID of the repository.", "type": ["null", "string"] }, "name": { + "description": "Name of the repository.", "type": ["null", "string"] }, "full_name": { + "description": "Full name of the repository.", "type": ["null", "string"] }, "private": { + "description": "Indicates if the repository is private.", "type": ["null", "boolean"] }, "owner": { + "description": "The owner of the repository.", "$ref": "user.json" }, "html_url": { + "description": "HTML URL of the repository.", "type": ["null", "string"] }, "description": { + "description": "Description of the repository.", "type": ["null", "string"] }, "fork": { + "description": "Indicates if the repository is a fork.", "type": ["null", "boolean"] }, "url": { + "description": "URL of the repository.", "type": ["null", "string"] }, "forks_url": { + "description": "URL to access forks of the repository.", "type": ["null", "string"] }, "keys_url": { + "description": "URL to access keys of the repository.", "type": ["null", "string"] }, "collaborators_url": { + "description": "URL to access collaborators of the repository.", "type": ["null", "string"] }, "teams_url": { + "description": "URL to access teams in the repository.", "type": ["null", "string"] }, "hooks_url": { + "description": "URL to access hooks in the repository.", "type": ["null", "string"] }, "issue_events_url": { + "description": "URL to access issue events in the repository.", "type": ["null", "string"] }, "events_url": { + "description": "URL to access events associated with the repository.", "type": ["null", "string"] }, "assignees_url": { + "description": "URL to access assignees of the repository.", "type": ["null", "string"] }, "branches_url": { + "description": "URL to access branches of the repository.", "type": ["null", "string"] }, "tags_url": { + "description": "URL to access tags in the repository.", "type": ["null", "string"] }, "blobs_url": { + "description": "URL to access blobs in the repository.", "type": ["null", "string"] }, "git_tags_url": { + "description": "URL to access git tags in the repository.", "type": ["null", "string"] }, "git_refs_url": { + "description": "URL to access git refs in the repository.", "type": ["null", "string"] }, "trees_url": { + "description": "URL to access trees in the repository.", "type": ["null", "string"] }, "statuses_url": { + "description": "URL to access commit statuses in the repository.", "type": ["null", "string"] }, "languages_url": { + "description": "URL to access languages used in the repository.", "type": ["null", "string"] }, "stargazers_url": { + "description": "URL to access stargazers of the repository.", "type": ["null", "string"] }, "contributors_url": { + "description": "URL to access contributors of the repository.", "type": ["null", "string"] }, "subscribers_url": { + "description": "URL to access subscribers of the repository.", "type": ["null", "string"] }, "subscription_url": { + "description": "URL for subscription to the repository.", "type": ["null", "string"] }, "commits_url": { + "description": "URL to access commits in the repository.", "type": ["null", "string"] }, "git_commits_url": { + "description": "URL to access git commits in the repository.", "type": ["null", "string"] }, "comments_url": { + "description": "URL to access comments in the repository.", "type": ["null", "string"] }, "issue_comment_url": { + "description": "URL to access issue comments in the repository.", "type": ["null", "string"] }, "contents_url": { + "description": "URL to access contents of the repository.", "type": ["null", "string"] }, "compare_url": { + "description": "URL to compare the repository with another ref/commit.", "type": ["null", "string"] }, "merges_url": { + "description": "URL to access merges in the repository.", "type": ["null", "string"] }, "archive_url": { + "description": "URL to access the repository's archive.", "type": ["null", "string"] }, "downloads_url": { + "description": "URL to access downloads in the repository.", "type": ["null", "string"] }, "issues_url": { + "description": "URL to access issues in the repository.", "type": ["null", "string"] }, "pulls_url": { + "description": "URL to access pulls in the repository.", "type": ["null", "string"] }, "milestones_url": { + "description": "URL to access milestones in the repository.", "type": ["null", "string"] }, "notifications_url": { + "description": "URL to access notifications in the repository.", "type": ["null", "string"] }, "labels_url": { + "description": "URL to access labels in the repository.", "type": ["null", "string"] }, "releases_url": { + "description": "URL to access releases in the repository.", "type": ["null", "string"] }, "deployments_url": { + "description": "URL to access deployments of the repository.", "type": ["null", "string"] } } }, "actor": { + "description": "The user or entity responsible for triggering the workflow run.", "$ref": "user.json" }, "triggering_actor": { + "description": "The user or entity that triggered the workflow run.", "$ref": "user.json" } } diff --git a/airbyte-integrations/connectors/source-github/source_github/schemas/workflows.json b/airbyte-integrations/connectors/source-github/source_github/schemas/workflows.json index cf7e341e86e..a5eeb89fa42 100644 --- a/airbyte-integrations/connectors/source-github/source_github/schemas/workflows.json +++ b/airbyte-integrations/connectors/source-github/source_github/schemas/workflows.json @@ -3,38 +3,49 @@ "type": ["null", "object"], "properties": { "id": { + "description": "Unique identifier for the workflow", "type": "integer" }, "node_id": { + "description": "Node ID of the workflow", "type": ["null", "string"] }, "name": { + "description": "Name of the workflow", "type": ["null", "string"] }, "path": { + "description": "Path to the workflow in the repository", "type": ["null", "string"] }, "state": { + "description": "Current state of the workflow", "type": ["null", "string"] }, "created_at": { + "description": "Date and time when the workflow was created", "type": "string", "format": "date-time" }, "updated_at": { + "description": "Date and time when the workflow was last updated", "type": "string", "format": "date-time" }, "url": { + "description": "URL to access detailed information about the workflow", "type": ["null", "string"] }, "html_url": { + "description": "URL to view the workflow on GitHub's web interface", "type": ["null", "string"] }, "badge_url": { + "description": "URL for the badge that represents the workflow status", "type": ["null", "string"] }, "repository": { + "description": "Repository information associated with the workflow", "type": "string" } } diff --git a/docs/integrations/sources/github.md b/docs/integrations/sources/github.md index 09d79f218e0..5ca3e36afb2 100644 --- a/docs/integrations/sources/github.md +++ b/docs/integrations/sources/github.md @@ -206,8 +206,9 @@ Your token should have at least the `repo` scope. Depending on which streams you | Version | Date | Pull Request | Subject | |:--------|:-----------|:------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 1.7.1 | 2024-03-24 | [00000](https://github.com/airbytehq/airbyte/pull/00000) | Support repository names with wildcards. Do not look for repository branches at discovery time. | -| 1.7.0 | 2024-03-19 | [36267](https://github.com/airbytehq/airbyte/pull/36267) | Pin airbyte-cdk version to `^0` | +| 1.7.2 | 2024-04-19 | [36636](https://github.com/airbytehq/airbyte/pull/36636) | Updating to 0.80.0 CDK | +| 1.7.1 | 2024-04-12 | [36636](https://github.com/airbytehq/airbyte/pull/36636) | schema descriptions | +| 1.7.0 | 2024-03-19 | [36267](https://github.com/airbytehq/airbyte/pull/36267) | Pin airbyte-cdk version to `^0` | | 1.6.5 | 2024-03-12 | [35986](https://github.com/airbytehq/airbyte/pull/35986) | Handle rate limit exception as config error | | 1.6.4 | 2024-03-08 | [35915](https://github.com/airbytehq/airbyte/pull/35915) | Fix per stream error handler; Make use the latest CDK version | | 1.6.3 | 2024-02-15 | [35271](https://github.com/airbytehq/airbyte/pull/35271) | Update branches schema |