-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path_pkgdown.yml
41 lines (41 loc) · 1.59 KB
/
_pkgdown.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
37
38
39
40
41
url: https://rapid.api2r.org/
development:
mode: auto
template:
bootstrap: 5
lang: en-US
reference:
- title: rapid object
desc: The main rapid object, containing [all information about the API](https://spec.openapis.org/oas/v3.1.0#openapi-object).
contents:
- has_concept("rapid")
- title: info object
desc: The info object contains [metadata about the API](https://spec.openapis.org/oas/v3.1.0#info-object).
contents:
- has_concept("info")
- title: components object
desc: The components object contains [reusable objects for different aspects of the API](https://spec.openapis.org/oas/v3.1.0#components-object).
contents:
- class_components
- as_components
- subtitle: reference objects
contents:
- has_concept("components_reference")
- subtitle: schema objects
contents:
- has_concept("components_schema")
- subtitle: security scheme objects
contents:
- has_concept("components_security_schemes")
- title: paths object
desc: The paths object contains [available paths and operations for the API](https://spec.openapis.org/oas/v3.1.0#paths-object).
contents:
- has_concept("paths")
- title: security object
desc: The security object contains [a declaration of which security mechanisms can be used across the API](https://spec.openapis.org/oas/v3.1.0#security-requirement-object).
contents:
- has_concept("security")
- title: servers object
desc: The servers object contains [connectivity information for the API](https://spec.openapis.org/oas/v3.1.0#server-object).
contents:
- has_concept("servers")