@shipeasy/openapi 1.6.0 → 2.1.0

package/spec/components/schemas/projects.yaml

@@ -0,0 +1,222 @@
+GetCurrentProjectResponse:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Stable opaque project id.
+    name:
+      type: string
+      description: Project name.
+    domain:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: Project domain, or `null` if unset.
+    ownerEmail:
+      type: string
+      description: Email of the account that owns the project.
+    plan:
+      type: string
+      enum:
+        - free
+        - paid
+      description: Billing plan tier.
+    status:
+      type: string
+      enum:
+        - active
+        - inactive
+      description: Project lifecycle status.
+    subscriptionStatus:
+      type: string
+      description: Stripe subscription status (`none`, `active`, `trialing`, `past_due`, …).
+    billingInterval:
+      type: string
+      enum:
+        - monthly
+        - annual
+      description: Billing cadence.
+    currentPeriodEnd:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: ISO-8601 end of the current billing period, or `null`.
+    trialEndsAt:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: ISO-8601 trial end, or `null` if not trialing.
+    cancelAtPeriodEnd:
+      type: number
+      description: "`1` if the subscription is set to cancel at period end, else `0`."
+    moduleTranslations:
+      anyOf:
+        - type: boolean
+        - type: number
+      description: Whether the i18n/translations module is enabled.
+    moduleConfigs:
+      anyOf:
+        - type: boolean
+        - type: number
+      description: Whether the dynamic-configs module is enabled.
+    moduleGates:
+      anyOf:
+        - type: boolean
+        - type: number
+      description: Whether the feature-gates module is enabled.
+    moduleExperiments:
+      anyOf:
+        - type: boolean
+        - type: number
+      description: Whether the experiments module is enabled.
+    moduleFeedback:
+      anyOf:
+        - type: boolean
+        - type: number
+      description: Whether the feedback/ops module is enabled.
+    createdAt:
+      type: string
+      description: ISO-8601 timestamp of project creation.
+    updatedAt:
+      type: string
+      description: ISO-8601 timestamp of last update.
+  required:
+    - id
+    - name
+    - domain
+    - ownerEmail
+    - plan
+    - status
+    - subscriptionStatus
+    - billingInterval
+    - currentPeriodEnd
+    - trialEndsAt
+    - cancelAtPeriodEnd
+    - moduleTranslations
+    - moduleConfigs
+    - moduleGates
+    - moduleExperiments
+    - moduleFeedback
+    - createdAt
+    - updatedAt
+  additionalProperties: {}
+  description: The project the caller's auth header resolves to. The shape is open — additional project fields may be present.
+UpsertProjectRequest:
+  type: object
+  properties:
+    domain:
+      type: string
+      minLength: 1
+      maxLength: 2048
+      pattern: '^(\*|(\*\.)?[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)+)$'
+      description: 'Lowercase bare hostname (e.g. `acme.com`, `app.acme.com`, `*.acme.com`), or `*` to allow any origin. Full URLs with `https://` are not accepted. The project is keyed by `(owner_email, domain)`, so a second call with the same domain returns the existing project.'
+    name:
+      description: Human-readable project name. Defaults to the domain on first create.
+      type: string
+      minLength: 1
+      maxLength: 100
+  required:
+    - domain
+  additionalProperties: false
+  description: Body for `POST /api/admin/projects/upsert`. Only `domain` is required; the owner is resolved from the caller's session.
+UpsertProjectResponse:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Stable opaque project id.
+    name:
+      type: string
+      description: Project name (the supplied `name`, or the domain on first create).
+    domain:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: Project domain, or `null` if unset.
+    owner_email:
+      type: string
+      description: Email of the account that owns the project.
+    created:
+      type: boolean
+      description: "`true` if this call created the project, `false` if it returned an existing one."
+  required:
+    - id
+    - name
+    - domain
+    - owner_email
+    - created
+  additionalProperties: false
+  description: Result of `POST /api/admin/projects/upsert`.
+UpdateProjectRequest:
+  type: object
+  properties:
+    name:
+      type: string
+      minLength: 1
+      maxLength: 120
+      description: New project name.
+    domain:
+      $ref: "#/UpsertProjectRequest/properties/domain"
+    slug:
+      type: string
+      minLength: 2
+      maxLength: 48
+      pattern: ^[a-z0-9](?:[a-z0-9-]{0,46}[a-z0-9])?$
+      description: URL-safe identifier used in app URLs and SDK config. Lowercase letters, numbers, and hyphens; 2–48 chars; cannot start or end with a hyphen. The caller lowercases the raw slug before sending.
+    defaultEnv:
+      type: string
+      enum:
+        - dev
+        - staging
+        - prod
+      description: Default environment new resources are scoped to.
+    timezone:
+      type: string
+      minLength: 1
+      maxLength: 64
+      description: IANA timezone the project's daily analysis runs in.
+    statMethod:
+      type: string
+      enum:
+        - sequential
+        - fixed
+        - bayesian
+      description: Statistical method the experiment analyzer uses.
+    sigThreshold:
+      type: string
+      enum:
+        - "0.01"
+        - "0.05"
+        - "0.10"
+      description: Significance threshold (alpha) for experiment analysis.
+    autoRollback:
+      type: boolean
+      description: Whether a failing guardrail auto-rolls back the experiment.
+    minSampleDays:
+      type: integer
+      minimum: 1
+      maximum: 365
+      description: Minimum number of days an experiment must run before it can be called.
+    moduleTranslations:
+      type: boolean
+      description: Enable/disable the i18n/translations module.
+    moduleConfigs:
+      type: boolean
+      description: Enable/disable the dynamic-configs module.
+    moduleGates:
+      type: boolean
+      description: Enable/disable the feature-gates module.
+    moduleExperiments:
+      type: boolean
+      description: Enable/disable the experiments module.
+    moduleFeedback:
+      type: boolean
+      description: Enable/disable the feedback/ops module.
+    moduleUser:
+      type: boolean
+      description: Enable/disable the user-management module.
+    moduleEvents:
+      type: boolean
+      description: Enable/disable the events module.
+  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/search.yaml

