Add more pages to doc

swagger-api · declark · May 31, 2024 · Mar 29, 2024 · Apr 3, 2024 · Apr 4, 2024
commit 3cdea01f4937c756d594277e8928b09e4917f5b3
diff --git a/...ontent/docs/specification/2.0/api-keys.md → ...cification/2.0/Authentication/api-keys.md b/...ontent/docs/specification/2.0/api-keys.md → ...cification/2.0/Authentication/api-keys.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: API Keys
+sidebar:
+  order: 2
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/authentication/api-keys/).

diff --git a/.../docs/specification/2.0/authentication.md → ...tion/2.0/Authentication/authentication.md b/.../docs/specification/2.0/authentication.md → ...tion/2.0/Authentication/authentication.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Authentication
+sidebar:
+  order: 1
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/authentication).

diff --git a/...specification/2.0/basic-authentication.md → ....0/Authentication/basic-authentication.md b/...specification/2.0/basic-authentication.md → ....0/Authentication/basic-authentication.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Basic Authentication
+sidebar:
+  order: 3
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger).  

diff --git a/src/content/docs/specification/2.0/adding-examples.md b/src/content/docs/specification/2.0/adding-examples.md
@@ -1,5 +1,7 @@
 ---
-title: Adding examples
+title: Adding Examples
+sidebar:
+  order: 10
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger).  

diff --git a/src/content/docs/specification/2.0/api-host-and-base-path.md b/src/content/docs/specification/2.0/api-host-and-base-path.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: API Host and Base Path
+sidebar:
+  order: 3
 ---
 
 code { font-size: 14px !important; }

diff --git a/src/content/docs/specification/2.0/basic-structure.md b/src/content/docs/specification/2.0/basic-structure.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Basic Structure
+sidebar:
+  order: 2
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/basic-structure).

diff --git a/src/content/docs/specification/2.0/describing-parameters.md b/src/content/docs/specification/2.0/describing-parameters.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Describing Parameters
+sidebar:
+  order: 6
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/describing-parameters).

diff --git a/src/content/docs/specification/2.0/describing-request-body.md b/src/content/docs/specification/2.0/describing-request-body.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Describing Request Body
+sidebar:
+  order: 7
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/describing-request-body).

diff --git a/src/content/docs/specification/2.0/describing-responses.md b/src/content/docs/specification/2.0/describing-responses.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Describing Responses
+sidebar:
+  order: 9
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/describing-responses).

diff --git a/src/content/docs/specification/2.0/enums.md b/src/content/docs/specification/2.0/enums.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Enums
+sidebar:
+  order: 11
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/data-models/enums/).

diff --git a/src/content/docs/specification/2.0/file-upload.md b/src/content/docs/specification/2.0/file-upload.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: File Upload
+sidebar:
+  order: 8
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/describing-request-body/file-upload/).

diff --git a/src/content/docs/specification/2.0/grouping-operations-with-tags.md b/src/content/docs/specification/2.0/grouping-operations-with-tags.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Grouping Operations With Tags
+sidebar:
+  order: 12
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/grouping-operations-with-tags).

diff --git a/src/content/docs/specification/2.0/mime-types.md b/src/content/docs/specification/2.0/mime-types.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: MIME Types
+sidebar:
+  order: 4
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/media-types).

diff --git a/src/content/docs/specification/2.0/paths-and-operations.md b/src/content/docs/specification/2.0/paths-and-operations.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Paths and Operations
+sidebar:
+  order: 5
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger). To learn about the latest version, visit [OpenAPI 3 pages](/docs/specification/paths-and-operations/).

diff --git a/src/content/docs/specification/2.0/swagger-extensions.md b/src/content/docs/specification/2.0/swagger-extensions.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: Swagger Extensions
+sidebar:
+  order: 13
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger).  

diff --git a/src/content/docs/specification/2.0/what-is-swagger.md b/src/content/docs/specification/2.0/what-is-swagger.md
@@ -1,5 +1,7 @@
 ---
-title: API Server and Base Path
+title: What is Swagger
+sidebar:
+  order: 1
 ---
 
 OAS **2** This page applies to OpenAPI Specification ver. 2 (fka Swagger).  

diff --git a/src/content/docs/specification/Authentication/basic-authentication.md b/src/content/docs/specification/Authentication/basic-authentication.md
@@ -10,7 +10,9 @@ OAS **3** This guide is for OpenAPI 3.0. If you use OpenAPI 2.0, see our [OpenA
 
 [Basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the `Authorization` header that contains the word `Basic` word followed by a space and a base64-encoded string `username:password`. For example, to authorize as `demo / p@55w0rd` the client would send
 
-    Authorization: Basic ZGVtbzpwQDU1dzByZA==
+```yaml
+Authorization: Basic ZGVtbzpwQDU1dzByZA==
+```
 
 **Note:** Because base64 is easily decoded, Basic authentication should only be used together with other security mechanisms such as HTTPS/SSL.