Skip to content

Instantly share code, notes, and snippets.

@jovemfelix
Last active September 5, 2024 18:37
Show Gist options
  • Save jovemfelix/cb792a117d9fa778d6819853c9c85db3 to your computer and use it in GitHub Desktop.
Save jovemfelix/cb792a117d9fa778d6819853c9c85db3 to your computer and use it in GitHub Desktop.
openapi: "3.0.0"
info:
version: 1.0.3
title: Github 02
description: "some description 02.4"
license:
name: MIT
servers:
- url: http://t1.hub.io/v2
paths:
/eogs:
get:
summary: List all eogs
operationId: listEogs
tags:
- eogs
parameters:
- name: limit
in: query
description: testing
required: false
schema:
type: integer
maximum: 100
format: int32
responses:
'200':
description: A paged array of eogs
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Eogs"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a cog
operationId: createEogs
tags:
- eogs
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Eog'
required: true
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/eogs/{dogId}:
get:
summary: Info for a specific dog
operationId: showEogById
tags:
- eogs
parameters:
- name: dogId
in: path
required: true
description: The id of the dog to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Eog"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Eog:
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Eogs:
type: array
maxItems: 100
items:
$ref: "#/components/schemas/Eog"
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment