@shipeasy/openapi 2.1.0 → 2.3.0

package/spec/components/schemas/metrics.yaml

@@ -34,8 +34,8 @@ ListMetricsResponse:
       winsorizePct:
         description: Winsorise percentile applied to the metric.
         type: number
-      minDetectableEffect:
-        description: Configured MDE, or `null`.
+      defaultMinEffectOfInterest:
+        description: Metric-level default minimum effect of interest (relative, 0–1), or `null`.
         anyOf:
           - type: number
           - type: "null"
@@ -89,8 +89,8 @@ GetMetricResponse:
     winsorizePct:
       description: Winsorise percentile applied to the metric.
       type: number
-    minDetectableEffect:
-      description: Configured MDE, or `null`.
+    defaultMinEffectOfInterest:
+      description: Metric-level default minimum effect of interest (relative, 0–1), or `null`.
       anyOf:
         - type: number
         - type: "null"
@@ -397,9 +397,9 @@ MetricWinsorizePct:
   type: integer
   minimum: 1
   maximum: 99
-MetricMinDetectableEffect:
+MetricDefaultMinEffectOfInterest:
   default: null
-  description: Minimum detectable effect (relative, 0–1) for power planning. `null` to omit.
+  description: Default minimum effect of interest (relative, 0–1) — the smallest change in this metric worth acting on, used as the power-planning baseline. Intrinsic to the metric; an experiment overrides it per-attachment with `min_effect_of_interest` when a specific decision has a different cost/risk bar. `null` to omit.
   anyOf:
     - type: number
     - type: "null"
@@ -429,8 +429,8 @@ CreateMetricWithQuery:
       $ref: "#/MetricQueryDsl"
     winsorize_pct:
       $ref: "#/MetricWinsorizePct"
-    min_detectable_effect:
-      $ref: "#/MetricMinDetectableEffect"
+    default_min_effect_of_interest:
+      $ref: "#/MetricDefaultMinEffectOfInterest"
     direction:
       $ref: "#/MetricDirection"
   required:
@@ -452,8 +452,8 @@ CreateMetricWithQueryIr:
       $ref: "#/QueryIr"
     winsorize_pct:
       $ref: "#/MetricWinsorizePct"
-    min_detectable_effect:
-      $ref: "#/MetricMinDetectableEffect"
+    default_min_effect_of_interest:
+      $ref: "#/MetricDefaultMinEffectOfInterest"
     direction:
       $ref: "#/MetricDirection"
   required:
@@ -479,8 +479,8 @@ UpdateMetricWithQuery:
       $ref: "#/MetricQueryDsl"
     winsorize_pct:
       $ref: "#/MetricWinsorizePct"
-    min_detectable_effect:
-      $ref: "#/MetricMinDetectableEffect"
+    default_min_effect_of_interest:
+      $ref: "#/MetricDefaultMinEffectOfInterest"
     direction:
       $ref: "#/MetricDirection"
   required:
@@ -498,8 +498,8 @@ UpdateMetricWithQueryIr:
       $ref: "#/QueryIr"
     winsorize_pct:
       $ref: "#/MetricWinsorizePct"
-    min_detectable_effect:
-      $ref: "#/MetricMinDetectableEffect"
+    default_min_effect_of_interest:
+      $ref: "#/MetricDefaultMinEffectOfInterest"
     direction:
       $ref: "#/MetricDirection"
   required:
@@ -515,12 +515,12 @@ UpdateMetricFields:
       $ref: "#/MetricEventName"
     winsorize_pct:
       $ref: "#/MetricWinsorizePct"
-    min_detectable_effect:
-      $ref: "#/MetricMinDetectableEffect"
+    default_min_effect_of_interest:
+      $ref: "#/MetricDefaultMinEffectOfInterest"
     direction:
       $ref: "#/MetricDirection"
   additionalProperties: false
-  description: Update-metric variant that leaves the query untouched (metadata-only edit — folder, event, winsorisation, MDE, direction).
+  description: Update-metric variant that leaves the query untouched (metadata-only edit — folder, event, winsorisation, default minimum effect of interest, direction).
 CreateMetricResponse:
   type: object
   properties:

