Last active
March 26, 2019 20:45
-
-
Save Konard/c76f9948bb25a0d7aff1 to your computer and use it in GitHub Desktop.
Links (doublets) API swagger connector. Explore: http://editor.swagger.io/#/?import=https://gist.githubusercontent.com/Konard/c76f9948bb25a0d7aff1/raw/swagger.json
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
{ | |
"swagger": "2.0", | |
"info": { | |
"title": "Links (pairs) API", | |
"description": "The minimalistic API", | |
"version": "0.0.1" | |
}, | |
"host": "api2.linksplatform.github.com", | |
"schemes": [ | |
"https" | |
], | |
"basePath": "/v1", | |
"produces": [ | |
"application/json" | |
], | |
"paths": { | |
"/links": { | |
"get": { | |
"summary": "Links List", | |
"description": "The Links endpoint returns information about the Links matching given restrictions.", | |
"parameters": [ | |
{ | |
"name": "source", | |
"in": "query", | |
"description": "Source (beginning of link) restriction.", | |
"required": false, | |
"type": "integer", | |
"format": "int64" | |
}, | |
{ | |
"name": "target", | |
"in": "query", | |
"description": "Target (end of link) restriction.", | |
"required": false, | |
"type": "integer", | |
"format": "int64" | |
} | |
], | |
"tags": [ | |
"Links" | |
], | |
"responses": { | |
"200": { | |
"description": "An array of links", | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/Link" | |
} | |
} | |
}, | |
"default": { | |
"description": "Unexpected error", | |
"schema": { | |
"$ref": "#/definitions/Error" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"definitions": { | |
"Link": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64", | |
"description": "Unique identifier representing a specific link matching given source & target restrictions." | |
}, | |
"source": { | |
"type": "integer", | |
"format": "int64", | |
"description": "Identifier of Source (beginning) link." | |
}, | |
"target": { | |
"type": "integer", | |
"format": "int64", | |
"description": "Identifier of Target (end) link." | |
} | |
} | |
}, | |
"Error": { | |
"type": "object", | |
"properties": { | |
"code": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"message": { | |
"type": "string" | |
}, | |
"fields": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} |
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
swagger: '2.0' | |
info: | |
title: Links (pairs) API | |
description: The minimalistic API | |
version: 0.0.1 | |
host: api2.linksplatform.github.com | |
schemes: | |
- https | |
basePath: /v1 | |
produces: | |
- application/json | |
paths: | |
/links: | |
get: | |
summary: Links List | |
description: 'The Links endpoint returns information about the Links matching given restrictions.' | |
parameters: | |
- name: source | |
in: query | |
description: Source (beginning of link) restriction. | |
required: false | |
type: integer | |
format: int64 | |
- name: target | |
in: query | |
description: Target (end of link) restriction. | |
required: false | |
type: integer | |
format: int64 | |
tags: | |
- Links | |
responses: | |
'200': | |
description: An array of links | |
schema: | |
type: array | |
items: | |
$ref: '#/definitions/Link' | |
default: | |
description: Unexpected error | |
schema: | |
$ref: '#/definitions/Error' | |
definitions: | |
Link: | |
type: object | |
properties: | |
id: | |
type: integer | |
format: int64 | |
description: 'Unique identifier representing a specific link matching given source & target restrictions.' | |
source: | |
type: integer | |
format: int64 | |
description: Identifier of Source (beginning) link. | |
target: | |
type: integer | |
format: int64 | |
description: Identifier of Target (end) link. | |
Error: | |
type: object | |
properties: | |
code: | |
type: integer | |
format: int32 | |
message: | |
type: string | |
fields: | |
type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment