Skip to content

Commit 5a7c2b0

Browse files
authored
Update SDK Documentation (#61)
1 parent 0b8de99 commit 5a7c2b0

File tree

3 files changed

+387
-1
lines changed

3 files changed

+387
-1
lines changed

src/reference/sdks/backend/index.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ The SDK for the Requests service.
8080
8181
The SDK for the runtime information.
8282

83+
##### scope
84+
85+
> **scope**: [`ScopeSDK`](index.md#scopesdk)
86+
87+
The SDK for the Scope service.
88+
8389
## Meta
8490

8591
### MetaSDK
@@ -1764,6 +1770,14 @@ The name of the reporter.
17641770

17651771
`string`
17661772

1773+
##### getRequestId()
1774+
1775+
The ID of the associated [Request](index.md#request-1).
1776+
1777+
###### Returns
1778+
1779+
`string`
1780+
17671781
##### getTitle()
17681782

17691783
The title of the finding.
@@ -2706,3 +2720,57 @@ Get the current version of Caido.
27062720
###### Returns
27072721

27082722
`string`
2723+
2724+
## Scope
2725+
2726+
### Scope
2727+
2728+
> **Scope**: `object`
2729+
2730+
A saved immutable Scope.
2731+
2732+
#### Type declaration
2733+
2734+
##### allowlist
2735+
2736+
> `readonly` **allowlist**: `string`[]
2737+
2738+
The allowlist of the scope.
2739+
2740+
##### denylist
2741+
2742+
> `readonly` **denylist**: `string`[]
2743+
2744+
The denylist of the scope.
2745+
2746+
##### id
2747+
2748+
> `readonly` **id**: [`ID`](index.md#id)
2749+
2750+
The unique Caido [ID](index.md#id) of the scope.
2751+
2752+
##### name
2753+
2754+
> `readonly` **name**: `string`
2755+
2756+
The name of the scope.
2757+
2758+
***
2759+
2760+
### ScopeSDK
2761+
2762+
> **ScopeSDK**: `object`
2763+
2764+
The SDK for the Scope service.
2765+
2766+
#### Type declaration
2767+
2768+
##### getAll()
2769+
2770+
Get all the scopes.
2771+
2772+
###### Returns
2773+
2774+
`Promise`\<[`Scope`](index.md#scope-1)[]\>
2775+
2776+
An array of [Scope](index.md#scope-1)

0 commit comments

Comments
 (0)