package/spec/components/schemas/ops.yaml

@@ -245,6 +245,11 @@ OpsErrorContext:
       items:
         type: string
       description: "Distinct, id-normalized routes this error has surfaced on (UUIDs/ids collapsed to `#`)."
+    stackTail:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: "The last 3 non-empty lines of the latest occurrence's stack — the innermost frames closest to where the throw bubbled out, baked in as an at-a-glance locator. `null` when the source supplied no stack. Fetch the full stack via `related.error`."
     sdkVersion:
       anyOf:
         - type: string
@@ -380,6 +385,11 @@ OpsAlertMetricSummary:
 OpsMeasurePlanContext:
   type: object
   properties:
+    goal:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: "The customer's underlying intent in their own words — WHAT they want to learn or achieve and WHY, independent of the specific steps. The plan below is a best-effort proposal made without repo access; when the code reveals a better path, this goal is the target you optimize for, not literal step-adherence."
     created:
       type: array
       items:
@@ -927,6 +937,97 @@ LinkPrToOpsItemResponse:
     - id
   additionalProperties: false
   description: Response for the update / link-pr endpoints.
+OpsCommentAuthorType:
+  type: string
+  enum:
+    - user
+    - system
+  description: >-
+    Who wrote a comment. `user` is a teammate (their email is in `authorEmail`);
+    `system` is Jarvis — the AI agent — which authors comments when an ops-notify
+    escalation lands on the item and when it is `@shipeasy`-mentioned in a thread.
+OpsComment:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Comment id.
+    feedbackId:
+      type: string
+      description: The queue item this comment hangs off.
+    parentId:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: The top-level comment this is a reply to, or `null` for a top-level comment.
+    authorType:
+      $ref: "#/OpsCommentAuthorType"
+    authorEmail:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: The teammate who wrote it, or `null` for a `system` (Jarvis) comment.
+    body:
+      type: string
+      description: Comment body as markdown (may contain sanitised inline image/video embeds).
+    createdAt:
+      type: string
+      description: ISO-8601 creation timestamp.
+    updatedAt:
+      type: string
+      description: ISO-8601 last-edit timestamp.
+  required:
+    - id
+    - feedbackId
+    - parentId
+    - authorType
+    - authorEmail
+    - body
+    - createdAt
+    - updatedAt
+  additionalProperties: false
+  description: A single comment on a queue item.
+ListOpsCommentsResponse:
+  type: object
+  properties:
+    comments:
+      type: array
+      items:
+        $ref: "#/OpsComment"
+  required:
+    - comments
+  additionalProperties: false
+  description: Response for `GET /api/admin/ops/{handle}/comments` — the thread, oldest first.
+CreateOpsCommentRequest:
+  type: object
+  properties:
+    body:
+      type: string
+      minLength: 1
+      maxLength: 10000
+      description: The comment body as markdown. Mentions (`@teammate`, `@shipeasy`) are parsed from it.
+    parentId:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: >-
+        Reply under this top-level comment. Omit / `null` for a top-level
+        comment. Replying to a reply attaches to the same top-level parent
+        (threading is one level deep).
+  required:
+    - body
+  additionalProperties: false
+  description: Body for `POST /api/admin/ops/{handle}/comments`.
+CreateOpsCommentResponse:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Newly created comment id.
+  required:
+    - id
+  additionalProperties: false
+  description: Response for `POST /api/admin/ops/{handle}/comments`.
 NotifyOpsRequest:
   type: object
   properties:
@@ -946,8 +1047,10 @@ NotifyOpsRequest:
       items:
         type: string
     href:
-      description: Dashboard-relative deep link to the related item.
-      type: string
+      description: Dashboard-relative deep link to the related item. `null` is accepted and treated as "no link".
+      anyOf:
+        - type: string
+        - type: "null"
     dedupeKey:
       description: Stable per-escalation key (e.g. `feedback:7`) so re-runs dedupe to one row.
       type: string

package/spec/components/schemas/projects.yaml

