github/openapi/github-octocat-openapi.yml at main · api-evangelist/github · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
openapi: 3.0.3
info:
  version: 1.1.4
  title: GitHub Octocat API
  description: >-
    Offers a basic endpoint to fetch the Octocat as ASCII art and provides a
    default Octocat image URL.
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  x-github-plan: ghes
  x-github-release: 3.9
tags:
- name: Get
- name: Octocat
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
externalDocs:
  description: GitHub Enterprise Developer Docs
  url: https://docs.github.com/enterprise-server@3.9/rest/
paths:
  /octocat:
    get:
      summary: GitHub Get Octocat
      description: >-
        The GitHub Octocat API endpoint allows users to retrieve an ASCII art
        representation of GitHub's mascot, Octocat, by sending a GET request to
        the /octocat path. This simple API operation returns the iconic Octocat
        image in text format, which can be customized with an optional query
        parameter to display different speech bubble messages. It's primarily
        used for fun, testing purposes, or as an Easter egg in applications,
        demonstrating GitHub's playful side while providing developers with a
        lighthearted way to verify API connectivity.
      tags:
      - Get
      - Octocat
      operationId: getOctocat
      parameters:
      - name: s
        in: query
        description: The words to show in Octocat's speech bubble
        schema:
          type: string
        required: false
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/octocat-stream:
              schema:
                type: string
              examples:
                default:
                  $ref: '#/components/examples/octocat'
      externalDocs:
        description: API method documentation
        url: >-
          https://docs.github.com/enterprise-server@3.9/rest/meta/meta#get-octocat
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: meta
        subcategory: meta
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    octocat:
      value: |2
                       MMM.           .MMM
                       MMMMMMMMMMMMMMMMMMM
                       MMMMMMMMMMMMMMMMMMM      ___________________________________
                      MMMMMMMMMMMMMMMMMMMMM    |                                   |
                     MMMMMMMMMMMMMMMMMMMMMMM   | Avoid administrative distraction. |
                    MMMMMMMMMMMMMMMMMMMMMMMM   |_   _______________________________|
                    MMMM::- -:::::::- -::MMMM    |/
                     MM~:~ 00~:::::~ 00~:~MM
                .. MMMMM::.00:::+:::.00::MMMMM ..
                      .MM::::: ._. :::::MM.
                         MMMM;:::::;MMMM
                  -MM        MMMMMMM
                  ^  M+     MMMMMMMMM
                      MMMMMMM MM MM MM
                           MM MM MM MM
                           MM MM MM MM
                        .~~MM~MM~MM~MM~~.
                     ~~~~MM:~MM~~~MM~:MM~~~~
                    ~~~~~~==~==~~~==~==~~~~~~
                     ~~~~~~==~==~==~==~~~~~~
                         :~==~==~==~==~~
  reponses: {}
  parameters: {}
  schemas: {}
  responses: {}
  headers: {}
  securitySchemes:
    bearerHttpAuthentication:
      description: Bearer Token
      type: http
      scheme: Bearer