View the progress of an import.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.View the progress of an import.
\nWarnings:
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarnings:
An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
Warnings:
\nStop an import for a repository.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Stop an import for a repository.
\nWarnings:
\nEach type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarnings:
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarnings:
\nList files larger than 100MB found during the import
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "List files larger than 100MB found during the import
\nWarnings:
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarnings:
\nThe organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Create or update custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "The array of custom properties to create or update.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "string or null", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "Ordered list of allowed values of the property
" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "value_type", + "in": "body", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "in": "body", + "description": "Whether the property is required.
" + }, + { + "type": "string or null", + "name": "default_value", + "in": "body", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "in": "body", + "description": "Ordered list of allowed values of the property
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Remove a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "A header with no content is returned.
" + } + } + ], + "previews": [], + "descriptionHTML": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "title": "List custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "title": "Create or update custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repository_names", + "in": "body", + "description": "The names of repositories that the custom property values will be applied to.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "List of custom property names and associated values to apply to the repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.
\nA maximum of 30 repositories can be updated in a single request.
\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.
Only organization owners (or users with the proper permissions granted by them) can update these properties
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", @@ -483619,6 +484664,111 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Get all custom property values for a repository", + "category": "repos", + "subcategory": "properties", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
Response
", + "example": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 4128de5f4d..eaf2c1f91c 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -360449,7 +360449,7 @@ } ], "previews": [], - "descriptionHTML": "View the progress of an import.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.View the progress of an import.
\nWarnings:
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\ndetecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.If there are problems, you will see one of these in the status field:
auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\nuse_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see changelog. In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.\nWarnings:
An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
Warning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
Warnings:
\nStop an import for a repository.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Stop an import for a repository.
\nWarnings:
\nEach type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
\nWarnings:
\nUpdate an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.
\nWarnings:
\nList files larger than 100MB found during the import
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "List files larger than 100MB found during the import
\nWarnings:
\nYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarning: Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see changelog. In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.
", + "descriptionHTML": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.
\nYou can learn more about our LFS feature and working with large files on our help\nsite.
\nWarnings:
\nThe organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/schema", + "title": "Create or update custom properties for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "The array of custom properties to create or update.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string", + "name": "value_type", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "description": "Whether the property is required.
" + }, + { + "type": "string or null", + "name": "default_value", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "description": "Ordered list of allowed values of the property
" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "value_type", + "in": "body", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select" + ] + }, + { + "type": "boolean", + "name": "required", + "in": "body", + "description": "Whether the property is required.
" + }, + { + "type": "string or null", + "name": "default_value", + "in": "body", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "in": "body", + "description": "Ordered list of allowed values of the property
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": [ + "string", + "null" + ], + "description": "Default value of the property" + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "title": "Remove a custom property for an organization", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "A header with no content is returned.
" + } + } + ], + "previews": [], + "descriptionHTML": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/properties/values", + "title": "List custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/properties/values", + "title": "Create or update custom property values for organization repositories", + "category": "orgs", + "subcategory": "properties", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of strings", + "name": "repository_names", + "in": "body", + "description": "The names of repositories that the custom property values will be applied to.
", + "isRequired": true + }, + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "List of custom property names and associated values to apply to the repositories.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "The name of the property
", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "The value assigned to the property
", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.
\nA maximum of 30 repositories can be updated in a single request.
\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.
Only organization owners (or users with the proper permissions granted by them) can update these properties
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", @@ -506043,6 +507088,111 @@ ] } ], + "properties": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Get all custom property values for a repository", + "category": "repos", + "subcategory": "properties", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
Response
", + "example": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": [ + "string", + "null" + ], + "description": "The value assigned to the property" + } + }, + "required": [ + "property_name", + "value" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ], "rule-suites": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 01b43f8c81..84c874a210 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "2ebc81f343d9839e1ed5150caf6dcfed7d92eb11" + "sha": "0590bfae7149f3fee6429d1e031646d79abb8f9a" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 38cca54ffb..1e7617acb6 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -200833,7 +200833,7 @@ "repository_ruleset": { "created": { "descriptionHtml": "A repository ruleset was created.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -201664,7 +201664,7 @@ }, "deleted": { "descriptionHtml": "A repository ruleset was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -202495,7 +202495,7 @@ }, "edited": { "descriptionHtml": "A repository ruleset was edited.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index f07966cdfb..510901c628 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -200833,7 +200833,7 @@ "repository_ruleset": { "created": { "descriptionHtml": "A repository ruleset was created.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -201664,7 +201664,7 @@ }, "deleted": { "descriptionHtml": "A repository ruleset was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -202495,7 +202495,7 @@ }, "edited": { "descriptionHtml": "A repository ruleset was edited.
", - "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.
", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 95d43b1c0f..265287ba20 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2ebc81f343d9839e1ed5150caf6dcfed7d92eb11" + "sha": "0590bfae7149f3fee6429d1e031646d79abb8f9a" } \ No newline at end of file