@@ -19,7 +19,9 @@ GetCurrentProjectResponse:
       type: string
       enum:
         - free
-        - paid
+        - pro
+        - business
+        - enterprise
       description: Billing plan tier.
     status:
       type: string
@@ -74,6 +76,50 @@ GetCurrentProjectResponse:
         - type: boolean
         - type: number
       description: Whether the feedback/ops module is enabled.
+    minSampleSize:
+      type: integer
+      description: Verdict power guard — minimum users per arm before a ship/hold verdict.
+    minRuntimeDays:
+      type: integer
+      description: Minimum days an experiment must run before a verdict (peeking guard).
+    defaultPower:
+      type: number
+      description: Target statistical power (1−β) feeding the realized-MDE calculation.
+    ciConfidence:
+      type: number
+      description: Confidence level for the interval surfaced on results.
+    defaultAllocationPct:
+      type: integer
+      description: Default traffic allocation (basis points) new experiments start with.
+    defaultHoldout:
+      type: integer
+      description: Default holdout carve-out (basis points) that seeds each new universe's holdout.
+    defaultWinsorizePct:
+      type: integer
+      description: Default winsorization percentile new metrics start with.
+    defaultMei:
+      anyOf:
+        - type: number
+        - type: "null"
+      description: Default minimum effect of interest (relative, 0–1) new metrics start with, or null.
+    cupedBaselineDays:
+      type: integer
+      description: CUPED baseline window — days of pre-experiment history, frozen at start.
+    cupedMinOverlap:
+      type: number
+      description: CUPED selection-bias guard — min share of users with a baseline, else skip.
+    cupedMinBaselineUsers:
+      type: integer
+      description: CUPED — minimum users with a baseline before it runs at all.
+    msprtTauMeiFactor:
+      type: number
+      description: mSPRT prior width — τ = minimum effect of interest × this factor.
+    msprtTauSdFactor:
+      type: number
+      description: mSPRT fallback prior width — τ = this × control SD when no MEI is set.
+    srmThreshold:
+      type: number
+      description: SRM chi-square p-value below which the run is called invalid.
     createdAt:
       type: string
       description: ISO-8601 timestamp of project creation.
@@ -218,5 +264,77 @@ UpdateProjectRequest:
     moduleEvents:
       type: boolean
       description: Enable/disable the events module.
+    minSampleSize:
+      type: integer
+      minimum: 2
+      maximum: 1000000
+      description: Verdict power guard — minimum users per arm before a ship/hold verdict.
+    minRuntimeDays:
+      type: integer
+      minimum: 0
+      maximum: 365
+      description: Minimum days an experiment must run before a verdict (peeking guard).
+    defaultPower:
+      type: number
+      minimum: 0.5
+      maximum: 0.99
+      description: Target statistical power (1−β) feeding the realized-MDE calculation.
+    ciConfidence:
+      type: number
+      minimum: 0.5
+      maximum: 0.999
+      description: Confidence level for the interval surfaced on results (any value in [0.5, 0.999], e.g. 0.90, 0.95, 0.975, 0.99).
+    defaultAllocationPct:
+      type: integer
+      minimum: 1
+      maximum: 10000
+      description: Default traffic allocation (basis points, 1000 = 10%) new experiments start with; overridable per experiment.
+    defaultHoldout:
+      type: integer
+      minimum: 0
+      maximum: 10000
+      description: Default holdout carve-out (basis points) that seeds each new universe's holdout (0 = none).
+    defaultWinsorizePct:
+      type: integer
+      minimum: 1
+      maximum: 99
+      description: Default winsorization percentile new metrics start with; overridable per metric.
+    defaultMei:
+      anyOf:
+        - type: number
+          minimum: 0
+          maximum: 1
+        - type: "null"
+      description: Default minimum effect of interest (relative, 0–1) new metrics start with; overridable per metric and per experiment. Null clears it.
+    cupedBaselineDays:
+      type: integer
+      minimum: 1
+      maximum: 365
+      description: CUPED baseline window — days of pre-experiment history, frozen at start.
+    cupedMinOverlap:
+      type: number
+      minimum: 0.01
+      maximum: 0.99
+      description: CUPED selection-bias guard — min share of users with a baseline, else skip.
+    cupedMinBaselineUsers:
+      type: integer
+      minimum: 10
+      maximum: 100000
+      description: CUPED — minimum users with a baseline before it runs at all.
+    msprtTauMeiFactor:
+      type: number
+      minimum: 0.1
+      maximum: 2
+      description: mSPRT prior width — τ = minimum effect of interest × this factor.
+    msprtTauSdFactor:
+      type: number
+      minimum: 0.05
+      maximum: 1
+      description: mSPRT fallback prior width — τ = this × control SD when no MEI is set.
+    srmThreshold:
+      type: number
+      minimum: 0.0001
+      maximum: 0.05
+      description: SRM chi-square p-value below which the run is called invalid.
   additionalProperties: false
   description: "Body for `PATCH /api/admin/projects/{id}`. Partial — every field is optional; only supplied fields change. The project id in the path must match the caller's own project."

