add tags to swagger (#8084)

* add description to swagger docs * add tags to swagger * Keep the version --------- Co-authored-by: Christian Clauss <[email protected]>
internetarchive · Jul 12, 2023 · 45b5d4a · 45b5d4a
1 parent 5812287
commit 45b5d4a
Showing 1 changed file with 78 additions and 2 deletions.
diff --git a/static/openapi.json b/static/openapi.json
@@ -1,14 +1,60 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "title": "OpenAPI",
-    "version": "0.1.0"
+    "title": "Open Library API",
+    "version": "0.1.0",
+    "description": "- These are still in development and may not be perfect\n- Contribute by proposing edits to [openapi.json](https://github.com/internetarchive/openlibrary/blob/master/static/openapi.json)\n- Please do not use our APIs for bulk downloads, see [dev center](https://openlibrary.org/developers/api)"
   },
+  "tags": [
+    {
+      "name": "books",
+      "description": "Retrieve a specific work or edition by identifier",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://openlibrary.org/dev/docs/api/books"
+      }
+    },
+    {
+      "name": "authors",
+      "description": "Retrieve an author and their works by author identifier",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://openlibrary.org/dev/docs/api/authors"
+      }
+    },
+    {
+      "name": "search",
+      "description": "Search results for books, authors, and more",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://openlibrary.org/dev/docs/api/search"
+      }
+    },
+    {
+      "name": "covers",
+      "description": "Fetch book covers by ISBN or Open Library identifier",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://openlibrary.org/dev/docs/api/covers"
+      }
+    },
+    {
+      "name": "subjects",
+      "description": "Fetch books by subject name ",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "https://openlibrary.org/dev/docs/api/subjects"
+      }
+    }
+  ],
   "paths": {
     "/api/books": {
       "get": {
         "summary": "Read Api Books",
         "operationId": "read_api_books_api_books_get",
+        "tags": [
+          "books"
+        ],
         "parameters": [
           {
             "required": true,
@@ -74,6 +120,9 @@
       "get": {
         "summary": "Read Api Volumes Brief",
         "operationId": "read_api_volumes_brief_api_volumes_brief__key_type___value__json_get",
+        "tags": [
+          "books"
+        ],
         "parameters": [
           {
             "required": true,
@@ -126,6 +175,9 @@
       "get": {
         "summary": "Read Authors",
         "operationId": "read_authors_authors__olid__json_get",
+        "tags": [
+          "authors"
+        ],
         "parameters": [
           {
             "required": true,
@@ -162,6 +214,9 @@
       "get": {
         "summary": "Read Authors Works",
         "operationId": "read_authors_works_authors__olid__works_json_get",
+        "tags": [
+          "authors"
+        ],
         "parameters": [
           {
             "required": true,
@@ -207,6 +262,9 @@
       "get": {
         "summary": "Read Books",
         "operationId": "read_books_books__olid__get",
+        "tags": [
+          "books"
+        ],
         "parameters": [
           {
             "required": true,
@@ -243,6 +301,9 @@
       "get": {
         "summary": "Read Covers Key Type Value Size Jpeg",
         "operationId": "read_covers_key_type_value_size_jpeg_covers__key_type___value___size__jpg_get",
+        "tags": [
+          "covers"
+        ],
         "parameters": [
           {
             "required": true,
@@ -295,6 +356,9 @@
       "get": {
         "summary": "Read Isbn",
         "operationId": "read_isbn_isbn__isbn__get",
+        "tags": [
+          "books"
+        ],
         "parameters": [
           {
             "required": true,
@@ -331,6 +395,9 @@
       "get": {
         "summary": "Read Search Json",
         "operationId": "read_search_json_search_json_get",
+        "tags": [
+          "search"
+        ],
         "parameters": [
           {
             "required": true,
@@ -376,6 +443,9 @@
       "get": {
         "summary": "Read Search Authors Json",
         "operationId": "read_search_authors_json_search_authors_json_get",
+        "tags": [
+          "search"
+        ],
         "parameters": [
           {
             "required": true,
@@ -412,6 +482,9 @@
       "get": {
         "summary": "Read Subjects",
         "operationId": "read_subjects_subjects__subject__json_get",
+        "tags": [
+          "subjects"
+        ],
         "parameters": [
           {
             "required": true,
@@ -458,6 +531,9 @@
       "get": {
         "summary": "Read Works",
         "operationId": "read_works_works__olid__get",
+        "tags": [
+          "books"
+        ],
         "parameters": [
           {
             "required": true,