docs.yml

- title: Getting Started
  items:
    - title: Installation
      path: /docs/installation.html
      items:
        - title: Binaries Installation
          items:
            - title: Linux
              items:
                - title: Debian / Ubuntu
                - title: Alpine
                - title: Arch Linux / Manjaro
                - title: NixOS / Nix
            - title: macOS
              items:
                - title: Homebrew
                - title: MacPorts
            - title: FreeBSD
            - title: Windows
              items:
                - title: Zip File
                - title: Installer
                - title: Chocolatey
                - title: Scoop
                - title: Windows Package Manager
            - title: Cargo
            - title: conda-forge
            - title: Docker
            - title: npm
        - title: Building From Sources
          items:
            - title: Build on Linux
              items:
                - title: Debian based distributions
                - title: Fedora based distributions
                - title: Red Hat based distributions
                - title: Arch based distributions
                - title: Alpine based distributions
            - title: Build on macOS
            - title: Build on Windows
    - title: Manual
      path: /docs/manual.html
      items:
          - title: Name
          - title: Synopsis
          - title: Description
          - title: Hurl File Format
            items:
              - title: Capturing values
              - title: Asserts
          - title: Options
          - title: Environment
          - title: Exit Codes
          - title: WWW
          - title: See Also
    - title: Samples
      path: /docs/samples.html
      items:
        - title: Getting Data
          items:
            - title: HTTP Headers
            - title: Query Params
            - title: Basic Authentication
        - title: Sending Data
          items:
            - title: Sending HTML Form Data
            - title: Sending Multipart Form Data
            - title: Posting a JSON Body
            - title: Templating a JSON Body
            - title: Templating a XML Body
            - title: Using GraphQL Query
            - title: Using Dynamic Datas
        - title: Testing Response
          items:
            - title: Testing Response Headers
            - title: Testing REST APIs
            - title: Testing HTML Response
            - title: Testing Set-Cookie Attributes
            - title: Testing Bytes Content
            - title: SSL Certificate
            - title: Checking Full Body
            - title: Testing Redirections
        - title: Debug Tips
          items:
            - title: Verbose Mode
            - title: Error Format
            - title: Output Response Body
            - title: Export curl Commands
            - title: Using Proxy
        - title: Reports
          items:
            - title: HTML Report
            - title: JSON Report
            - title: JUnit Report
            - title: TAP Report
            - title: JSON Output
        - title: Others
          items:
            - title: HTTP Version
            - title: IP Address
            - title: Polling and Retry
            - title: Delaying Requests
            - title: Skipping Requests
            - title: Testing Endpoint Performance
            - title: Using SOAP APIs
            - title: Capturing and Using a CSRF Token
            - title: Redacting Secrets
            - title: Checking Byte Order Mark (BOM) in Response Body
            - title: AWS Signature Version 4 Requests
            - title: Using curl Options
    - title: Running Tests
      path: /docs/running-tests.html
      items:
        - title: Use --test Option
          items:
            - title: Selecting Tests
        - title: Debugging
          items:
            - title: Debug Logs
            - title: HTTP Responses
        - title: Generating Report
          items:
            - title: HTML Report
            - title: JSON Report
            - title: JUnit Report
            - title: TAP Report
        - title: Use Variables in Tests
    - title: Frequently Asked Questions
      path: /docs/frequently-asked-questions.html
      items:
        - title: General
          items:
            - title: Why "Hurl" ?
            - title: Yet Another Tool, I already use X
            - title: Hurl is build on top of libcurl, but what is added?
            - title: Why shouldn't I use Hurl?
            - title: I have a large numbers of tests, how to run just specific tests?
            - title: How can I use my Hurl files outside Hurl?
            - title: Can I do calculation within a Hurl file?
        - title: macOS
          items:
            - title: How can I use a custom libcurl (from Homebrew by instance)?