package/spec/components/schemas/universes.yaml

@@ -1,3 +1,35 @@
+# The universe owns the config schema for every experiment/variant in it — an
+# ordered list of `{ name, type, default }`. Experiments may only override the
+# per-variant value of a declared param, never add fields (universe rework).
+UniverseParam:
+  type: object
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 128
+      pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
+      description: Param key, referenced by `groups[].params` on every experiment in the universe.
+    type:
+      type: string
+      enum:
+        - bool
+        - string
+        - int
+        - number
+      description: Scalar type of the param's value.
+    default:
+      description: "Universe-wide default. Returned when the assigned variant doesn't override this param (resolution: variant override → universe default)."
+  required:
+    - name
+    - type
+    - default
+  additionalProperties: false
+UniverseParamSchema:
+  type: array
+  items:
+    $ref: "#/UniverseParam"
+  description: The universe's ordered config schema — the single source of truth for its params.
 ListUniversesResponse:
   type: object
   properties:
@@ -14,6 +46,11 @@ ListUniversesResponse:
             maxLength: 128
             pattern: ^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$
             description: Stable universe key. Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create.
+          description:
+            anyOf:
+              - type: string
+              - type: "null"
+            description: Human-readable blurb shown in the universe picker/hovercard.
           unitType:
             type: string
             description: Unit of randomisation. Snake-case in request (`unit_type`), camelCase in response.
@@ -26,6 +63,16 @@ ListUniversesResponse:
                 maxItems: 2
               - type: "null"
             description: Reserved holdout bucket range, or `null` if none.
+          recommendedHeadroom:
+            type: integer
+            minimum: 0
+            maximum: 10000
+            description: Basis points of headroom seeded into each new experiment's reserved tail (0 = none).
+          paramSchema:
+            anyOf:
+              - $ref: "#/UniverseParamSchema"
+              - type: "null"
+            description: The universe-owned config schema, or `null` on pre-rework universes not yet seeded.
           createdAt:
             type: string
             description: ISO-8601 timestamp of creation.
@@ -54,6 +101,13 @@ CreateUniverseRequest:
       description: Stable universe key. Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create.
     folder:
       $ref: ./common.yaml#/Folder
+    description:
+      default: null
+      anyOf:
+        - type: string
+          maxLength: 2000
+        - type: "null"
+      description: Human-readable blurb shown in the universe picker/hovercard.
     unit_type:
       default: user_id
       description: Unit of randomisation. Typically `user_id`. Use `account_id` to keep whole accounts in the same group across an experiment.
@@ -70,6 +124,18 @@ CreateUniverseRequest:
           maxItems: 2
         - type: "null"
       description: Inclusive `[lo, hi]` bucket range (0–9999) reserved as the **holdout** — callers hashed into this slice are excluded from every experiment in the universe. `null` disables the holdout. Pro plan or higher required.
