@redotech/redo-api-schema 2.2.43 → 2.2.45

package/lib/openapi.d.ts

@@ -18,7 +18,7 @@ export interface paths {
     get: operations["Return get"];
     parameters: {
       path: {
-        storeId: components["parameters"]["store-id.param"];
+        returnId: components["parameters"]["return-id.param"];
       };
     };
   };
@@ -123,7 +123,7 @@ export interface paths {
 
 export interface webhooks {
   "return": {
-    /** Return event [Webhook] */
+    /** Return event */
     post: operations["Webhook return event"];
   };
 }
@@ -186,20 +186,27 @@ export interface components {
     }]>;
     /**
      * Problem details
-     * @description See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
+     * @description Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
      */
     "error.schema": {
-      /** @description A human-readable explanation specific to this occurrence of the problem. */
+      /**
+       * Detail
+       * @description Human-readable description of the problem.
+       */
       detail?: string;
-      /** @description A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced. */
+      /**
+       * Format: uri-reference
+       * @description A URI reference that identifies this problem.
+       */
       instance?: string;
-      /** @description The HTTP status code ([[RFC7231], Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) generated by the origin server for this occurrence of the problem. */
-      status?: number;
-      /** @description A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [[RFC7231], Section 3.4](https://datatracker.ietf.org/doc/html/rfc7231#section-3.4)). */
+      /**
+       * Title
+       * @description Human-readable summary of the problem type.
+       */
       title?: string;
       /**
        * Format: uri-reference
-       * @description A URI reference [[RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [[W3C.REC-html5-20141028](https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028)]).  When this member is not present, its value is assumed to be "about:blank".
+       * @description A URI reference that identifies the problem type.
        * @default about:blank
        */
       type?: string;
@@ -718,7 +725,7 @@ export interface operations {
   "Return get": {
     parameters: {
       path: {
-        storeId: components["parameters"]["store-id.param"];
+        returnId: components["parameters"]["return-id.param"];
       };
     };
     responses: {
@@ -1062,16 +1069,9 @@ export interface operations {
       };
     };
   };
-  /** Return event [Webhook] */
+  /** Return event */
   "Webhook return event": {
-    /**
-     * @description Return event webhook.
-     *
-     * <!-- theme: warning -->
-     * > #### Note
-     * >
-     * > This is not an actual Redo API endpoint, but a webhook.
-     */
+    /** @description Return event webhook. */
     requestBody: {
       content: {
         "application/json": {

package/lib/openapi.yaml

@@ -133,23 +133,23 @@ components:
           type: object
       title: Comment
     error.schema:
-      description: See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
+      description: Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
       properties:
         detail:
-          description: A human-readable explanation specific to this occurrence of the problem.
+          description: Human-readable description of the problem.
+          title: Detail
           type: string
         instance:
-          description: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.
+          description: A URI reference that identifies this problem.
+          format: uri-reference
           type: string
-        status:
-          description: The HTTP status code ([[RFC7231], Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) generated by the origin server for this occurrence of the problem.
-          type: number
         title:
-          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [[RFC7231], Section 3.4](https://datatracker.ietf.org/doc/html/rfc7231#section-3.4)).
+          description: Human-readable summary of the problem type.
+          title: Title
           type: string
         type:
           default: about:blank
-          description: A URI reference [[RFC3986](https://datatracker.ietf.org/doc/html/rfc3986)] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [[W3C.REC-html5-20141028](https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028)]).  When this member is not present, its value is assumed to be "about:blank".
+          description: A URI reference that identifies the problem type.
           format: uri-reference
           type: string
       title: Problem details
@@ -794,7 +794,7 @@ paths:
       tags:
         - Returns
     parameters:
-      - $ref: '#/components/parameters/store-id.param'
+      - $ref: '#/components/parameters/return-id.param'
     summary: Return
   /returns/{returnId}/comments:
     description: Return comment.
@@ -1166,11 +1166,6 @@ webhooks:
               type: object
         description: |
           Return event webhook.
-
-          <!-- theme: warning -->
-          > #### Note
-          >
-          > This is not an actual Redo API endpoint, but a webhook.
         required: true
       responses:
         2xx:
@@ -1179,7 +1174,7 @@ webhooks:
           description: Error. The event will be retried multiple times and then discarded.
       security:
         - UserBearer: []
-      summary: Return event [Webhook]
+      summary: Return event
       tags:
         - Returns
-    summary: Return event [Webhook]
+    summary: Return event

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.43"
+  "version": "2.2.45"
 }