Examples¶
This page contains additional examples without further elaboration. Each example is preceded by it’s ReStructuredText source.
.. json:object:: Github Issue
:showexample:
Information about a Github issue.
:property id: Github assigned issue ID
:proptype id: integer
:options id: nullable, default=''
:property url url: direct link to this issue
:property url repository_url: direct link to the repository that
this issue lives in
:property url labels_url: retrieve and manipulate the labels
associated with this issue
:property url comments_url: retrieve and manipulate the comments
associated with this issue
:property url events_url: retrieve and manipulate the events associated
with this issue
:property html_url: HTML formatted information about this issue
:proptype html_url: url
:property integer number: raw issue number
:property string state: current state of the issue
:property string title: issue title
:property string body: issue body
:property user: embedded information about the user that created
the issue
:proptype user: :json:object:`Github User`
-
Github Issue
¶ Information about a Github issue.
Object Properties: - id (integer) – Github assigned issue ID (nullable, default=’‘)
- url (url) – direct link to this issue
- repository_url (url) – direct link to the repository that this issue lives in
- labels_url (url) – retrieve and manipulate the labels associated with this issue
- comments_url (url) – retrieve and manipulate the comments associated with this issue
- events_url (url) – retrieve and manipulate the events associated with this issue
- html_url (url) – HTML formatted information about this issue
- number (integer) – raw issue number
- state (string) – current state of the issue
- title (string) – issue title
- body (string) – issue body
- user (
Github User
) – embedded information about the user that created the issue
{ "comments_url": "https://wilson-clark.net/", "id": 6141, "user": { "avatar_url": "http://moore.com/", "login": "matthew99", "id": 4442, "gravatar_url": "https://miller.com/" }, "repository_url": "https://miller-herrera.biz/", "html_url": "https://www.williams.net/", "labels_url": "https://farmer.info/", "url": "https://booth-melendez.com/", "title": "EfgFUIVbFRTEutjpNVMI", "number": 6238, "state": "pmJOVWVorFrqxJzHyuRF", "body": "OnNMhXVHISFKGHbuUllq", "events_url": "https://cook-gray.com/" }
.. json:object:: Error
:showexample: yaml
What a normal JSON error body looks like.
:property string type:
:property string title:
:property integer status:
:property string detail:
:property uri instance:
The semantics of this data type is described in :rfc:`7807`.
-
Error
¶ What a normal JSON error body looks like.
Object Properties: The semantics of this data type is described in RFC 7807.
YAML Example%YAML 1.2 --- detail: bwsBFfWaLffACVkyaRXV instance: http://watson.com/tags/index/ status: 3129 title: WVkZFGjeRrFwUYIwrgDh type: ZxTIuDLPAZazhxWPbIDy
.. json:object:: Github User
:showexample:
What Github's API thinks a user looks like.
:property user_name login: the user's unique login
:property integer id: Github assigned unique user identifier
:property url avatar_url: url to user's selected avatar image
:property url gravatar_url: url to the user's gravatar image or
the empty string
-
Github User
¶ What Github’s API thinks a user looks like.
Object Properties: { "avatar_url": "http://www.hendricks-walker.com/", "login": "melanie27", "id": 1264, "gravatar_url": "https://www.schneider-fletcher.org/" }