@workos/mcp-docs-server 0.1.0 → 0.2.0

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

@@ -1,212 +0,0 @@
----
-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

@@ -1,186 +0,0 @@
----
-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" />

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

@@ -1,282 +0,0 @@
----
-descriptions:
-  list_warrants:
-    data: 'Array of [Warrants](/reference/fga/warrant).'
-    resource_type: >-
-      Only return warrants whose `resource_type` matches this value. This filter
-      is required if `resource_id` or `relation` is specified.
-    resource_id: Only return warrants whose `resource_id` matches this value.
-    relation: Only return warrants whose `relation` matches this value.
-    subject_type: >-
-      Only return warrants with a subject whose `resource_type` matches this
-      value. This filter is required if `subject_id` is specified.
-    subject_id: >-
-      Only return warrants with a subject whose `resource_id` matches this
-      value.
-    subject_relation: Only return warrants with a subject whose `relation` matches this value.
-reference:
-  curl:
-    - key: list_warrants
-      id: list_warrants
-      url: /reference/fga/warrants/list
-      title: /fga/v1/warrants
-      type: GET
-      parameters:
-        - key: warrant_token
-          type: string
-          optional: true
-          description: (warrant.warrant_token_header)
-        - key: resource_type
-          type: string
-          optional: true
-          description: (list_warrants.resource_type)
-        - key: resource_id
-          type: string
-          optional: true
-          description: (list_warrants.resource_id)
-        - key: relation
-          type: string
-          optional: true
-          description: (list_warrants.relation)
-        - key: subject_type
-          type: string
-          optional: true
-          description: (list_warrants.subject_type)
-        - key: subject_id
-          type: string
-          optional: true
-          description: (list_warrants.subject_id)
-        - key: subject_relation
-          type: string
-          optional: true
-          description: (list_warrants.subject_relation)
-        - (limit)
-        - (after)
-      returns:
-        - key: data
-          type: array
-          description: (list_warrants.data)
-        - key: list_metadata
-          type: object
-          properties:
-            - (after)
-  js:
-    - key: listWarrants
-      id: list_warrants
-      url: /reference/fga/warrants/list
-      title: fga.listWarrants()
-      type: GET
-      parameters:
-        - key: options
-          type: object
-          optional: true
-          properties:
-            - key: resourceType
-              type: string
-              optional: true
-              description: (list_warrants.resource_type)
-            - key: resourceId
-              type: string
-              optional: true
-              description: (list_warrants.resource_id)
-            - key: relation
-              type: string
-              optional: true
-              description: (list_warrants.relation)
-            - key: subjectType
-              type: string
-              optional: true
-              description: (list_warrants.subject_type)
-            - key: subjectId
-              type: string
-              optional: true
-              description: (list_warrants.subject_id)
-            - key: subjectRelation
-              type: string
-              optional: true
-              description: (list_warrants.subject_relation)
-            - (limit)
-            - (after)
-        - key: requestOptions
-          type: object
-          optional: true
-          properties:
-            - key: warrantToken
-              type: string
-              optional: true
-              description: (warrant.warrant_token)
-      returns:
-        - key: anonymous
-          type: object
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Warrant[]'
-              description: (list_warrants.data)
-            - key: listMetadata
-              type: object
-              properties:
-                - (after)
-  go:
-    - key: ListWarrants
-      id: list_warrants
-      url: /reference/fga/warrants/list
-      title: fga.ListWarrants()
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.ListWarrantsOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
-              type: string
-              optional: true
-              description: (list_warrants.resource_type)
-            - key: ResourceId
-              type: string
-              optional: true
-              description: (list_warrants.resource_id)
-            - key: Relation
-              type: string
-              optional: true
-              description: (list_warrants.relation)
-            - key: SubjectType
-              type: string
-              optional: true
-              description: (list_warrants.subject_type)
-            - key: SubjectId
-              type: string
-              optional: true
-              description: (list_warrants.subject_id)
-            - key: SubjectRelation
-              type: string
-              optional: true
-              description: (list_warrants.subject_relation)
-            - key: WarrantToken
-              type: string
-              optional: true
-              description: (warrant.warrant_token)
-            - (Limit)
-            - (After)
-      returns:
-        - key: warrants
-          type: ListWarrantsResponse
-          unwrap: true
-          properties:
-            - key: Data
-              type: 'Warrant[]'
-              description: (list_warrants.data)
-            - key: ListMetadata
-              type: ListMetadata
-              properties:
-                - (After)
-        - (err)
-  java:
-    - key: listWarrants
-      id: list_warrants
-      url: /reference/fga/warrants/list
-      title: fga.listWarrants()
-      type: GET
-      parameters:
-        - key: options
-          type: ListWarrantsOptions
-          optional: true
-          unwrap: true
-          properties:
-            - key: resourceType
-              type: String
-              optional: true
-              description: (list_warrants.resource_type)
-            - key: resourceId
-              type: String
-              optional: true
-              description: (list_warrants.resource_id)
-            - key: relation
-              type: String
-              optional: true
-              description: (list_warrants.relation)
-            - key: subjectType
-              type: String
-              optional: true
-              description: (list_warrants.subject_type)
-            - key: subjectId
-              type: String
-              optional: true
-              description: (list_warrants.subject_id)
-            - key: subjectRelation
-              type: String
-              optional: true
-              description: (list_warrants.subject_relation)
-            - (limit)
-            - (after)
-        - key: requestOptions
-          type: object
-          optional: true
-          properties:
-            - key: warrantToken
-              type: String
-              optional: true
-              description: (warrant.warrant_token)
-      returns:
-        - key: anonymous
-          type: object
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Array[Warrant]'
-              description: (list_warrants.data)
-            - key: listMetadata
-              type: ListMetadata
-              properties:
-                - (after)
-  python:
-    - key: list_warrants
-      id: list_warrants
-      url: /reference/fga/warrants/list
-      title: fga.list_warrants()
-      parameters:
-        - key: resource_type
-          type: str
-          optional: true
-          description: (list_warrants.resource_type)
-        - key: resource_id
-          type: str
-          optional: true
-          description: (list_warrants.resource_id)
-        - key: relation
-          type: str
-          optional: true
-          description: (list_warrants.relation)
-        - key: subject_type
-          type: str
-          optional: true
-          description: (list_warrants.subject_type)
-        - key: subject_id
-          type: str
-          optional: true
-          description: (list_warrants.subject_id)
-        - key: subject_relation
-          type: str
-          optional: true
-          description: (list_warrants.subject_relation)
-        - (limit)
-        - (after)
-      returns:
-        - key: data
-          type: 'List[Warrant]'
-          description: (list_warrants.data)
-        - key: list_metadata
-          type: ListMetadata
-          properties:
-            - (after)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/list.mdx
----
-
-## List warrants
-
-Get a list of all your existing warrants matching the criteria specified.
-
-<CodeBlock referenceId="list_warrants">
-  <CodeBlockTab title="Request" file="list-warrants-request" />
-  <CodeBlockTab title="Response" file="list-warrants-response" />
-</CodeBlock>

package/.docs/organized/docs/reference/idempotency.mdx

@@ -1,21 +0,0 @@
----
-descriptions:
-  idempotency_key: A unique string to prevent duplicate requests.
-reference:
-  dotnet:
-    - key: idempotencyKey
-      type: string
-      optional: true
-      description: (idempotency_key)
-originalPath: .tmp-workos-clone/packages/docs/content/reference/idempotency.mdx
----
-
-# Idempotency
-
-The WorkOS API supports idempotency which guarantees that performing the same operation multiple times will have the same result as if the operation were performed only once. This is handy in situations where you may need to retry a request due to a failure or prevent accidental duplicate requests from creating more than one resource.
-
-To achieve idempotency, you can add `Idempotency-Key` request header to any WorkOS API request with a unique string as the value. Each subsequent request matching this unique string will return the same response. We suggest using [v4 UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) for idempotency keys to avoid collisions.
-
-<CodeBlock title="Idempotency Key Example" file="set-idempotency-key-example" />
-
-Idempotency keys expire after 24 hours. The WorkOS API will generate a new response if you submit a request with an expired key.