From 13b4d9bc98bfd58198023d8b914824fc8c24166b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tam=C3=A1s=20Szab=C3=B3?= <tamas@szaboo.com>
Date: Mon, 16 Apr 2018 20:38:57 +0200
Subject: [PATCH] add yaml to generate
---
swagger.yaml | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 73 insertions(+)
create mode 100644 swagger.yaml
diff --git a/swagger.yaml b/swagger.yaml
new file mode 100644
index 0000000..d7f89e1
--- /dev/null
+++ b/swagger.yaml
@@ -0,0 +1,73 @@
+swagger: "2.0"
+info:
+ description: "Android viewer for xkcd comics"
+ version: "1.0.0"
+ title: "XKCD Browser"
+ license:
+ name: "Creative Common"
+ url: "https://creativecommons.org"
+host: "xkcd.com"
+basePath: "/"
+tags:
+- name: "comic"
+ description: "A comic strip"
+ externalDocs:
+ description: "Find out more"
+ url: "https://xkcd.com/json.html"
+schemes:
+- "https"
+paths:
+ /{id}/info.0.json:
+ get:
+ tags:
+ - "comic"
+ summary: "Get a comic"
+ description: ""
+ operationId: "getComic"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - in: "path"
+ name: "id"
+ description: "Number of the comic"
+ required: true
+ type: "integer"
+ format: "int64"
+ responses:
+ 200:
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Comic"
+
+definitions:
+ Comic:
+ type: "object"
+ properties:
+ month:
+ type: "string"
+ num:
+ type: "integer"
+ format: "int32"
+ link:
+ type: "string"
+ year:
+ type: "string"
+ news:
+ type: "string"
+ safe_title:
+ type: "string"
+ transcript:
+ type: "string"
+ alt:
+ type: "string"
+ img:
+ type: "string"
+ title:
+ type: "string"
+ day:
+ type: "string"
+externalDocs:
+ description: "Find out more about Swagger"
+ url: "http://swagger.io"
\ No newline at end of file
--
GitLab