@shipeasy/openapi 2.1.0 → 2.2.0

package/spec/paths/experiments.yaml

@@ -12,6 +12,13 @@
       - $ref: ../components/parameters.yaml#/ProjectId
       - $ref: ../components/parameters.yaml#/PaginationLimit
       - $ref: ../components/parameters.yaml#/PaginationCursor
+      - name: status
+        in: query
+        required: false
+        description: Filter by lifecycle status. Pass `archived` to return the archive tab; any other value (or omitting it) returns the non-archived experiments.
+        schema:
+          type: string
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List experiments
@@ -159,6 +166,25 @@
             example:
               id: exp_01j7wb12c3d4e5f6g7h8j9k0l1
               name: checkout_button_color
+        links:
+          GetExperiment:
+            operationId: getExperiment
+            parameters: { id: $response.body#/id }
+          UpdateExperiment:
+            operationId: updateExperiment
+            parameters: { id: $response.body#/id }
+          SetExperimentMetrics:
+            operationId: setExperimentMetrics
+            parameters: { id: $response.body#/id }
+          SetExperimentStatus:
+            operationId: setExperimentStatus
+            parameters: { id: $response.body#/id }
+          ReanalyzeExperiment:
+            operationId: reanalyzeExperiment
+            parameters: { id: $response.body#/id }
+          DeleteExperiment:
+            operationId: deleteExperiment
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -201,7 +227,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get one experiment
@@ -281,7 +307,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -366,7 +392,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete an experiment
@@ -427,7 +453,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -456,7 +482,7 @@
               value:
                 status: draft
     responses:
-      "201":
+      "200":
         description: Transition experiment status
         content:
           application/json:
@@ -522,7 +548,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -545,7 +571,7 @@
               value:
                 metrics: []
     responses:
-      "201":
+      "200":
         description: Attach metrics
         content:
           application/json:
@@ -599,7 +625,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get analysis results
@@ -668,7 +694,7 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
       - name: metric
         in: query
         required: false
@@ -742,9 +768,9 @@
         required: true
         description: Stable opaque experiment id (`exp_…`) or the experiment's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
-      "201":
+      "200":
         description: Re-queue analysis
         content:
           application/json:

package/spec/paths/gate-templates.yaml

@@ -5,17 +5,19 @@
     description: |-
       Returns the merged targeting-rule template catalog — read-only **built-ins first** (the `@team`/`@owner` audience aliases, country, email-domain, region presets, …), then this project's **customer** templates. Each item carries a `rules: [{ attr, op, value }]` definition; the alias templates carry a symbol value (`email in ["@team"]`) that the SDK expands to the resolved email list at rebuild.
 
-      **Turn "launch X in country Y" into a gated flag:** list templates (optionally with `query`), take the matching template's `rules`, substitute the concrete value(s), and pass them as the `rules` arg of `release_flags_create`.
+      **Turn "launch X in country Y" into a gated flag:** list templates (optionally with `q`), take the matching template's `rules`, substitute the concrete value(s), and pass them as the `rules` arg of `release_flags_create`.
 
       The catalog is small and bounded, so the full merged set is returned in one page — this endpoint is **not** paginated (`next_cursor` is always `null`; there are no `limit`/`cursor` params).
     tags:
       - Templates
     parameters:
       - $ref: ../components/parameters.yaml#/ProjectId
+      - $ref: ../components/parameters.yaml#/Q
       - name: query
         in: query
         required: false
-        description: Case-insensitive substring filter over each template's `name` + `description`. Omit to return the whole catalog.
+        deprecated: true
+        description: Deprecated alias for `q`, kept working for one release. Prefer `q`.
         schema:
           type: string
     responses:
@@ -128,7 +130,7 @@
         required: true
         description: Built-in slug (`country`) or customer template id (`gtpl_…`).
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get one gate template
@@ -167,7 +169,7 @@
         required: true
         description: Customer template id (`gtpl_…`) or its `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -231,7 +233,7 @@
         required: true
         description: Customer template id (`gtpl_…`) or its `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete a gate template
@@ -251,6 +253,8 @@
         $ref: ../components/responses.yaml#/NotFound
       "409":
         $ref: ../components/responses.yaml#/Conflict
+      "422":
+        $ref: ../components/responses.yaml#/UnprocessableEntity
     x-error-codes:
       - BAD_REQUEST
       - UNAUTHORIZED

package/spec/paths/gates.yaml

@@ -12,6 +12,7 @@
       - $ref: ../components/parameters.yaml#/ProjectId
       - $ref: ../components/parameters.yaml#/PaginationLimit
       - $ref: ../components/parameters.yaml#/PaginationCursor
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List feature gates
@@ -163,6 +164,19 @@
             example:
               id: gat_01j7w7m9q4hxbf6npe6s9zr3vc
               name: checkout_v2
+        links:
+          UpdateGate:
+            operationId: updateGate
+            parameters: { id: $response.body#/id }
+          EnableGate:
+            operationId: enableGate
+            parameters: { id: $response.body#/id }
+          DisableGate:
+            operationId: disableGate
+            parameters: { id: $response.body#/id }
+          DeleteGate:
+            operationId: deleteGate
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -211,7 +225,7 @@
         required: true
         description: Stable opaque gate id (`gat_…`) or the gate's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -317,7 +331,7 @@
         required: true
         description: Stable opaque gate id (`gat_…`) or the gate's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete a feature gate
@@ -366,9 +380,9 @@
         required: true
         description: Stable opaque gate id (`gat_…`) or the gate's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
-      "201":
+      "200":
         description: Enable a gate
         content:
           application/json:
@@ -416,9 +430,9 @@
         required: true
         description: Stable opaque gate id (`gat_…`) or the gate's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
-      "201":
+      "200":
         description: Disable a gate
         content:
           application/json:

package/spec/paths/i18n.yaml

@@ -73,6 +73,10 @@
             example:
               id: i18n_01j7w8a1b2c4
               name: fr:prod
+        links:
+          PublishI18nProfile:
+            operationId: publishI18nProfile
+            parameters: { profileId: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -120,9 +124,10 @@
       - name: q
         in: query
         required: false
-        description: Free-text search — matches keys whose name OR value contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy.
+        description: Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy.
         schema:
           type: string
+          maxLength: 100
       - name: limit
         in: query
         required: false
@@ -131,6 +136,14 @@
           type: integer
           minimum: 1
           maximum: 500
+      - name: offset
+        in: query
+        required: false
+        description: Number of keys to skip before returning `limit` rows (offset pagination).
+        schema:
+          type: integer
+          minimum: 0
+          default: 0
     responses:
       "200":
         description: List i18n keys
@@ -235,7 +248,7 @@
         required: true
         description: The key's id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -383,7 +396,7 @@
         required: true
         description: The draft id to update.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -441,7 +454,7 @@
         required: true
         description: The profile id to publish.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -451,7 +464,7 @@
           example:
             chunk: default
     responses:
-      "201":
+      "200":
         description: Publish a profile chunk
         content:
           application/json:

package/spec/paths/keys.yaml

@@ -14,6 +14,7 @@
       - $ref: ../components/parameters.yaml#/ProjectId
       - $ref: ../components/parameters.yaml#/PaginationLimit
       - $ref: ../components/parameters.yaml#/PaginationCursor
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List API keys
@@ -148,7 +149,7 @@
         required: true
         description: Stable opaque key id (UUID) returned by `create` / `list`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Revoke an API key

package/spec/paths/killswitches.yaml

@@ -12,6 +12,7 @@
       - $ref: ../components/parameters.yaml#/ProjectId
       - $ref: ../components/parameters.yaml#/PaginationLimit
       - $ref: ../components/parameters.yaml#/PaginationCursor
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List killswitches
@@ -114,6 +115,22 @@
             example:
               id: ksw_01j7w9d8h2k4m6n8p0q2r4s6t8
               name: payments.checkout
+        links:
+          GetKillswitch:
+            operationId: getKillswitch
+            parameters: { id: $response.body#/id }
+          UpdateKillswitch:
+            operationId: updateKillswitch
+            parameters: { id: $response.body#/id }
+          SetKillswitchSwitch:
+            operationId: setKillswitchSwitch
+            parameters: { id: $response.body#/id }
+          SetKillswitchValue:
+            operationId: setKillswitchValue
+            parameters: { id: $response.body#/id }
+          DeleteKillswitch:
+            operationId: deleteKillswitch
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -153,7 +170,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get one killswitch
@@ -225,7 +242,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -302,7 +319,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete a killswitch
@@ -355,7 +372,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -429,7 +446,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -498,7 +515,7 @@
         required: true
         description: Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:

package/spec/paths/metrics.yaml

@@ -10,6 +10,7 @@
       - Metrics
     parameters:
       - $ref: ../components/parameters.yaml#/ProjectId
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List metrics
@@ -110,6 +111,16 @@
             example:
               id: met_01j7w8a1b2c3d4e5f6g7h8i9j0
               name: checkouts
+        links:
+          GetMetric:
+            operationId: getMetric
+            parameters: { id: $response.body#/id }
+          UpdateMetric:
+            operationId: updateMetric
+            parameters: { id: $response.body#/id }
+          DeleteMetric:
+            operationId: deleteMetric
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -151,7 +162,7 @@
         required: true
         description: Stable opaque metric id (`met_…`) or the metric's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get a metric
@@ -209,7 +220,7 @@
         required: true
         description: Stable opaque metric id (`met_…`) or the metric's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -268,7 +279,7 @@
         required: true
         description: Stable opaque metric id (`met_…`) or the metric's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Archive a metric

package/spec/paths/ops.yaml

@@ -176,7 +176,7 @@
         required: true
         description: Per-project item number (e.g. `7`) or the full ops item id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get one queue item
@@ -235,7 +235,7 @@
         required: true
         description: Per-project item number (e.g. `7`) or the full ops item id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -303,7 +303,7 @@
         required: true
         description: Per-project item number (e.g. `7`) or the full ops item id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:

package/spec/paths/projects.yaml

@@ -144,7 +144,7 @@
         required: true
         description: Stable opaque project id. Must match the caller's own project.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:

package/spec/paths/universes.yaml

@@ -12,6 +12,7 @@
       - $ref: ../components/parameters.yaml#/ProjectId
       - $ref: ../components/parameters.yaml#/PaginationLimit
       - $ref: ../components/parameters.yaml#/PaginationCursor
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List universes
@@ -100,6 +101,13 @@
             example:
               id: uni_01j7w8a1b2c3d4e5f6g7h8i9j0
               name: primary_users
+        links:
+          UpdateUniverse:
+            operationId: updateUniverse
+            parameters: { id: $response.body#/id }
+          DeleteUniverse:
+            operationId: deleteUniverse
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -145,7 +153,7 @@
         required: true
         description: Stable opaque universe id (`uni_…`) or the universe's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -213,7 +221,7 @@
         required: true
         description: Stable opaque universe id (`uni_…`) or the universe's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete a universe