picked 0.0.101-next.2 → 0.0.101

package/docs/reference/management-api/schema/design-system.md

@@ -0,0 +1,199 @@
+---
+type: reference
+layout: docs
+generated: true
+---
+
+# Design system schema
+
+The operations and types that `design-system.graphql` adds to the Management API. See [Management API schema](/reference/management-api/schema) for every domain, the endpoint and authentication.
+
+## Queries
+
+### `designSystem`
+
+Get a design system by ID.
+
+```graphql
+designSystem(id: ID!): DesignSystem @auth
+```
+
+### `designSystems`
+
+List design systems in a project. Filter by name with `search`
+(case-insensitive substring) and order with `sortKey` (default `NAME`) plus
+`reverse`.
+
+```graphql
+designSystems(projectId: ID!, first: Int, after: String, search: String, sortKey: DesignSystemSortKeys = NAME, reverse: Boolean = false): DesignSystemConnection! @auth
+```
+
+## Mutations
+
+### `designSystemCreate`
+
+Create a new design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+designSystemCreate(input: DesignSystemCreateInput!): DesignSystemCreatePayload! @auth
+```
+
+### `designSystemUpdate`
+
+Update a design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+designSystemUpdate(input: DesignSystemUpdateInput!): DesignSystemUpdatePayload! @auth
+```
+
+### `designSystemDelete`
+
+Delete a design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`.
+
+```graphql
+designSystemDelete(input: DesignSystemDeleteInput!): DesignSystemDeletePayload! @auth
+```
+
+## Types
+
+### `DesignSystem`
+
+```graphql
+"""
+A project-level design guidance document. The markdown content lives in the
+referenced Asset; the row itself only carries the display name and the
+Asset link.
+"""
+type DesignSystem {
+  """Unique design system identifier."""
+  id: ID!
+  """Display name of the design system."""
+  name: String!
+  """The project this design system belongs to."""
+  project: Project!
+  """The markdown Asset holding the design guidance content."""
+  asset: Asset!
+  """When this design system was created."""
+  createdAt: DateTime!
+  """When this design system was last updated."""
+  updatedAt: DateTime!
+}
+```
+
+### `DesignSystemEdge`
+
+```graphql
+"""Edge type for `DesignSystemConnection`."""
+type DesignSystemEdge {
+  """Pagination cursor for this edge."""
+  cursor: String!
+  """The design system."""
+  node: DesignSystem!
+}
+```
+
+### `DesignSystemConnection`
+
+```graphql
+"""
+Relay-style connection of design systems, with both an `edges` list and a flat `nodes` accessor.
+"""
+type DesignSystemConnection {
+  """List of design system edges."""
+  edges: [DesignSystemEdge!]!
+  """
+  Flat list of design systems, equivalent to `edges[].node`. Convenience accessor.
+  """
+  nodes: [DesignSystem!]!
+  """Pagination metadata."""
+  pageInfo: PageInfo!
+  """Total number of design systems."""
+  totalCount: Int!
+}
+```
+
+### `DesignSystemSortKeys`
+
+```graphql
+"""
+Sort keys for `designSystems(...)`. Pair with `reverse: true` to flip the
+order (`NAME` and `reverse: false` sorts A to Z; `CREATED_AT` and
+`reverse: true` is newest-first).
+"""
+enum DesignSystemSortKeys {
+  """Sort by `name` (alphabetical)."""
+  NAME
+  """Sort by `createdAt`."""
+  CREATED_AT
+  """Sort by `updatedAt`."""
+  UPDATED_AT
+}
+```
+
+### `DesignSystemCreateInput`
+
+```graphql
+"""Input for `designSystemCreate`."""
+input DesignSystemCreateInput {
+  """Project ID to create the design system in."""
+  projectId: ID!
+  """Display name for the design system."""
+  name: String!
+  """Committed Asset ID holding the markdown design guidance content."""
+  assetId: ID!
+}
+```
+
+### `DesignSystemCreatePayload`
+
+```graphql
+"""Payload returned by `designSystemCreate`."""
+type DesignSystemCreatePayload {
+  """The created design system."""
+  designSystem: DesignSystem
+}
+```
+
+### `DesignSystemUpdateInput`
+
+```graphql
+"""Input for `designSystemUpdate`. Omit a field to leave it unchanged."""
+input DesignSystemUpdateInput {
+  """Design system ID."""
+  id: ID!
+  """New display name."""
+  name: String
+  """New committed Asset ID holding the markdown design guidance content."""
+  assetId: ID
+}
+```
+
+### `DesignSystemUpdatePayload`
+
+```graphql
+"""Payload returned by `designSystemUpdate`."""
+type DesignSystemUpdatePayload {
+  """The updated design system."""
+  designSystem: DesignSystem
+}
+```
+
+### `DesignSystemDeleteInput`
+
+```graphql
+"""Input for `designSystemDelete`."""
+input DesignSystemDeleteInput {
+  """Design system ID."""
+  id: ID!
+}
+```
+
+### `DesignSystemDeletePayload`
+
+```graphql
+"""Payload returned by `designSystemDelete`."""
+type DesignSystemDeletePayload {
+  """ID of the deleted design system."""
+  deletedDesignSystemId: ID
+}
+```