@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/fga/warrant/create.mdx

@@ -0,0 +1,215 @@
+---
+descriptions:
+  write_warrant:
+    op: >-
+      Operation to perform for the given warrant (`create`/`delete`). Defaults
+      to `create` if not provided.
+reference:
+  curl:
+    - key: create_warrant
+      id: create_warrant
+      url: /reference/fga/warrants/create
+      title: /fga/v1/warrants
+      type: POST
+      parameters:
+        - key: op
+          type: '"create"'
+          optional: true
+          description: (write_warrant.op)
+        - (warrant.resource_type)
+        - (warrant.resource_id)
+        - (warrant.relation)
+        - (warrant.subject)
+        - (warrant.policy)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: warrant_token
+              type: string
+              description: (warrant.warrant_token)
+  js:
+    - key: createWarrant
+      id: create_warrant
+      url: /reference/fga/warrants/create
+      title: fga.writeWarrant()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: op
+              type: '"create"'
+              optional: true
+              description: (write_warrant.op)
+            - key: resourceType
+              type: string
+              description: (warrant.resource_type)
+            - key: resourceId
+              type: string
+              description: (warrant.resource_id)
+            - key: relation
+              type: string
+              description: (warrant.relation)
+            - key: subject
+              type: object
+              unwrap: true
+              properties:
+                - key: resourceType
+                  type: string
+                - key: resourceId
+                  type: string
+                - key: relation
+                  type: string
+                  optional: true
+            - key: policy
+              type: string
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: string
+              description: (warrant.warrant_token)
+  go:
+    - key: CreateWarrant
+      id: create_warrant
+      url: /reference/fga/warrants/create
+      title: fga.WriteWarrant()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.WriteWarrantOpts
+          expanded: true
+          properties:
+            - key: Op
+              type: '"create"'
+              optional: true
+              description: (write_warrant.op)
+            - key: ResourceType
+              type: string
+              description: (warrant.resource_type)
+            - key: ResourceId
+              type: string
+              description: (warrant.resource_id)
+            - key: Relation
+              type: string
+              description: (warrant.relation)
+            - key: Subject
+              type: fga.Subject
+              unwrap: true
+              properties:
+                - key: ResourceType
+                  type: string
+                - key: ResourceId
+                  type: string
+                - key: Relation
+                  type: string
+                  optional: true
+            - key: Policy
+              type: string
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: fga.WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: WarrantToken
+              type: string
+              description: (warrant.warrant_token)
+  java:
+    - key: createWarrant
+      id: create_warrant
+      url: /reference/fga/warrants/create
+      title: fga.WriteWarrant()
+      parameters:
+        - key: options
+          type: CreateWarrantOptions
+          expanded: true
+          properties:
+            - key: resourceType
+              type: String
+              description: (warrant.resource_type)
+            - key: resourceId
+              type: String
+              description: (warrant.resource_id)
+            - key: relation
+              type: String
+              description: (warrant.relation)
+            - key: subject
+              type: Subject
+              unwrap: true
+              properties:
+                - key: resourceType
+                  type: String
+                - key: resourceId
+                  type: String
+                - key: relation
+                  type: String
+                  optional: true
+            - key: policy
+              type: String
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: String
+              description: (warrant.warrant_token)
+  python:
+    - key: create_warrant
+      id: create_warrant
+      url: /reference/fga/warrants/create
+      title: fga.write_warrant()
+      parameters:
+        - key: op
+          type: '"create"'
+          optional: true
+          description: (write_warrant.op)
+        - key: subject_type
+          type: str
+        - key: subject_id
+          type: str
+        - key: subject_relation
+          type: str
+          optional: true
+        - key: relation
+          type: str
+          description: (warrant.relation)
+        - key: resource_type
+          type: str
+          description: (warrant.resource_type)
+        - key: resource_id
+          type: str
+          description: (warrant.resource_id)
+        - key: policy
+          type: str
+          optional: true
+          description: (warrant.policy)
+      returns:
+        - key: response
+          type: WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrant_token
+              type: str
+              description: (warrant.warrant_token)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/create.mdx
+---
+
+## Create a warrant
+
+Creates a new warrant in the current environment.
+
+<CodeBlock referenceId="create_warrant">
+  <CodeBlockTab title="Request" file="create-warrant-request" />
+  <CodeBlockTab title="Response" file="create-warrant-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/warrant/delete.mdx

