search

OWASP / wstg

The Web Security Testing Guide is a comprehensive Open Source guide to testing the security of web applications and web services.
https://owasp.org/www-project-web-security-testing-guide/
Creative Commons Attribution Share Alike 4.0 International
7.19k stars 1.32k forks source link

Add API overview #1140

Closed garthoid closed 4 months ago

garthoid commented 4 months ago

This PR is one installment of several attempting to resolve issue #5.

What did this PR accomplish?

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:9:329 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:27 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:28:47 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.'] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:86:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:87:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:88:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:105:100 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:105:107 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:107 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 9:148 ✖ Incorrect usage of the term: “Internet”, use “internet” instead terminology 32:162 ✖ Incorrect usage of the term: “Internet”, use “internet” instead terminology 52:164 ✖ Incorrect usage of the term: “https”, use “HTTPS” instead terminology

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:5:329 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:7:196 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:9:199 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:11:203 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:23 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:24:47 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.'] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:27:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:28:300 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:82:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:83:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:84:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:88:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:102:100 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:102:107 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 5:148 ✖ Incorrect usage of the term: “Internet”, use “internet” instead terminology 28:162 ✖ Incorrect usage of the term: “Internet”, use “internet” instead terminology 48:164 ✖ Incorrect usage of the term: “https”, use “HTTPS” instead terminology

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:5:329 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:7:196 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:9:199 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:11:203 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:23 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:24:47 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.'] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:27:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:28:300 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:82:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:83:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:84:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:88:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:102:100 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 8] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:102:107 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe]

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:23 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:24:47 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.'] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:27:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:28:300 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:82:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:83:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:84:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:88:115 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:23:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:23 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:24:47 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:82:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:82:83 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:83:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:83:73 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:84:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:84:74 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following mistakes were identified:

/home/runner/work/wstg/wstg/document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md 62:183 ✖ Incorrect usage of the term: “client side”, use “client-side” instead terminology

github-actions[bot] commented 4 months ago

The following issues were identified: document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:5:329 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:7:196 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:11:189 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] document/4-Web_Application_Security_Testing/12-API_Testing/00-API_Testing_Overview.md:31:297 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

kingthorin commented 4 months ago

I'll sort the remaining linting issues and get this merged.

victoriadrake commented 4 months ago

I'll sort the remaining linting issues and get this merged.

Beat ya to it

kingthorin commented 4 months ago

Thanks!

kingthorin commented 4 months ago

Oops I forgot to get you to link it up in the various README files