Skip to content

README.md

Latest commit

 

History

History
95 lines (62 loc) · 6.95 KB

README.md

File metadata and controls

95 lines (62 loc) · 6.95 KB

Chapters

Overview

Available Operations

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
latitude_gte OptionalNullable[float] ➖ Latitude greater than or equal to
latitude_lte OptionalNullable[float] ➖ Latitude less than or equal to
longitude_gte OptionalNullable[float] ➖ Longitude greater than or equal to
longitude_lte OptionalNullable[float] ➖ Longitude less than or equal to
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.ValidationErrorSchema 400 application/json
models.ChapterError 404 application/json
models.NestAPIError 4XX, 5XX */*