make query optional if all params are optional (#1092)

* make query optional if all params are optional * update examples
openapi-ts · May 8, 2023 · c76a9ed · c76a9ed
1 parent 5a3c9f7
commit c76a9ed
Show file tree

Hide file tree

Showing 11 changed files with 1,515 additions and 1,069 deletions.
diff --git a/examples/digital-ocean-api.ts b/examples/digital-ocean-api.ts
diff --git a/examples/github-api-next.ts b/examples/github-api-next.ts
diff --git a/examples/github-api-next.yaml b/examples/github-api-next.yaml
@@ -9865,6 +9865,7 @@ paths:
           - forks
           - sources
           - member
+          default: all
       - name: sort
         description: The property to sort the results by.
         in: query
@@ -20740,6 +20741,16 @@ paths:
                     are made to respect this upon creation. Assigned by IP if not
                     provided.
                   type: string
+                geo:
+                  description: The geographic area for this codespace. If not specified,
+                    the value is assigned by IP. This property replaces `location`,
+                    which is being deprecated.
+                  type: string
+                  enum:
+                  - EuropeWest
+                  - SoutheastAsia
+                  - UsEast
+                  - UsWest
                 client_ip:
                   description: IP for location auto-detection when proxying a request
                   type: string
@@ -25214,10 +25225,6 @@ paths:
                 sha:
                   type: string
                   description: The SHA1 value for this reference.
-                key:
-                  type: string
-                  examples:
-                  - '"refs/heads/newbranch"'
               required:
               - ref
               - sha
@@ -30820,6 +30827,16 @@ paths:
                     are made to respect this upon creation. Assigned by IP if not
                     provided.
                   type: string
+                geo:
+                  description: The geographic area for this codespace. If not specified,
+                    the value is assigned by IP. This property replaces `location`,
+                    which is being deprecated.
+                  type: string
+                  enum:
+                  - EuropeWest
+                  - SoutheastAsia
+                  - UsEast
+                  - UsWest
                 client_ip:
                   description: IP for location auto-detection when proxying a request
                   type: string
@@ -30995,9 +31012,10 @@ paths:
                   - RIGHT
                 line:
                   type: integer
-                  description: The line of the blob in the pull request diff that
-                    the comment applies to. For a multi-line comment, the last line
-                    of the range that your comment applies to.
+                  description: "**Required unless using `subject_type:file`**. The
+                    line of the blob in the pull request diff that the comment applies
+                    to. For a multi-line comment, the last line of the range that
+                    your comment applies to."
                 start_line:
                   type: integer
                   description: '**Required when using multi-line comments unless using
@@ -31036,7 +31054,6 @@ paths:
               - body
               - commit_id
               - path
-              - line
             examples:
               example-for-a-multi-line-comment:
                 summary: Example for a multi-line comment
@@ -33966,6 +33983,8 @@ paths:
         Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.
 
         The array order is oldest week (index 0) to most recent week.
+
+        The most recent week is seven days ago at UTC midnight to today at UTC midnight.
       tags:
       - repos
       operationId: repos/get-participation-stats
@@ -37594,7 +37613,7 @@ paths:
     get:
       summary: Get the authenticated user
       description: |-
-        If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.
+        If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.
 
         If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.
       tags:
@@ -37935,6 +37954,16 @@ paths:
                       efforts are made to respect this upon creation. Assigned by
                       IP if not provided.
                     type: string
+                  geo:
+                    description: The geographic area for this codespace. If not specified,
+                      the value is assigned by IP. This property replaces `location`,
+                      which is being deprecated.
+                    type: string
+                    enum:
+                    - EuropeWest
+                    - SoutheastAsia
+                    - UsEast
+                    - UsWest
                   client_ip:
                     description: IP for location auto-detection when proxying a request
                     type: string
@@ -37984,6 +38013,16 @@ paths:
                       efforts are made to respect this upon creation. Assigned by
                       IP if not provided.
                     type: string
+                  geo:
+                    description: The geographic area for this codespace. If not specified,
+                      the value is assigned by IP. This property replaces `location`,
+                      which is being deprecated.
+                    type: string
+                    enum:
+                    - EuropeWest
+                    - SoutheastAsia
+                    - UsEast
+                    - UsWest
                   machine:
                     description: Machine type to use for this codespace
                     type: string
@@ -38002,7 +38041,7 @@ paths:
                 value:
                   repository_id: 1
                   ref: main
-                  location: WestUs2
+                  geo: UsWest
       responses:
         '201':
           description: Response when the codespace was successfully created