-
-
Notifications
You must be signed in to change notification settings - Fork 104
/
mkdocs.yml
36 lines (36 loc) · 1.56 KB
/
mkdocs.yml
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
site_name: pfSense REST API Guide
nav:
- General:
- Home: index.md
- Installation & Configuration: INSTALL_AND_CONFIG.md
- Swagger & OpenAPI: SWAGGER_AND_OPENAPI.md
- Endpoint Types: ENDPOINT_TYPES.md
- Authentication & Authorization: AUTHENTICATION_AND_AUTHORIZATION.md
- Content & Accept Types: CONTENT_AND_ACCEPT_TYPES.md
- Queries & Filters: QUERIES_AND_FILTERS.md
- Working with Object IDs: WORKING_WITH_OBJECT_IDS.md
- Working with HATEOAS: WORKING_WITH_HATEOAS.md
- Common Control Parameters: COMMON_CONTROL_PARAMETERS.md
- Limitations & FAQs: LIMITATIONS_AND_FAQS.md
- API Reference: https://pfrest.org/api-docs/
- Advanced Topics:
- Introduction: ADVANCED_TOPICS_INTRO.md
- Contributing & Development: CONTRIBUTING.md
- Building Custom Authentication: BUILDING_CUSTOM_AUTH_CLASSES.md
- Building Custom Query Filters: BUILDING_CUSTOM_QUERY_FILTER_CLASSES.md
- Building Custom Models: BUILDING_CUSTOM_MODEL_CLASSES.md
- Building Custom Endpoints: BUILDING_CUSTOM_ENDPOINT_CLASSES.md
- Building Custom Validators: BUILDING_CUSTOM_VALIDATOR_CLASSES.md
- Building Custom Dispatchers: BUILDING_CUSTOM_DISPATCHER_CLASSES.md
- Building Custom Caches: BUILDING_CUSTOM_CACHE_CLASSES.md
- Building Custom Content Handlers: BUILDING_CUSTOM_CONTENT_HANDLER_CLASSES.md
- PHP Reference: https://pfrest.org/php-docs/
theme:
name: readthedocs
features:
- search
- navigation.tabs
markdown_extensions:
- admonition
- codehilite:
linenums: true