Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 4.32 KB

README.md

File metadata and controls

88 lines (55 loc) · 4.32 KB

Client.Governance.Documents.Visibilityoverrides

Overview

Available Operations

  • list - Fetches documents visibility
  • create - Hide or unhide docs

list

Fetches the visibility override status of the documents passed.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as glean:

    res = glean.client.governance.documents.visibilityoverrides.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
doc_ids List[str] ➖ List of doc-ids which will have their hide status fetched.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetDocumentVisibilityOverridesResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*

create

Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as glean:

    res = glean.client.governance.documents.visibilityoverrides.create()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
visibility_overrides List[models.DocumentVisibilityOverride] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdateDocumentVisibilityOverridesResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*