sequrity-api/mkdocs.yml at main · sequrity-ai/sequrity-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
site_name: Sequrity
site_url: https://sequrity-ai.github.io/sequrity-api/
site_description: A Python client for Sequrity
repo_url: https://github.com/sequrity-ai/sequrity-api
repo_name: sequrity-ai/sequrity-api

theme:
  name: material
  icon:
    logo: material/lock-outline
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - search.highlight
    - content.code.copy
    - content.footnote.tooltips
    - toc.follow

plugins:
  - search
  - autorefs:
      resolve_closest: true
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - url: https://docs.python-requests.org/en/master/objects.inv
              domains: [std, py]
          options:
            # Existing settings
            docstring_style: google
            show_source: true
            members_order: source
            extensions:
              - griffe_pydantic:
                  schema: true

            # DOCSTRINGS
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list

            # CROSS-REFERENCES
            signature_crossrefs: true
            unwrap_annotated: true

            # MEMBERS
            inherited_members: true
            summary: true

            # HEADINGS
            heading_level: 1
            parameter_headings: true
            type_parameter_headings: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true

            # SIGNATURES
            line_length: 88
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            show_signature_type_parameters: true

            # OTHER
            show_bases: false
  - tags

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

  - pymdownx.inlinehilite
  - pymdownx.snippets
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - footnotes
  - pymdownx.critic
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

extra_css:
  - stylesheets/custom.css

extra:
  version:
    provider: mike
    default: dev

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Control:
          - Sending your first message: control/getting_started/first_message.md
          - Secure Tool Use with Dual-LLM: control/getting_started/tool_use_dual_llm.md
          - Custom Headers: control/getting_started/custom_headers.md
          - Compile and Execute LangGraph: control/getting_started/langgraph.md
  - Learn:
      - Control:
          - control/learn/index.md
          - "Single vs. Dual-LLM": control/learn/single-vs-dual-llm.md
          - "Session ID and Multi-turn Sessions": control/learn/session_id.md
          - "Policy Language: SQRT":
              - control/learn/sqrt/index.md
              - 00-Metadata: control/learn/sqrt/00_metadata.md
              - 01-Basic Types: control/learn/sqrt/01_basic_types.md
              - 02-Set Operations: control/learn/sqrt/02_set_operations.md
              - 03-Predicates: control/learn/sqrt/03_predicates.md
              - 04-Tool Policies: control/learn/sqrt/04_tool_policies.md
  - Reference:
      - SequrityClient: general/sequrity_client/sequrity_client.md
      - Control:
          - control/reference/index.md
          - Features in Single-LLM Arch: control/reference/single_llm_vs_dual_llm_features.md
          - How Session Config Is Built: control/reference/bearer-token-only-vs-headers-mode.md
          - SQRT Policy Language:
              - control/reference/sqrt/index.md
              - Grammar: control/reference/sqrt/grammar.md
          - REST API:
              - control/reference/rest_api/index.md
              - Service Providers: general/rest_api/service_provider.md
              - Chat Completions API: control/reference/rest_api/chat_completion.md
              - Responses API: control/reference/rest_api/responses.md
              - Messages API: control/reference/rest_api/messages.md
              - Custom Headers:
                  - control/reference/rest_api/headers/index.md
                  - X-Api-Key and X-Session-ID: control/reference/rest_api/headers/api_key_session_id.md
                  - X-Features: control/reference/rest_api/headers/security_features.md
                  - X-Policy: control/reference/rest_api/headers/security_policy.md
                  - X-Config: control/reference/rest_api/headers/security_config.md
          - SequrityClient:
              - SequrityClient.control:
                  - control/reference/sequrity_client/index.md
                  - Chat Completions API: control/reference/sequrity_client/chat_completion.md
                  - Responses API: control/reference/sequrity_client/responses.md
                  - Messages API: control/reference/sequrity_client/message.md
                  - LangGraph: control/reference/sequrity_client/langgraph.md
                  - Policy Generation: control/reference/sequrity_client/policy_gen.md
                  - Headers:
                      - FeaturesHeader: control/reference/sequrity_client/headers/features_header.md
                      - PolicyHeader: control/reference/sequrity_client/headers/policy_header.md
                      - ConfigHeader: control/reference/sequrity_client/headers/config_header.md
                  - ValueWithMeta: control/reference/sequrity_client/value_with_meta.md
                  - SQRT: control/reference/sequrity_client/sqrt.md
              - Integrations:
                  - control/reference/sequrity_client/integrations/index.md
                  - OpenAI Agents SDK: control/reference/sequrity_client/integrations/integrations_oai_sdk.md
                  - LangGraph: control/reference/sequrity_client/integrations/integrations_langgraph.md
              - service_provider: general/sequrity_client/service_provider.md
  - Examples:
      - Control:
          - control/examples/index.md
          - Advanced SQRT Examples: control/examples/advanced_sqrt_examples_2026-01-25.md
          - OpenAI Agents SDK Integration: control/examples/openai_sdk_integration.md
          - LangGraph Integration: control/examples/langgraph_integration.md
  - Release Notes: release_notes.md