diff --git a/swagger.yaml b/swagger.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d7f89e101357f65fb58c89c2d0fe2ae36f88d835 --- /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