Skip to content

Commit a75415a

Browse files
aryan-bhokarearyan-bhokare
authored
Refactor new documentation links (#69)
Signed-off-by: Aryan Bhokare <[email protected]>
1 parent c946177 commit a75415a

File tree

7 files changed

+33
-33
lines changed

7 files changed

+33
-33
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ Licensed under the GNU AFFERO GENERAL PUBLIC LICENSE.
127127

128128
# Links
129129
- [Intelowl](https://github.com/intelowlproject/IntelOwl)
130-
- [Documentation](https://intelowl.readthedocs.io/en/latest/)
131-
- [API documentation](https://intelowl.readthedocs.io/en/latest/Redoc.html)
130+
- [Documentation](https://intelowlproject.github.io/docs/)
131+
- [API documentation](https://intelowlproject.github.io/docs/IntelOwl/api_docs/)
132132
- [Examples](./examples/)
133133

134134
# FAQ

‎gointelowl/analysis.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ type MultipleAnalysisResponse struct {
6666
//
6767
// Endpoint: POST /api/analyze_observable
6868
//
69-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyze_observable
69+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyze_observable
7070
func (client *IntelOwlClient) CreateObservableAnalysis(ctx context.Context, params *ObservableAnalysisParams) (*AnalysisResponse, error) {
7171
requestUrl := client.options.Url + constants.ANALYZE_OBSERVABLE_URL
7272
method := "POST"
@@ -95,7 +95,7 @@ func (client *IntelOwlClient) CreateObservableAnalysis(ctx context.Context, para
9595
//
9696
// Endpoint: POST /api/analyze_multiple_observables
9797
//
98-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyze_multiple_observables
98+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyze_multiple_observables
9999
func (client *IntelOwlClient) CreateMultipleObservableAnalysis(ctx context.Context, params *MultipleObservableAnalysisParams) (*MultipleAnalysisResponse, error) {
100100
requestUrl := client.options.Url + constants.ANALYZE_MULTIPLE_OBSERVABLES_URL
101101
method := "POST"
@@ -123,7 +123,7 @@ func (client *IntelOwlClient) CreateMultipleObservableAnalysis(ctx context.Conte
123123
//
124124
// Endpoint: POST /api/analyze_file
125125
//
126-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyze_file
126+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyze_file
127127
func (client *IntelOwlClient) CreateFileAnalysis(ctx context.Context, fileAnalysisParams *FileAnalysisParams) (*AnalysisResponse, error) {
128128
requestUrl := client.options.Url + constants.ANALYZE_FILE_URL
129129
// * Making the multiform data
@@ -201,7 +201,7 @@ func (client *IntelOwlClient) CreateFileAnalysis(ctx context.Context, fileAnalys
201201
//
202202
// Endpoint: POST /api/analyze_mutliple_files
203203
//
204-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyze_multiple_files
204+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyze_multiple_files
205205
func (client *IntelOwlClient) CreateMultipleFileAnalysis(ctx context.Context, fileAnalysisParams *MultipleFileAnalysisParams) (*MultipleAnalysisResponse, error) {
206206
requestUrl := client.options.Url + constants.ANALYZE_MULTIPLE_FILES_URL
207207
// * Making the multiform data

‎gointelowl/analyzer.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ type AnalyzerConfig struct {
2727

2828
// AnalyzerService handles communication with analyzer related methods of the IntelOwl API.
2929
//
30-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyzer
30+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyzer
3131
type AnalyzerService struct {
3232
client *IntelOwlClient
3333
}
@@ -36,7 +36,7 @@ type AnalyzerService struct {
3636
//
3737
// Endpoint: GET /api/get_analyzer_configs
3838
//
39-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/get_analyzer_configs
39+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/get_analyzer_configs
4040
func (analyzerService *AnalyzerService) GetConfigs(ctx context.Context) (*[]AnalyzerConfig, error) {
4141
requestUrl := analyzerService.client.options.Url + constants.ANALYZER_CONFIG_URL
4242
contentType := "application/json"
@@ -74,7 +74,7 @@ func (analyzerService *AnalyzerService) GetConfigs(ctx context.Context) (*[]Anal
7474
//
7575
// Endpoint: GET /api/analyzer/{NameOfAnalyzer}/healthcheck
7676
//
77-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/analyzer/operation/analyzer_healthcheck_retrieve
77+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/analyzer/operation/analyzer_healthcheck_retrieve
7878
func (analyzerService *AnalyzerService) HealthCheck(ctx context.Context, analyzerName string) (bool, error) {
7979
route := analyzerService.client.options.Url + constants.ANALYZER_HEALTHCHECK_URL
8080
requestUrl := fmt.Sprintf(route, analyzerName)

‎gointelowl/connector.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ type ConnectorConfig struct {
1919

2020
// ConnectorService handles communication with connector related methods of the IntelOwl API.
2121
//
22-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/connector
22+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/connector
2323
type ConnectorService struct {
2424
client *IntelOwlClient
2525
}
@@ -28,7 +28,7 @@ type ConnectorService struct {
2828
//
2929
// Endpoint: GET /api/get_connector_configs
3030
//
31-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/get_connector_configs
31+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/get_connector_configs
3232
func (connectorService *ConnectorService) GetConfigs(ctx context.Context) (*[]ConnectorConfig, error) {
3333
requestUrl := connectorService.client.options.Url + constants.CONNECTOR_CONFIG_URL
3434
contentType := "application/json"
@@ -66,7 +66,7 @@ func (connectorService *ConnectorService) GetConfigs(ctx context.Context) (*[]Co
6666
//
6767
// Endpoint: GET /api/connector/{NameOfConnector}/healthcheck
6868
//
69-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/connector/operation/connector_healthcheck_retrieve
69+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/connector/operation/connector_healthcheck_retrieve
7070
func (connectorService *ConnectorService) HealthCheck(ctx context.Context, connectorName string) (bool, error) {
7171
route := connectorService.client.options.Url + constants.CONNECTOR_HEALTHCHECK_URL
7272
requestUrl := fmt.Sprintf(route, connectorName)

‎gointelowl/job.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ type JobListResponse struct {
7272

7373
// JobService handles communication with job related methods of IntelOwl API.
7474
//
75-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs
75+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs
7676
type JobService struct {
7777
client *IntelOwlClient
7878
}
@@ -81,7 +81,7 @@ type JobService struct {
8181
//
8282
// Endpoint: GET /api/jobs
8383
//
84-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_list
84+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_list
8585
func (jobService *JobService) List(ctx context.Context) (*JobListResponse, error) {
8686
requestUrl := jobService.client.options.Url + constants.BASE_JOB_URL
8787
contentType := "application/json"
@@ -107,7 +107,7 @@ func (jobService *JobService) List(ctx context.Context) (*JobListResponse, error
107107
//
108108
// Endpoint: GET /api/jobs/{jobID}
109109
//
110-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_retrieve
110+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_retrieve
111111
func (jobService *JobService) Get(ctx context.Context, jobId uint64) (*Job, error) {
112112
route := jobService.client.options.Url + constants.SPECIFIC_JOB_URL
113113
requestUrl := fmt.Sprintf(route, jobId)
@@ -133,7 +133,7 @@ func (jobService *JobService) Get(ctx context.Context, jobId uint64) (*Job, erro
133133
//
134134
// Endpoint: GET /api/jobs/{jobID}/download_sample
135135
//
136-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_download_sample_retrieve
136+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_download_sample_retrieve
137137
func (jobService *JobService) DownloadSample(ctx context.Context, jobId uint64) ([]byte, error) {
138138
route := jobService.client.options.Url + constants.DOWNLOAD_SAMPLE_JOB_URL
139139
requestUrl := fmt.Sprintf(route, jobId)
@@ -154,7 +154,7 @@ func (jobService *JobService) DownloadSample(ctx context.Context, jobId uint64)
154154
//
155155
// Endpoint: DELETE /api/jobs/{jobID}
156156
//
157-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_destroy
157+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_destroy
158158
func (jobService *JobService) Delete(ctx context.Context, jobId uint64) (bool, error) {
159159
route := jobService.client.options.Url + constants.SPECIFIC_JOB_URL
160160
requestUrl := fmt.Sprintf(route, jobId)
@@ -178,7 +178,7 @@ func (jobService *JobService) Delete(ctx context.Context, jobId uint64) (bool, e
178178
//
179179
// Endpoint: PATCH /api/jobs/{jobID}/kill
180180
//
181-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_kill_partial_update
181+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_kill_partial_update
182182
func (jobService *JobService) Kill(ctx context.Context, jobId uint64) (bool, error) {
183183
route := jobService.client.options.Url + constants.KILL_JOB_URL
184184
requestUrl := fmt.Sprintf(route, jobId)
@@ -202,7 +202,7 @@ func (jobService *JobService) Kill(ctx context.Context, jobId uint64) (bool, err
202202
//
203203
// Endpoint: PATCH /api/jobs/{jobID}/analyzer/{nameOfAnalyzer}/kill
204204
//
205-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_analyzer_kill_partial_update
205+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_analyzer_kill_partial_update
206206
func (jobService *JobService) KillAnalyzer(ctx context.Context, jobId uint64, analyzerName string) (bool, error) {
207207
route := jobService.client.options.Url + constants.KILL_ANALYZER_JOB_URL
208208
requestUrl := fmt.Sprintf(route, jobId, analyzerName)
@@ -226,7 +226,7 @@ func (jobService *JobService) KillAnalyzer(ctx context.Context, jobId uint64, an
226226
//
227227
// Endpoint: PATCH /api/jobs/{jobID}/analyzer/{nameOfAnalyzer}/retry
228228
//
229-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_analyzer_retry_partial_update
229+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_analyzer_retry_partial_update
230230
func (jobService *JobService) RetryAnalyzer(ctx context.Context, jobId uint64, analyzerName string) (bool, error) {
231231
route := jobService.client.options.Url + constants.RETRY_ANALYZER_JOB_URL
232232
requestUrl := fmt.Sprintf(route, jobId, analyzerName)
@@ -250,7 +250,7 @@ func (jobService *JobService) RetryAnalyzer(ctx context.Context, jobId uint64, a
250250
//
251251
// Endpoint: PATCH /api/jobs/{jobID}/connector/{nameOfConnector}/kill
252252
//
253-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_connector_kill_partial_update
253+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_connector_kill_partial_update
254254
func (jobService *JobService) KillConnector(ctx context.Context, jobId uint64, connectorName string) (bool, error) {
255255
route := jobService.client.options.Url + constants.KILL_CONNECTOR_JOB_URL
256256
requestUrl := fmt.Sprintf(route, jobId, connectorName)
@@ -274,7 +274,7 @@ func (jobService *JobService) KillConnector(ctx context.Context, jobId uint64, c
274274
//
275275
// Endpoint: PATCH /api/jobs/{jobID}/connector/{nameOfConnector}/retry
276276
//
277-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/jobs/operation/jobs_connector_retry_partial_update
277+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/jobs/operation/jobs_connector_retry_partial_update
278278
func (jobService *JobService) RetryConnector(ctx context.Context, jobId uint64, connectorName string) (bool, error) {
279279
route := jobService.client.options.Url + constants.RETRY_CONNECTOR_JOB_URL
280280
requestUrl := fmt.Sprintf(route, jobId, connectorName)

‎gointelowl/me.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ type InvitationParams struct {
7474
//
7575
// Endpoint: GET /api/me/access
7676
//
77-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/me/operation/me_access_retrieve
77+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/me/operation/me_access_retrieve
7878
func (userService *UserService) Access(ctx context.Context) (*User, error) {
7979
requestUrl := userService.client.options.Url + constants.USER_DETAILS_URL
8080
contentType := "application/json"
@@ -98,7 +98,7 @@ func (userService *UserService) Access(ctx context.Context) (*User, error) {
9898
//
9999
// Endpoint: GET /api/me/organization
100100
//
101-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/me/operation/me_organization_list
101+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/me/operation/me_organization_list
102102
func (userService *UserService) Organization(ctx context.Context) (*Organization, error) {
103103
requestUrl := userService.client.options.Url + constants.ORGANIZATION_URL
104104
contentType := "application/json"
@@ -123,7 +123,7 @@ func (userService *UserService) Organization(ctx context.Context) (*Organization
123123
//
124124
// Endpoint: POST /api/me/organization
125125
//
126-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/me/operation/me_organization_create
126+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/me/operation/me_organization_create
127127
func (userService *UserService) CreateOrganization(ctx context.Context, organizationParams *OrganizationParams) (*Organization, error) {
128128
requestUrl := userService.client.options.Url + constants.ORGANIZATION_URL
129129
// Getting the relevant JSON data
@@ -155,7 +155,7 @@ func (userService *UserService) CreateOrganization(ctx context.Context, organiza
155155
//
156156
// Endpoint: POST /api/me/organization/invite
157157
//
158-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/me/operation/me_organization_invite_create
158+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/me/operation/me_organization_invite_create
159159
func (userService *UserService) InviteToOrganization(ctx context.Context, memberParams *MemberParams) (*Invite, error) {
160160
requestUrl := userService.client.options.Url + constants.INVITE_TO_ORGANIZATION_URL
161161
// Getting the relevant JSON data
@@ -187,7 +187,7 @@ func (userService *UserService) InviteToOrganization(ctx context.Context, member
187187
//
188188
// Endpoint: POST /api/me/organization/remove_member
189189
//
190-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/me/operation/me_organization_create
190+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/me/operation/me_organization_create
191191
func (userService *UserService) RemoveMemberFromOrganization(ctx context.Context, memberParams *MemberParams) (bool, error) {
192192
requestUrl := userService.client.options.Url + constants.REMOVE_MEMBER_FROM_ORGANIZATION_URL
193193
// Getting the relevant JSON data

‎gointelowl/tag.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ type Tag struct {
2626

2727
// TagService handles communication with tag related methods of IntelOwl API.
2828
//
29-
// IntelOwl REST API tag docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags
29+
// IntelOwl REST API tag docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags
3030
type TagService struct {
3131
client *IntelOwlClient
3232
}
@@ -43,7 +43,7 @@ func checkTagID(id uint64) error {
4343
//
4444
// Endpoint: GET "/api/tags"
4545
//
46-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags/operation/tags_list
46+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags/operation/tags_list
4747
func (tagService *TagService) List(ctx context.Context) (*[]Tag, error) {
4848
requestUrl := tagService.client.options.Url + constants.BASE_TAG_URL
4949
contentType := "application/json"
@@ -69,7 +69,7 @@ func (tagService *TagService) List(ctx context.Context) (*[]Tag, error) {
6969
//
7070
// Endpoint: GET "/api/tags/{id}"
7171
//
72-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags/operation/tags_retrieve
72+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags/operation/tags_retrieve
7373
func (tagService *TagService) Get(ctx context.Context, tagId uint64) (*Tag, error) {
7474
if err := checkTagID(tagId); err != nil {
7575
return nil, err
@@ -98,7 +98,7 @@ func (tagService *TagService) Get(ctx context.Context, tagId uint64) (*Tag, erro
9898
//
9999
// Endpoint: POST "/api/tags/"
100100
//
101-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags/operation/tags_create
101+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags/operation/tags_create
102102
func (tagService *TagService) Create(ctx context.Context, tagParams *TagParams) (*Tag, error) {
103103
requestUrl := tagService.client.options.Url + constants.BASE_TAG_URL
104104
tagJson, err := json.Marshal(tagParams)
@@ -128,7 +128,7 @@ func (tagService *TagService) Create(ctx context.Context, tagParams *TagParams)
128128
//
129129
// Endpoint: PUT "/api/tags/{id}"
130130
//
131-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags/operation/tags_update
131+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags/operation/tags_update
132132
func (tagService *TagService) Update(ctx context.Context, tagId uint64, tagParams *TagParams) (*Tag, error) {
133133
route := tagService.client.options.Url + constants.SPECIFIC_TAG_URL
134134
requestUrl := fmt.Sprintf(route, tagId)
@@ -161,7 +161,7 @@ func (tagService *TagService) Update(ctx context.Context, tagId uint64, tagParam
161161
//
162162
// Endpoint: DELETE "/api/tags/{id}"
163163
//
164-
// IntelOwl REST API docs: https://intelowl.readthedocs.io/en/latest/Redoc.html#tag/tags/operation/tags_destroy
164+
// IntelOwl REST API docs: https://intelowlproject.github.io/docs/IntelOwl/api_docs/#tag/tags/operation/tags_destroy
165165
func (tagService *TagService) Delete(ctx context.Context, tagId uint64) (bool, error) {
166166
if err := checkTagID(tagId); err != nil {
167167
return false, err

0 commit comments

Comments
 (0)