Skip to content

Commit

Permalink
docs update (add x-team-id) header and missing endpoints (#72)
Browse files Browse the repository at this point in the history 
* docs update

* more updates

* Update openapi.yaml
  • Loading branch information
@ehsandeep
ehsandeep authored Sep 22, 2024
1 parent e56556d commit e31c7e0
Show file tree
Hide file tree
Showing 21 changed files with 4,929 additions and 3,222 deletions.
3 changes: 3 additions & 0 deletions api-reference/asset/get-exposure-metrics.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/exposures/metrics
---
3 changes: 3 additions & 0 deletions api-reference/assets/get-asset-screenshot.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/screenshot/{asset_id}
---
3 changes: 3 additions & 0 deletions api-reference/configurations/get-verify-config-contents.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/scans/config/verify/contents
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/delete-assets-in-bulk.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/asset/enumerate
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/export-enumeration-of-user.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/export
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/get-all-enumeration-contents.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/contents
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/get-all-enumeration-stats.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/stats
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/get-enumeration-config.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/config
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/group-assets-by-filters-for-an-enumeration.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/{enumerate_id}/filters
---
3 changes: 3 additions & 0 deletions api-reference/enumerations/group-assets-by-filters.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/asset/enumerate/filters
---
3 changes: 3 additions & 0 deletions api-reference/export/export-filtered-scan-results.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v1/scans/results/export
---
3 changes: 3 additions & 0 deletions api-reference/export/get-export-list-for-user.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/export/list
---
3 changes: 3 additions & 0 deletions api-reference/get-audit-logs-for-team.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/team/audit_log
---
3 changes: 3 additions & 0 deletions api-reference/scans/delete-scan-in-bulk.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/scans
---
3 changes: 3 additions & 0 deletions api-reference/scans/delete-vulns-tracker-association.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v1/scans/vulns/{vuln_id}/ticket
---
3 changes: 3 additions & 0 deletions api-reference/update-enumeration-config.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/asset/enumerate/{enumerate_id}/config
---
3 changes: 3 additions & 0 deletions api-reference/usage/get-api-services-usage.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/user/usage
---
3 changes: 3 additions & 0 deletions api-reference/users/get-tunnels-list.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v1/user/tunnels
---
3 changes: 3 additions & 0 deletions api-reference/users/update-current-subscription.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v1/user/subscription
---
161 changes: 80 additions & 81 deletions mint.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@
"navigation": [
{
"group": "Welcome",
"pages": ["introduction", "documentation-nav", "overview"]
"pages": [
"introduction",
"documentation-nav",
"overview"
]
},
{
"group": "New to Open Source?",
Expand All @@ -89,7 +93,9 @@
},
{
"group": "ProjectDiscovery Cloud Platform",
"pages": ["cloudplatform"]
"pages": [
"cloudplatform"
]
},
{
"group": "Tools",
Expand Down Expand Up @@ -362,7 +368,10 @@
},
{
"group": "Workflows",
"pages": ["templates/workflows/overview", "templates/workflows/examples"]
"pages": [
"templates/workflows/overview",
"templates/workflows/examples"
]
},
{
"group": "ProjectDiscovery Cloud Platform",
Expand All @@ -374,13 +383,19 @@
"group": "General Admin",
"icon": "square-question",
"iconType": "regular",
"pages": ["cloud/general-faq", "cloud/admin"]
"pages": [
"cloud/general-faq",
"cloud/admin"
]
},
{
"group": "Assets",
"icon": "bullseye",
"iconType": "regular",
"pages": ["cloud/assets/overview", "cloud/assets/adding-assets"]
"pages": [
"cloud/assets/overview",
"cloud/assets/adding-assets"
]
},
{
"group": "Templates & Editor",
Expand Down Expand Up @@ -435,53 +450,53 @@
{
"group": "Assets",
"pages": [
"api-reference/assets/get-asset-list",
"api-reference/assets/upload-asset",
"api-reference/assets/get-asset-content",
"api-reference/assets/delete-asset",
"api-reference/assets/delete-enumerated-asset",
"api-reference/assets/get-asset-metadata",
"api-reference/assets/update-asset-metadata",
"api-reference/assets/update-asset-content"
]
},
{
"group": "Auto Discovery",
"pages": [
"api-reference/enumerations/get-enumeration-list",
"api-reference/enumerations/create-enumeration",
"api-reference/enumerations/get-enumeration",
"api-reference/enumerations/update-enumeration",
"api-reference/enumerations/delete-enumeration",
"api-reference/enumerations/get-enumeration-list",
"api-reference/enumerations/export-enumeration",
"api-reference/enumerations/rescan-enumeration",
"api-reference/enumerations/stop-enumeration",
"api-reference/enumerations/delete-assets-in-bulk",
"api-reference/enumerations/update-enumeration",
"api-reference/enumerations/get-enumeration-contents",
"api-reference/enumerations/get-all-enumeration-contents",
"api-reference/enumerations/stop-enumeration",
"api-reference/enumerations/rescan-enumeration",
"api-reference/enumerations/export-enumeration",
"api-reference/update-enumeration-config",
"api-reference/enumerations/get-enumeration-schedules",
"api-reference/enumerations/set-enumeration-schedule",
"api-reference/enumerations/delete-enumeration-schedule",
"api-reference/enumerations/get-enumeration-stats"
"api-reference/enumerations/get-enumeration-stats",
"api-reference/enumerations/get-all-enumeration-stats",
"api-reference/enumerations/get-enumeration-config",
"api-reference/enumerations/group-assets-by-filters",
"api-reference/enumerations/group-assets-by-filters-for-an-enumeration",
"api-reference/enumerations/export-enumeration-of-user",
"api-reference/assets/upload-asset",
"api-reference/assets/update-asset-content",
"api-reference/assets/get-asset-metadata",
"api-reference/assets/get-asset-content",
"api-reference/assets/delete-asset"
]
},
{
"group": "Templates",
"pages": [
"api-reference/templates/create-template",
"api-reference/templates/generate-ai-template",
"api-reference/templates/get-template",
"api-reference/templates/update-template",
"api-reference/templates/delete-template",
"api-reference/templates/get-template-list",
"api-reference/templates/get-public-template-list",
"api-reference/templates/get-public-template-stats",
"api-reference/templates/get-public-template",
"api-reference/templates/get-early-template-list",
"api-reference/templates/get-early-template",
"api-reference/templates/get-public-template",
"api-reference/templates/get-template-list",
"api-reference/templates/create-template",
"api-reference/templates/update-template",
"api-reference/templates/get-template",
"api-reference/templates/delete-template",
"api-reference/templates/generate-ai-template",
"api-reference/templates/get-share-status",
"api-reference/templates/share-template",
"api-reference/templates/get-shared-template",
"api-reference/templates/get-github-template-list",
"api-reference/templates/get-github-template",
"api-reference/templates/share-template",
"api-reference/templates/get-share-status",
"api-reference/templates/get-shared-template"
"api-reference/templates/get-public-template-stats"
]
},
{
Expand All @@ -490,41 +505,41 @@
"api-reference/scans/get-scan-list",
"api-reference/scans/create-scan",
"api-reference/scans/get-scan",
"api-reference/scans/get-scan-ips",
"api-reference/scans/get-scans-token",
"api-reference/scans/delete-scan",
"api-reference/scans/delete-scan-in-bulk",
"api-reference/scans/update-scan",
"api-reference/scans/import-oss-scan",
"api-reference/scans/stop-scan",
"api-reference/scans/rescan-scan",
"api-reference/scans/import-oss-scan",
"api-reference/scans/update-imported-scan",
"api-reference/scans/get-all-scan-stats",
"api-reference/scans/retest-vulnerability",
"api-reference/scans/get-scan-schedules",
"api-reference/scans/set-scan-schedule",
"api-reference/scans/delete-scan-schedule",
"api-reference/scans/get-all-scan-stats",
"api-reference/scans/get-all-scans-history",
"api-reference/scans/get-scan-history",
"api-reference/scans/get-scan-ips",
"api-reference/scans/update-imported-scan",
"api-reference/scans/export-scan",
"api-reference/scans/export-filtered-scan",
"api-reference/scans/export-scan-vulnerability",
"api-reference/scans/delete-scan-vulnerability",
"api-reference/scans/update-vulnerability-status",
"api-reference/scans/update-vulnerability-labels",
"api-reference/scans/get-scan-config",
"api-reference/scans/update-scan-config",
"api-reference/scans/retest-vulnerability",
"api-reference/scans/delete-scan-vulnerability",
"api-reference/scans/export-scan-vulnerability",
"api-reference/scans/export-filtered-scan",
"api-reference/scans/export-scan",
"api-reference/scans/get-all-scans-history",
"api-reference/scans/get-scan-history",
"api-reference/scans/create-vulns-export-to-tracker",
"api-reference/scans/update-vulnerability-labels",
"api-reference/scans/update-vulnerability-status"
"api-reference/scans/get-scans-token"
]
},
{
"group": "Configurations",
"pages": [
"api-reference/configurations/get-config",
"api-reference/configurations/get-configs-list",
"api-reference/configurations/add-config",
"api-reference/configurations/update-config",
"api-reference/configurations/get-config",
"api-reference/configurations/delete-config",
"api-reference/configurations/verify-config",
"api-reference/configurations/update-config",
"api-reference/configurations/get-excluded-templates",
"api-reference/configurations/add-excluded-templates",
"api-reference/configurations/delete-excluded-template-ids"
Expand All @@ -533,54 +548,38 @@
{
"group": "Results",
"pages": [
"api-reference/results/get-scan-vulnerability",
"api-reference/results/get-scan-results",
"api-reference/results/get-all-results",
"api-reference/results/get-scan-vulnerability",
"api-reference/results/get-scans-result-filters",
"api-reference/results/get-results-stats"
]
},
{
"group": "Retests",
"pages": [
"api-reference/retests/get-all-retest",
"api-reference/retests/create-retest",
"api-reference/retests/get-retest-vulnerability"
]
},
{
"group": "Scan Logs",
"group": "Logs",
"pages": [
"api-reference/elog/get-elogs-of-given-scan-id",
"api-reference/scan_log/get-scan-log-of-given-scan-id",
"api-reference/scan_log/download-scan-log-of-given-scan-id"
"api-reference/get-audit-logs-for-team"
]
},
{
"group": "Error Logs",
"group": "Users",
"pages": [
"api-reference/elog/get-elogs-of-given-scan-id",
"api-reference/elog/download-elogs-of-given-scan-id"
"api-reference/users/get-user-profile",
"api-reference/users/get-api-key",
"api-reference/users/create-api-key",
"api-reference/users/delete-api-key",
"api-reference/users/rotate-api-key"
]
},
{
"group": "Users",
"group": "Help",
"pages": [
"api-reference/users/create-api-key",
"api-reference/users/get-api-key",
"api-reference/users/rotate-api-key",
"api-reference/users/delete-api-key",
"api-reference/users/get-user-profile",
"api-reference/users/get-subscription-status",
"api-reference/users/create-feedback",
"api-reference/users/delete-user-from-system-along-with-all-data",
"api-reference/users/email-user-deletion-verification-code"
"help/home"
]
}
]
},
{
"group": "Help",
"pages": ["help/home"]
}
],
"footerSocials": {
Expand All @@ -594,4 +593,4 @@
"thumbsRating": true,
"suggestEdit": true
}
}
}
Loading

0 comments on commit e31c7e0

Please sign in to comment.