swgg-github-repos
Version:
this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-repos's web-apis, with a working web-demo
1,111 lines • 802 kB
JSON
{
"basePath": "/",
"definitions": {
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20PATCH.body": {
"properties": {
"allow_merge_commit": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow merging pull requests with a merge commit, or ```false``` to prevent merging pull requests with merge commits. Default: ```true```"
]
},
"allow_rebase_merge": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow rebase-merging pull requests, or ```false``` to prevent rebase-merging. Default: ```true```"
]
},
"allow_squash_merge": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow squash-merging pull requests, or ```false``` to prevent squash-merging. Default: ```true```"
]
},
"archived": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"```true``` to archive this repository. **Note**: You cannot unarchive repositories through the API. Default: ```false```"
]
},
"default_branch": {
"type": "string",
"x-swgg-descriptionLineList": [
"Updates the default branch for this repository."
]
},
"description": {
"default": "This is your first repository",
"type": "string",
"x-swgg-descriptionLineList": [
"A short description of the repository."
]
},
"has_issues": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```."
]
},
"has_projects": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable projects for this repository or ```false``` to disable them. Default: ```true```. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is ```false```, and if you pass ```true```, the API returns an error."
]
},
"has_wiki": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable the wiki for this repository or ```false``` to disable it. Default: ```true```."
]
},
"homepage": {
"default": "https://github.com",
"type": "string",
"x-swgg-descriptionLineList": [
"A URL with more information about the repository."
]
},
"name": {
"default": "Hello-World",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The name of the repository."
]
},
"private": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to make the repository private or ```false``` to make it public. Creating private repositories requires a paid GitHub account. Default: ```false```.",
"**Note**: You will get a ```422``` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private."
]
}
},
"required": [
"name"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body": {
"properties": {
"enforce_admins": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"**Required**. Enforce all configured restrictions for administrators. Set to ```true``` to enforce required status checks for repository administrators. Set to ```null``` to disable."
]
},
"required_pull_request_reviews": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_pull_request_reviews",
"type": "object",
"x-swgg-descriptionLineList": [
"**Required**. Require at least one approving review on a pull request, before merging. Set to ```null``` to disable."
]
},
"required_status_checks": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_status_checks",
"type": "object",
"x-swgg-descriptionLineList": [
"**Required**. Require status checks to pass before merging. Set to ```null``` to disable."
]
},
"restrictions": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.restrictions",
"type": "object",
"x-swgg-descriptionLineList": [
"**Required**. Restrict who can push to this branch. Team and user ```restrictions``` are only available for organization-owned repositories. Set to ```null``` to disable."
]
}
},
"required": [
"required_status_checks",
"enforce_admins",
"required_pull_request_reviews",
"restrictions"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_pull_request_reviews": {
"properties": {
"dismiss_stale_reviews": {
"default": true,
"type": "boolean"
},
"dismissal_restrictions": {
"default": {
"teams": [
"justice-league"
],
"users": [
"octocat"
]
},
"type": "object"
},
"require_code_owner_reviews": {
"default": true,
"type": "boolean"
},
"required_approving_review_count": {
"default": 2,
"type": "number"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_status_checks": {
"properties": {
"contexts": {
"default": [
"continuous-integration/travis-ci"
],
"items": {
"type": "string"
},
"type": "array"
},
"strict": {
"default": true,
"type": "boolean"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.restrictions": {
"properties": {
"teams": {
"default": [
"justice-league"
],
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"default": [
"octocat"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body": {
"properties": {
"dismiss_stale_reviews": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Set to ```true``` if you want to automatically dismiss approving reviews when someone pushes a new commit."
]
},
"dismissal_restrictions": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body.dismissal_restrictions",
"type": "object",
"x-swgg-descriptionLineList": [
"Specify which users and teams can dismiss pull request reviews. Pass an empty ```dismissal_restrictions``` object to disable. User and team ```dismissal_restrictions``` are only available for organization-owned repositories. Omit this parameter for personal repositories."
]
},
"require_code_owner_reviews": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Blocks merging pull requests until code owners have reviewed."
]
},
"required_approving_review_count": {
"default": 2,
"type": "integer",
"x-swgg-descriptionLineList": [
"Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body.dismissal_restrictions": {
"properties": {
"teams": {
"default": [
"justice-league"
],
"items": {
"type": "string"
},
"type": "array"
},
"users": {
"default": [
"octocat"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20PATCH.body": {
"properties": {
"contexts": {
"default": [
"continuous-integration/travis-ci"
],
"items": {
"type": "string"
},
"type": "array",
"x-swgg-descriptionLineList": [
"The list of status checks to require in order to merge into this branch"
]
},
"strict": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Require branches to be up to date before merging."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20PATCH.body": {
"properties": {
"body": {
"default": "Nice change",
"type": "string"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_2Fcomments_20POST.body": {
"properties": {
"body": {
"default": "Great stuff",
"type": "string"
},
"line": {
"default": null,
"type": "integer",
"x-swgg-descriptionLineList": [
"**Deprecated**. Use **position** parameter instead. Line number in the file to comment on."
]
},
"path": {
"default": "file1.txt",
"type": "string",
"x-swgg-descriptionLineList": [
"Relative path of the file to comment on."
]
},
"position": {
"default": 4,
"type": "integer",
"x-swgg-descriptionLineList": [
"Line index in the diff to comment on."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body": {
"properties": {
"branch": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"The branch name. Default: the repository’s default branch (usually ```master```)"
]
},
"committer": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body.committer"
},
"message": {
"default": "my commit message",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The commit message."
]
},
"sha": {
"default": "329688480d39049927147c162b9d2deaf885005f",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The blob SHA of the file being replaced."
]
}
},
"required": [
"message",
"sha"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body.committer": {
"properties": {
"email": {
"default": "schacon@gmail.com",
"type": "string"
},
"name": {
"default": "Scott Chacon",
"type": "string"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body": {
"properties": {
"branch": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"The branch name. Default: the repository’s default branch (usually ```master```)"
]
},
"committer": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body.committer"
},
"content": {
"default": "bXkgbmV3IGZpbGUgY29udGVudHM=",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The new file content, Base64 encoded."
]
},
"message": {
"default": "my commit message",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The commit message."
]
}
},
"required": [
"message",
"content"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body.committer": {
"properties": {
"email": {
"default": "schacon@gmail.com",
"type": "string"
},
"name": {
"default": "Scott Chacon",
"type": "string"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body": {
"properties": {
"branch": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"The branch name. Default: the repository’s default branch (usually ```master```)"
]
},
"committer": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body.committer"
},
"content": {
"default": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The updated file content, Base64 encoded."
]
},
"message": {
"default": "my commit message",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The commit message."
]
},
"sha": {
"default": "329688480d39049927147c162b9d2deaf885005f",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The blob SHA of the file being replaced."
]
}
},
"required": [
"message",
"content",
"sha"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body.committer": {
"properties": {
"email": {
"default": "schacon@gmail.com",
"type": "string"
},
"name": {
"default": "Scott Chacon",
"type": "string"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_20POST.body": {
"properties": {
"auto_inactive": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Adds a new ```inactive``` status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. Default: ```true``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**"
]
},
"description": {
"default": "Deployment finished successfully.",
"type": "string",
"x-swgg-descriptionLineList": [
"A short description of the status. Maximum length of 140 characters. Default: ```\"\"```"
]
},
"environment_url": {
"type": "string",
"x-swgg-descriptionLineList": [
"Sets the URL for accessing your environment. Default: ```\"\"``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**"
]
},
"log_url": {
"type": "string",
"x-swgg-descriptionLineList": [
"This is functionally equivalent to ```target_url```. We will continue accept ```target_url``` to support legacy uses, but we recommend modifying this to the new name to avoid confusion. Default: ```\"\"``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**"
]
},
"state": {
"default": "success",
"enum": [
"error",
"failure",
"inactive",
"pending",
"success"
],
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The state of the status. Can be one of ```error```, ```failure```, ```inactive```, ```pending```, or ```success```. **The ```inactive``` state requires a custom media type to be specified. Please see more in the alert below.**"
]
},
"target_url": {
"default": "https://example.com/deployment/42/output",
"type": "string",
"x-swgg-descriptionLineList": [
"The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Default: ```\"\"```"
]
}
},
"required": [
"state"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body": {
"properties": {
"active": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Determines if notifications are sent when the webhook is triggered. Set to ```true``` to send notifications. Default: ```true```."
]
},
"config": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body.config",
"type": "object",
"x-swgg-descriptionLineList": [
"**Required**. Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params)."
]
},
"events": {
"default": [
"push"
],
"items": {
"type": "string"
},
"type": "array",
"x-swgg-descriptionLineList": [
"Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. Default: ```[\"push\"]```"
]
},
"name": {
"default": "web",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. Must be passed as \"web\"."
]
}
},
"required": [
"name",
"config"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body.config": {
"properties": {
"content_type": {
"default": "json",
"type": "string"
},
"url": {
"default": "http://example.com/webhook",
"type": "string"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20PATCH.body": {
"properties": {
"active": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Determines if notifications are sent when the webhook is triggered. Set to ```true``` to send notifications. Default: ```true```."
]
},
"add_events": {
"default": [
"pull_request"
],
"items": {
"type": "string"
},
"type": "array",
"x-swgg-descriptionLineList": [
"Determines a list of events to be added to the list of events that the Hook triggers for."
]
},
"config": {
"type": "object",
"x-swgg-descriptionLineList": [
"**Required**. Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params)."
]
},
"events": {
"default": [
"push"
],
"items": {
"type": "string"
},
"type": "array",
"x-swgg-descriptionLineList": [
"Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. Default: ```[\"push\"]```"
]
},
"remove_events": {
"items": {
"type": "string"
},
"type": "array",
"x-swgg-descriptionLineList": [
"Determines a list of events to be removed from the list of events that the Hook triggers for."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_20POST.body": {
"properties": {
"key": {
"default": "ssh-rsa AAA...",
"type": "string",
"x-swgg-descriptionLineList": [
"The contents of the key."
]
},
"read_only": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"If ```true```, the key will only be able to read repository contents. Otherwise, the key will be able to read and write."
]
},
"title": {
"default": "octocat@octomac",
"type": "string",
"x-swgg-descriptionLineList": [
"A name for the key."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_20POST.body": {
"properties": {
"body": {
"default": "Description of the release",
"type": "string"
},
"draft": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"```true``` to create a draft (unpublished) release, ```false``` to create a published one. Default: ```false```"
]
},
"name": {
"default": "v1.0.0",
"type": "string",
"x-swgg-descriptionLineList": [
"The name of the release."
]
},
"prerelease": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"```true``` to identify the release as a prerelease. ```false``` to identify the release as a full release. Default: ```false```"
]
},
"tag_name": {
"default": "v1.0.0",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The name of the tag."
]
},
"target_commitish": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually ```master```)."
]
}
},
"required": [
"tag_name"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20PATCH.body": {
"properties": {
"body": {
"default": "Description of the release",
"type": "string"
},
"draft": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"```true``` makes the release a draft, and ```false``` publishes the release."
]
},
"name": {
"default": "v1.0.0",
"type": "string",
"x-swgg-descriptionLineList": [
"The name of the release."
]
},
"prerelease": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"```true``` to identify the release as a prerelease, ```false``` to identify the release as a full release."
]
},
"tag_name": {
"default": "v1.0.0",
"type": "string",
"x-swgg-descriptionLineList": [
"The name of the tag."
]
},
"target_commitish": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually ```master```)."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20PATCH.body": {
"properties": {
"label": {
"default": "Mac binary",
"type": "string",
"x-swgg-descriptionLineList": [
"An alternate short description of the asset. Used in place of the filename."
]
},
"name": {
"default": "foo-1.0.0-osx.zip",
"type": "string",
"x-swgg-descriptionLineList": [
"The file name of the asset."
]
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstatuses_2F_7Bsha_7D_20POST.body": {
"properties": {
"context": {
"default": "default",
"type": "string",
"x-swgg-descriptionLineList": [
"A string label to differentiate this status from the status of other systems. Default: ```default```"
]
},
"description": {
"default": "The build succeeded!",
"type": "string",
"x-swgg-descriptionLineList": [
"A short description of the status."
]
},
"state": {
"default": "success",
"enum": [
"error",
"failure",
"pending",
"success"
],
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The state of the status. Can be one of ```error```, ```failure```, ```pending```, or ```success```."
]
},
"target_url": {
"default": "https://example.com/build/status",
"type": "string",
"x-swgg-descriptionLineList": [
"The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.",
"For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:",
"```http://ci.example.com/user/repo/build/sha```"
]
}
},
"required": [
"state"
],
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftopics_20PUT.body": {
"properties": {
"names": {
"default": [
"octocat",
"atom",
"electron",
"API"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftransfer_20POST.body": {
"properties": {
"new_owner": {
"default": "github",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required:** The username or organization name the repository will be transferred to."
]
},
"team_id": {
"default": [
12,
345
],
"items": {
"type": "number"
},
"type": "array"
}
},
"x-swgg-tags0": "github-repos"
},
"_2Fuser_2Frepos_20POST.body": {
"properties": {
"allow_merge_commit": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow merging pull requests with a merge commit, or ```false``` to prevent merging pull requests with merge commits. Default: ```true```"
]
},
"allow_rebase_merge": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow rebase-merging pull requests, or ```false``` to prevent rebase-merging. Default: ```true```"
]
},
"allow_squash_merge": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to allow squash-merging pull requests, or ```false``` to prevent squash-merging. Default: ```true```"
]
},
"auto_init": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Pass ```true``` to create an initial commit with empty README. Default: ```false```."
]
},
"description": {
"default": "This is your first repository",
"type": "string",
"x-swgg-descriptionLineList": [
"A short description of the repository."
]
},
"gitignore_template": {
"type": "string",
"x-swgg-descriptionLineList": [
"Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"."
]
},
"has_issues": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```."
]
},
"has_projects": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable projects for this repository or ```false``` to disable them. Default: ```true```. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is ```false```, and if you pass ```true```, the API returns an error."
]
},
"has_wiki": {
"default": true,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to enable the wiki for this repository or ```false``` to disable it. Default: ```true```."
]
},
"homepage": {
"default": "https://github.com",
"type": "string",
"x-swgg-descriptionLineList": [
"A URL with more information about the repository."
]
},
"license_template": {
"type": "string",
"x-swgg-descriptionLineList": [
"Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the ```license_template``` string. For example, \"mit\" or \"mpl-2.0\"."
]
},
"name": {
"default": "Hello-World",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The name of the repository."
]
},
"private": {
"default": false,
"type": "boolean",
"x-swgg-descriptionLineList": [
"Either ```true``` to create a private repository or ```false``` to create a public one. Creating private repositories requires a paid GitHub account. Default: ```false```."
]
},
"team_id": {
"type": "integer",
"x-swgg-descriptionLineList": [
"The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization."
]
}
},
"required": [
"name"
],
"x-swgg-tags0": "github-repos"
}
},
"info": {
"title": "swgg-github-repos",
"version": "2018.3.28",
"x-swgg-description": "this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-repos's web-apis, with a working web-demo",
"x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-repos"
},
"parameters": {
"github-all.key": {
"default": "xxxxxxxx",
"in": "query",
"name": "access_token",
"type": "string",
"x-swgg-apiKey": true,
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/#authentication",
"",
"OAuth2 token (sent as a parameter)"
]
},
"github-all.user-agent": {
"default": "Awesome-Octocat-App",
"in": "header",
"name": "user-agent",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/index.html#user-agent-required",
"",
"All API requests MUST include a valid ```User-Agent``` header. Requests with no ```User-Agent``` header will be rejected. We request that you use your GitHub username, or the name of your application, for the ```User-Agent``` header value. This allows us to contact you if there are problems."
]
}
},
"paths": {
"/<upload_url>/repos/{owner}/{repo}/releases/{id}/assets": {
"post": {
"operationId": "_2F_26lt_3Bupload_url_26gt_3B_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_2Fassets_20POST",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.jean-grey-preview+json"
],
"enum": [
"application/vnd.github.jean-grey-preview+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"default": "foo.zip",
"in": "query",
"name": "name",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The file name of the asset. This should be set in a URI query parameter."
]
},
{
"in": "query",
"name": "Content-Type",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The content type of the asset. This should be set in the Header. Example:",
"```",
"application/zip",
"```",
". For a list of acceptable types, refer this list of [media types](https://www.iana.org/assignments/media-types/media-types.xhtml)."
]
},
{
"in": "query",
"name": "label",
"type": "string",
"x-swgg-descriptionLineList": [
"An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-repos"
],
"x-swgg-descriptionLineList": [
"[Releases](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) - Upload a release asset",
"",
"This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. This endpoint is provided by a URI template in [the release's API response](https://developer.github.com/v3/repos/releases/#get-a-single-release). You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.",
"",
"The asset data is expected in its raw binary form, rather than JSON. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset."
],
"x-swgg-host": "",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) - Upload a release asset",
"x-swgg-tags0": "github-repos"
}
},
"/orgs/{org}/repos": {
"get": {
"operationId": "_2Forgs_2F_7Borg_7D_2Frepos_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.nightshade-preview+json"
],
"enum": [
"application/vnd.github.mercy-preview+json",
"application/vnd.g