@@ -0,0 +1,212 @@
+---
+descriptions:
+  write_warrant:
+    op: >-
+      Operation to perform for the given warrant (`create`/`delete`). Defaults
+      to `create` if not provided.
+reference:
+  curl:
+    - key: delete_warrant
+      id: delete_warrant
+      url: /reference/fga/warrants/delete
+      title: /fga/v1/warrants
+      type: POST
+      parameters:
+        - key: op
+          type: '"delete"'
+          description: (write_warrant.op)
+        - (warrant.resource_type)
+        - (warrant.resource_id)
+        - (warrant.relation)
+        - (warrant.subject)
+        - (warrant.policy)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: warrant_token
+              type: string
+              description: (warrant.warrant_token)
+  js:
+    - key: deleteWarrant
+      id: delete_warrant
+      url: /reference/fga/warrants/delete
+      title: fga.writeWarrant()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: op
+              type: '"delete"'
+              description: (write_warrant.op)
+            - key: resourceType
+              type: string
+              description: (warrant.resource_type)
+            - key: resourceId
+              type: string
+              description: (warrant.resource_id)
+            - key: relation
+              type: string
+              description: (warrant.relation)
+            - key: subject
+              type: object
+              unwrap: true
+              properties:
+                - key: resourceType
+                  type: string
+                - key: resourceId
+                  type: string
+                - key: relation
+                  type: string
+                  optional: true
+            - key: policy
+              type: string
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: string
+              description: (warrant.warrant_token)
+  go:
+    - key: DeleteWarrant
+      id: delete_warrant
+      url: /reference/fga/warrants/delete
+      title: fga.WriteWarrant()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: fga.WriteWarrantOpts
+          expanded: true
+          properties:
+            - key: Op
+              type: '"delete"'
+              description: (write_warrant.op)
+            - key: ResourceType
+              type: string
+              description: (warrant.resource_type)
+            - key: ResourceId
+              type: string
+              description: (warrant.resource_id)
+            - key: Relation
+              type: string
+              description: (warrant.relation)
+            - key: Subject
+              type: fga.Subject
+              unwrap: true
+              properties:
+                - key: ResourceType
+                  type: string
+                - key: ResourceId
+                  type: string
+                - key: Relation
+                  type: string
+                  optional: true
+            - key: Policy
+              type: string
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: fga.WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: WarrantToken
+              type: string
+              description: (warrant.warrant_token)
+  java:
+    - key: deleteWarrant
+      id: delete_warrant
+      url: /reference/fga/warrants/delete
+      title: fga.WriteWarrant()
+      parameters:
+        - key: options
+          type: DeleteWarrantOptions
+          expanded: true
+          properties:
+            - key: resourceType
+              type: String
+              description: (warrant.resource_type)
+            - key: resourceId
+              type: String
+              description: (warrant.resource_id)
+            - key: relation
+              type: String
+              description: (warrant.relation)
+            - key: subject
+              type: Subject
+              unwrap: true
+              properties:
+                - key: resourceType
+                  type: String
+                - key: resourceId
+                  type: String
+                - key: relation
+                  type: String
+                  optional: true
+            - key: policy
+              type: String
+              optional: true
+              description: (warrant.policy)
+      returns:
+        - key: response
+          type: WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrantToken
+              type: String
+              description: (warrant.warrant_token)
+  python:
+    - key: delete_warrant
+      id: delete_warrant
+      url: /reference/fga/warrants/delete
+      title: fga.write_warrant()
+      parameters:
+        - key: op
+          type: '"delete"'
+          optional: true
+          description: (write_warrant.op)
+        - key: subject_type
+          type: str
+        - key: subject_id
+          type: str
+        - key: subject_relation
+          type: str
+          optional: true
+        - key: relation
+          type: str
+          description: (warrant.relation)
+        - key: resource_type
+          type: str
+          description: (warrant.resource_type)
+        - key: resource_id
+          type: str
+          description: (warrant.resource_id)
+        - key: policy
+          type: str
+          optional: true
+          description: (warrant.policy)
+      returns:
+        - key: response
+          type: WriteWarrantResponse
+          unwrap: true
+          properties:
+            - key: warrant_token
+              type: str
+              description: (warrant.warrant_token)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/delete.mdx
+---
+
+## Delete a warrant
+
+Deletes a warrant in the current environment.
+
+<CodeBlock referenceId="delete_warrant">
+  <CodeBlockTab title="Request" file="delete-warrant-request" />
+  <CodeBlockTab title="Response" file="delete-warrant-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/fga/warrant/index.mdx

