Chapters

(chapters)

Overview

Available Operations

list_chapters - List chapters
get_chapter - Get chapter

list_chapters

Retrieve a paginated list of OWASP chapters.

Example Usage

from owasp_nest import Nest


with Nest(
    api_key="<YOUR_API_KEY_HERE>",
) as nest:

    res = nest.chapters.list_chapters(country="India", page=1, page_size=100)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`country`	OptionalNullable[str]	➖	Country of the chapter
`ordering`	OptionalNullable[models.ListChaptersOrdering]	➖	Ordering field
`page`	Optional[int]	➖	Page number
`page_size`	Optional[int]	➖	Number of items per page
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.PagedChapter

Errors

Error Type	Status Code	Content Type
models.NestAPIError	4XX, 5XX	/

get_chapter

Retrieve chapter details.

Example Usage

from owasp_nest import Nest


with Nest(
    api_key="<YOUR_API_KEY_HERE>",
) as nest:

    res = nest.chapters.get_chapter(chapter_id="London")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`chapter_id`	str	✔️	N/A	London
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ChapterDetail

Errors

Error Type	Status Code	Content Type
models.ChapterError	404	application/json
models.NestAPIError	4XX, 5XX	/