- title: File Format
  items:
    - title: Hurl File
      path: /docs/hurl-file.html
      items:
        - title: Character Encoding
        - title: File Extension
        - title: Comments
        - title: Special Characters in Strings
    - title: Entry
      path: /docs/entry.html
      items:
        - title: Definition
        - title: Example
        - title: Description
          items:
            - title: Options
            - title: Cookie storage
            - title: Redirects
            - title: Retry
            - title: Control flow
    - title: Request
      path: /docs/request.html
      items:
        - title: Definition
        - title: Example
        - title: Structure
        - title: Description
          items:
            - title: Method
            - title: URL
            - title: Headers
            - title: Options
            - title: Query parameters
            - title: Form parameters
            - title: Multipart Form Data
            - title: Cookies
            - title: Basic Authentication
            - title: Body
              items:
                - title: JSON body
                - title: XML body
                - title: GraphQL query
                - title: Multiline string body
                - title: Oneline string body
                - title: Base64 body
                - title: Hex body
                - title: File body
    - title: Response
      path: /docs/response.html
      items:
        - title: Definition
        - title: Example
        - title: Structure
        - title: Capture and Assertion
          items:
            - title: Body compression
        - title: Timings
    - title: Capturing Response
      path: /docs/capturing-response.html
      items:
        - title: Captures
          items:
            - title: Query
            - title: Status capture
            - title: Version capture
            - title: Header capture
            - title: Cookie capture
            - title: Body capture
            - title: Bytes capture
            - title: XPath capture
            - title: JSONPath capture
            - title: Regex capture
            - title: SHA-256 capture
            - title: MD5 capture
            - title: URL capture
            - title: Redirects capture
            - title: IP address capture
            - title: Variable capture
            - title: Duration capture
            - title: SSL certificate capture
        - title: Redacting Secrets
    - title: Asserting Response
      path: /docs/asserting-response.html
      items:
        - title: Asserts
          items:
            - title: Structure
        - title: Implicit asserts
          items:
            - title: Version - Status
            - title: Headers
            - title: Body
              items:
               - title: JSON body
               - title: XML body
               - title: Multiline string body
               - title: Oneline string body
               - title: Base64 body
               - title: File body
        - title: Explicit asserts
          items:
            - title: Predicates
            - title: Status assert
            - title: Version assert
            - title: Header assert
            - title: Cookie assert
            - title: Body assert
            - title: Bytes assert
            - title: XPath assert
            - title: JSONPath assert
            - title: Regex assert
            - title: SHA-256 assert
            - title: MD5 assert
            - title: URL assert
            - title: URL redirect
            - title: IP address assert
            - title: Variable assert
            - title: Duration assert
            - title: SSL certificate assert
    - title: Filters
      path: /docs/filters.html
      items:
        - title: Definition
        - title: Example
        - title: Description
          items:
            - title: base64Decode
            - title: base64Encode
            - title: base64UrlSafeDecode
            - title: base64UrlSafeEncode
            - title: count
            - title: daysAfterNow
            - title: daysBeforeNow
            - title: decode
            - title: first
            - title: format
            - title: htmlEscape
            - title: htmlUnescape
            - title: jsonpath
            - title: last
            - title: location
            - title: nth
            - title: regex
            - title: replace
            - title: replaceRegex
            - title: split
            - title: toDate
            - title: toFloat
            - title: toInt
            - title: toString
            - title: urlDecode
            - title: urlEncode
            - title: urlQueryParam
            - title: xpath
    - title: Templates
      path: /docs/templates.html
      items:
        - title: Variables
        - title: Functions
        - title: Types
        - title: Injecting Variables
          items:
            - title: variable option
            - title: variables-file option
            - title: Environment variable
            - title: Options sections
            - title: Secrets
        - title: Templating Body
    - title: Grammar
      path: /docs/grammar.html
      items:
        - title: Definitions
        - title: Syntax Grammar
          items:
            - title: General
            - title: Sections
            - title: Query
            - title: Predicates
            - title: Bytes
            - title: Strings
            - title: JSON
            - title: Template / Expression
            - title: Filter
            - title: Lexical Grammar
- title: Tutorial
  items:
    - title: Your First Hurl File
      path: /docs/tutorial/your-first-hurl-file.html
      items:
        - title: Prerequisites
        - title: A Basic Test
        - title: Recap
    - title: Adding Asserts
      path: /docs/tutorial/adding-asserts.html
      items:
        - title: HTML Body Test
        - title: HTTP Headers Test
        - title: Performance Test
        - title: Recap
    - title: Chaining Requests
      path: /docs/tutorial/chaining-requests.html
      items:
        - title: Adding Another Request
        - title: Test REST Api
        - title: Recap
    - title: Debug Tips
      path: /docs/tutorial/debug-tips.html
      items:
        - title: Verbose Mode
          items:
            - title: Using --verbose and --very-verbose for all entries
            - title: Debugging a specific entry
        - title: Use Error Format
        - title: Get Response Body
        - title: Include Headers Like curl
        - title: Export curl Commands
        - title: Using a Proxy
    - title: Captures
      path: /docs/tutorial/captures.html
      items:
        - title: Capturing a CSRF Token
        - title: Follow Redirections
        - title: Recap
    - title: Security
      path: /docs/tutorial/security.html
      items:
        - title: Server Side Validation
          items:
            - title: Valid user creation
            - title: Invalid user creation
        - title: Comments
        - title: Recap
    - title: CI/CD Integration
      path: /docs/tutorial/ci-cd-integration.html
      items:
        - title: Templating Tests
        - title: Integration Script
        - title: Running Tests with GitHub Action
        - title: Running Tests with GitLab CI/CD
        - title: Tests Report
        - title: Recap
- title: Resources
  items:
    - title: License
      path: /docs/license.html
    - title: Blog
      path: /blog/
    - title: GitHub
      url: https://github.com/Orange-OpenSource/hurl