This repository has been archived by the owner on Jul 27, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
{ | ||
"summary": "Lock an issue", | ||
"description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", | ||
"operationId": "lock", | ||
"tags": [ | ||
"issues" | ||
], | ||
"externalDocs": { | ||
"description": "API method documentation", | ||
"url": "https://developer.github.com/v3/issues/#lock-an-issue" | ||
}, | ||
"parameters": [{ | ||
"$ref": "../../parameters.json#/owner" | ||
}, | ||
{ | ||
"$ref": "../../parameters.json#/repo" | ||
}, | ||
{ | ||
"$ref": "../../parameters.json#/number" | ||
} | ||
], | ||
"requestBody": { | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"type": "object", | ||
"properties": { | ||
"lock_reason": { | ||
"type": "string", | ||
"enum": [ | ||
"off-topic", | ||
"too heated", | ||
"resolved", | ||
"spam" | ||
], | ||
"description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"x-code-samples": [ | ||
{ | ||
"lang": "Shell", | ||
"source": "curl -X PUT https://api.github.com/repos/octocat/hello-world/issues/1/lock" | ||
}, | ||
{ | ||
"lang": "JS", | ||
"source": "client.issues.lock({\n owner: 'octocat',\n repo: 'hello-world',\n number: 1\n})" | ||
} | ||
], | ||
"responses": { | ||
"204": { | ||
"description": "No Content" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"summary": "Unlock an issue", | ||
"description": "Users with push access can unlock an issue's conversation.", | ||
"operationId": "unlock", | ||
"tags": [ | ||
"issues" | ||
], | ||
"externalDocs": { | ||
"description": "API method documentation", | ||
"url": "https://developer.github.com/v3/issues/#unlock-an-issue" | ||
}, | ||
"parameters": [{ | ||
"$ref": "../../parameters.json#/owner" | ||
}, | ||
{ | ||
"$ref": "../../parameters.json#/repo" | ||
}, | ||
{ | ||
"$ref": "../../parameters.json#/number" | ||
} | ||
], | ||
"x-code-samples": [ | ||
{ | ||
"lang": "Shell", | ||
"source": "curl -X DELETE https://api.github.com/repos/octocat/hello-world/issues/1/lock" | ||
}, | ||
{ | ||
"lang": "JS", | ||
"source": "client.issues.unlock({\n owner: 'octocat',\n repo: 'hello-world',\n number: 1\n})" | ||
} | ||
], | ||
"responses": { | ||
"204": { | ||
"description": "No Content" | ||
} | ||
} | ||
} |