@@ -0,0 +1,186 @@
+---
+descriptions:
+  warrant:
+    resource_type: >-
+      The type of resource. Must be one of your system's existing resource
+      types.
+    resource_id: The id of the specific resource.
+    relation: >-
+      The relation for this resource to subject association. The relation must
+      be valid as per the resource type definition.
+    subject: >
+      The subject for which this warrant applies. Subject can be a specific
+      resource (by id) or a set of resources matching the given resource_type,
+      resource_id and relation.
+    policy: >
+      A boolean expression that must evaluate to `true` for this warrant to
+      apply. The expression can reference variables that are provided in the
+      context attribute of access check requests.
+    warrant_token: >
+      A valid token string from a previous write operation or `latest`. This is
+      used to specify the desired consistency for this read operation.
+    warrant_token_header: >
+      A valid token string from a previous write operation or `latest`. This is
+      used to specify the desired consistency for this read operation. This
+      should be the value of the `Warrant-Token` header.
+reference:
+  curl:
+    - url: /reference/fga/warrant
+      key: warrant
+      id: warrant
+      title: warrant
+      properties:
+        - key: resource_type
+          type: string
+          description: (warrant.resource_type)
+        - key: resource_id
+          type: string
+          description: (warrant.resource_id)
+        - key: relation
+          type: string
+          description: (warrant.relation)
+        - key: subject
+          type: object
+          unwrap: true
+          properties:
+            - key: resource_type
+              type: string
+            - key: resource_id
+              type: string
+            - key: relation
+              type: string
+              optional: true
+        - key: policy
+          type: string
+          optional: true
+          description: (warrant.policy)
+  js:
+    - url: /reference/fga/warrant
+      key: warrant
+      id: warrant
+      title: Warrant
+      properties:
+        - key: resourceType
+          type: string
+          description: (warrant.resource_type)
+        - key: resourceId
+          type: string
+          description: (warrant.resource_id)
+        - key: relation
+          type: string
+          description: (warrant.relation)
+        - key: subject
+          type: object
+          unwrap: true
+          properties:
+            - key: resourceType
+              type: string
+            - key: resourceId
+              type: string
+            - key: relation
+              type: string
+              optional: true
+        - key: policy
+          type: string
+          optional: true
+          description: (warrant.policy)
+  go:
+    - url: /reference/fga/warrant
+      key: warrant
+      id: warrant
+      title: fga.Warrant
+      properties:
+        - key: ResourceType
+          type: string
+          description: (warrant.resource_type)
+        - key: ResourceId
+          type: string
+          description: (warrant.resource_id)
+        - key: Relation
+          type: string
+          description: (warrant.relation)
+        - key: Subject
+          type: fga.Subject
+          unwrap: true
+          properties:
+            - key: ResourceType
+              type: string
+            - key: ResourceId
+              type: string
+            - key: Relation
+              type: string
+              optional: true
+        - key: Policy
+          type: string
+          optional: true
+          description: (warrant.policy)
+  java:
+    - url: /reference/fga/warrant
+      key: Warrant
+      id: warrant
+      title: class Warrant
+      properties:
+        - key: resourceType
+          type: String
+          description: (warrant.resource_type)
+        - key: resourceId
+          type: String
+          description: (warrant.resource_id)
+        - key: relation
+          type: String
+          description: (warrant.relation)
+        - key: subject
+          type: fga.Subject
+          unwrap: true
+          properties:
+            - key: resourceType
+              type: String
+            - key: resourceId
+              type: String
+            - key: relation
+              type: String
+              optional: true
+        - key: policy
+          type: String
+          optional: true
+          description: (warrant.policy)
+  python:
+    - url: /reference/fga/warrant
+      key: warrant
+      id: warrant
+      title: Warrant
+      properties:
+        - key: subject
+          type: Subject
+          unwrap: true
+          properties:
+            - key: resource_type
+              type: str
+            - key: resource_id
+              type: str
+            - key: relation
+              type: str
+              optional: true
+        - key: relation
+          type: str
+          description: (warrant.relation)
+        - key: resource_type
+          type: str
+          description: (warrant.resource_type)
+        - key: resource_id
+          type: str
+          description: (warrant.resource_id)
+        - key: policy
+          type: str
+          optional: true
+          description: (warrant.policy)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/index.mdx
+---
+
+---
+
+# Warrant
+
+Represents a relation between resources in your application.
+
+<CodeBlock title="Warrant" referenceId="warrant" file="warrant" />