+    recommended_headroom:
+      default: 0
+      type: integer
+      minimum: 0
+      maximum: 10000
+      description: Basis points of reserved headroom seeded into each new experiment created in this universe (0 = none). Lets variants be appended into a running experiment without reshuffling.
+    param_schema:
+      default: null
+      anyOf:
+        - $ref: "#/UniverseParamSchema"
+        - type: "null"
+      description: The universe-owned config schema — an ordered `{ name, type, default }[]`. Experiments may only override values per variant, never add fields. `null` starts an empty schema.
   required:
     - name
   additionalProperties: false
@@ -94,6 +160,12 @@ UpdateUniverseRequest:
   properties:
     folder:
       $ref: ./common.yaml#/Folder
+    description:
+      anyOf:
+        - type: string
+          maxLength: 2000
+        - type: "null"
+      description: Human-readable blurb shown in the universe picker/hovercard.
     holdout_range:
       anyOf:
         - type: array
@@ -105,8 +177,18 @@ UpdateUniverseRequest:
           maxItems: 2
         - type: "null"
       description: Inclusive `[lo, hi]` bucket range (0–9999) reserved as the **holdout** — callers hashed into this slice are excluded from every experiment in the universe. `null` disables the holdout. Pro plan or higher required.
+    recommended_headroom:
+      type: integer
+      minimum: 0
+      maximum: 10000
+      description: Basis points of reserved headroom seeded into new experiments in this universe.
+    param_schema:
+      anyOf:
+        - $ref: "#/UniverseParamSchema"
+        - type: "null"
+      description: Replace the universe config schema. Additive changes + default edits are always allowed; removing a param a running experiment overrides is rejected (deprecate-only).
   additionalProperties: false
-  description: Body for `PATCH /api/admin/universes/{id}`. Only `holdout_range` is mutable — name and unit_type are immutable after create.
+  description: Body for `PATCH /api/admin/universes/{id}`. `name` and `unit_type` are immutable after create; `holdout_range`, `description`, `recommended_headroom` and `param_schema` are mutable.
 UpdateUniverseResponse:
   type: object
   properties:

package/spec/openapi.yaml

@@ -21,9 +21,28 @@ security:
   - bearerSdkKey: []
 tags:
   - name: Release
-    summary: Feature delivery
+    summary: >-
+      Feature delivery — flags, kill switches, dynamic configs, A/B experiments,
+      and the universes they bucket in.
     kind: nav
-    description: Flags, kill switches, dynamic configs, experiments, and the universes they bucket in — the feature-delivery surface.
+    description: |-
+      Release: the feature-delivery surface. One roof over the five resources
+      that decide which code path a user gets — feature gates (flags), kill
+      switches, dynamic configs, A/B/n experiments, and the universes that bucket
+      them — each exposed as its own subcommand group.
+
+      **Groups.**
+      - `flags` — boolean feature gates: AND-combined targeting rules + a percentage rollout (basis points), evaluated on the SDK hot path.
+      - `killswitch` (`ks`) — per-env boolean overrides for incident response; no rules, no rollout, versioned per environment.
+      - `configs` — JSON-Schema-validated structured values with a draft → publish workflow, delivered per environment.
+      - `experiments` — randomised A/B/n assignment plus the analysis pipeline (t-test, sequential testing, SRM detection); `universes` hold the shared bucketing space and holdouts the experiments draw from.
+
+      **Delivery model.** Every write rebuilds the project's KV blob and purges
+      the CDN — SDKs poll at the plan interval and never touch the database on
+      the hot path. The destructive verb is `archive` (soft-delete), never
+      `delete`.
+
+      Run `shipeasy release <group> --help` for the full contract of each group.
   - name: Flags
     parent: Release
     description: |-
@@ -161,6 +180,16 @@ tags:
       **Immutable metric.** The bound metric (and its aggregation) is fixed at create time — there is no update path for `metricId`. Tune `threshold`/`comparator`/`windowHours`/`severity`/`name`/`enabled` instead, or delete + recreate to repoint the rule at a different metric.
 
       **Delivery.** `notify` optionally targets a Slack channel and/or email for this rule; `null` falls back to the project's default notification settings. Slack targets require a connected Slack connector.