@@ -0,0 +1,46 @@
+SearchResponse:
+  type: object
+  description: Flat, ranked-by-type list of search hits the command palette groups for display. Capped per resource family so one noisy type can't crowd out the rest.
+  properties:
+    hits:
+      type: array
+      items:
+        $ref: "#/SearchHit"
+  required:
+    - hits
+  additionalProperties: false
+SearchHit:
+  type: object
+  description: A single universal-search hit. Field names are camelCase; `title` is `null` when the resource has no human title/display name (members fall back to a role label).
+  properties:
+    type:
+      type: string
+      enum:
+        - member
+        - gate
+        - experiment
+        - config
+        - killswitch
+        - metric
+      description: Resource family — drives the result group + icon in the palette. (`member` hits are surfaced first.)
+    id:
+      type: string
+      description: "Stable identifier used to deep-link into the row's detail pane. For `member` hits this is the teammate's email; for everything else it is the resource id."
+    name:
+      type: string
+      description: The matched handle — the resource's immutable `name`, or the member's display name (falling back to email).
+    title:
+      anyOf:
+        - type: string
+        - type: "null"
+      description: "Human title/display name when present, else `null`. For `member` hits this carries the email (or the `Owner`/`Member` role when no profile name is set)."
+    href:
+      type: string
+      description: Project-relative href that opens the row (e.g. `/gates?open=<id>`).
+  required:
+    - type
+    - id
+    - name
+    - title
+    - href
+  additionalProperties: false

package/spec/components/schemas/universes.yaml

@@ -0,0 +1,127 @@
+ListUniversesResponse:
+  type: object
+  properties:
+    data:
+      type: array
+      items:
+        type: object
+        properties:
+          id:
+            type: string
+            description: Stable opaque universe id.
+          name:
+            type: string
+            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.
+          unitType:
+            type: string
+            description: Unit of randomisation. Snake-case in request (`unit_type`), camelCase in response.
+          holdoutRange:
+            anyOf:
+              - type: array
+                items:
+                  type: number
+                minItems: 2
+                maxItems: 2
+              - type: "null"
+            description: Reserved holdout bucket range, or `null` if none.
+          createdAt:
+            type: string
+            description: ISO-8601 timestamp of creation.
+        required:
+          - id
+          - name
+          - unitType
+          - holdoutRange
+          - createdAt
+        additionalProperties: false
+    next_cursor:
+      anyOf:
+        - type: string
+        - type: "null"
+  required:
+    - data
+    - next_cursor
+  additionalProperties: false
+CreateUniverseRequest:
+  type: object
+  properties:
+    name:
+      type: string
+      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.
+    folder:
+      $ref: ./common.yaml#/Folder
+    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.
+      type: string
+    holdout_range:
+      default: null
+      anyOf:
+        - type: array
+          items:
+            type: integer
+            minimum: 0
+            maximum: 9999
+          minItems: 2
+          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.
+  required:
+    - name
+  additionalProperties: false
+  description: Body for `POST /api/admin/universes`. Only `name` is required.
+CreateUniverseResponse:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Newly assigned universe id.
+    name:
+      type: string
+      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.
+  required:
+    - id
+    - name
+  additionalProperties: false
+UpdateUniverseRequest:
+  type: object
+  properties:
+    folder:
+      $ref: ./common.yaml#/Folder
+    holdout_range:
+      anyOf:
+        - type: array
+          items:
+            type: integer
+            minimum: 0
+            maximum: 9999
+          minItems: 2
+          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.
+  additionalProperties: false
+  description: Body for `PATCH /api/admin/universes/{id}`. Only `holdout_range` is mutable — name and unit_type are immutable after create.
+UpdateUniverseResponse:
+  type: object
+  properties:
+    id:
+      type: string
+      description: Universe id that was updated.
+  required:
+    - id
+  additionalProperties: false
+DeleteUniverseResponse:
+  type: object
+  properties:
+    ok:
+      type: boolean
+      const: true
+  required:
+    - ok
+  additionalProperties: false