+  - name: Comments
+    parent: Ops
+    description: |-
+      Comments on a queue item — the discussion thread that hangs off any bug,
+      feature request, or auto-filed error/alert ticket. Append a comment or read
+      the thread; one level of threaded replies via `parentId`.
+
+      **Mentions.** `@teammate` in a body raises an in-app notification for that
+      person; `@shipeasy` asks Jarvis (the AI agent) to read the item and reply.
+      Comments authored by Jarvis carry `authorType: system`.
   - name: Projects
     description: |-
       Projects: the account-level container every other resource is scoped to.
@@ -285,6 +314,8 @@ paths:
     $ref: ./paths/ops.yaml#/~1api~1admin~1ops~1{handle}
   /api/admin/ops/{handle}/link-pr:
     $ref: ./paths/ops.yaml#/~1api~1admin~1ops~1{handle}~1link-pr
+  /api/admin/ops/{handle}/comments:
+    $ref: ./paths/ops.yaml#/~1api~1admin~1ops~1{handle}~1comments
   /api/admin/notifications:
     $ref: ./paths/ops.yaml#/~1api~1admin~1notifications
   /api/admin/slack/channels:
@@ -319,6 +350,8 @@ paths:
     $ref: ./paths/errors.yaml#/~1api~1admin~1errors~1{id}
   /api/admin/errors/{id}/file:
     $ref: ./paths/errors.yaml#/~1api~1admin~1errors~1{id}~1file
+  /api/admin/errors/{id}/resolve:
+    $ref: ./paths/errors.yaml#/~1api~1admin~1errors~1{id}~1resolve
   /api/admin/errors/{id}/series:
     $ref: ./paths/errors.yaml#/~1api~1admin~1errors~1{id}~1series
   /api/admin/connectors:

package/spec/paths/alert-rules.yaml

@@ -10,6 +10,7 @@
       - Alerts
     parameters:
       - $ref: ../components/parameters.yaml#/ProjectId
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List alert rules
@@ -103,6 +104,13 @@
               $ref: ../components/schemas/alert-rules.yaml#/CreateAlertRuleResponse
             example:
               id: ar_01j7w8a1b2c3d4e5f6g7h8i9j0
+        links:
+          UpdateAlertRule:
+            operationId: updateAlertRule
+            parameters: { id: $response.body#/id }
+          DeleteAlertRule:
+            operationId: deleteAlertRule
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -120,6 +128,7 @@
       - UNAUTHORIZED
       - FORBIDDEN
       - ALREADY_EXISTS
+      - METRIC_NOT_FOUND
       - REFERENCED_NOT_FOUND
       - VALIDATION
     x-cli:
@@ -146,7 +155,7 @@
         required: true
         description: Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -217,7 +226,7 @@
         required: true
         description: Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Delete an alert rule

package/spec/paths/attributes.yaml

@@ -10,6 +10,7 @@
       - Attributes
     parameters:
       - $ref: ../components/parameters.yaml#/ProjectId
+      - $ref: ../components/parameters.yaml#/Q
     responses:
       "200":
         description: List targeting attributes
@@ -76,6 +77,16 @@
             example:
               id: attr_01j7w8a1b2c3
               name: plan
+        links:
+          GetAttribute:
+            operationId: getAttribute
+            parameters: { id: $response.body#/id }
+          UpdateAttribute:
+            operationId: updateAttribute
+            parameters: { id: $response.body#/id }
+          DeleteAttribute:
+            operationId: deleteAttribute
+            parameters: { id: $response.body#/id }
       "400":
         $ref: ../components/responses.yaml#/BadRequest
       "401":
@@ -115,7 +126,7 @@
         required: true
         description: The attribute id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Get a targeting attribute
@@ -169,7 +180,7 @@
         required: true
         description: The attribute id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     requestBody:
       required: true
       content:
@@ -228,7 +239,7 @@
         required: true
         description: The attribute id.
         schema:
-          type: string
+          $ref: ../components/schemas/common.yaml#/ResourceId
     responses:
       "200":
         description: Archive a targeting attribute