Commit Graph

62 Commits (0b48d2371de360c66ecdcca0dfebb67386b15ecc)

Author SHA1 Message Date
Erin Bleiweiss 41d12166fd
Use a string hash key for documentation 2018-09-06 15:57:52 -05:00
Erin Bleiweiss b1479ec350
Update swagger docs to be compliant with new notes field 2018-08-31 16:53:59 -05:00
Erin Bleiweiss 4b42e7633c Add examples for username and password properties 2018-08-15 16:34:11 -05:00
Erin Bleiweiss a70c5f0c37 Replace strings with reusable constants 2018-08-15 15:26:35 -05:00
Erin Bleiweiss c19dc52573 Remove extraneous lines from a bad copy/paste 2018-08-15 15:03:27 -05:00
Erin Bleiweiss 2abc49641c Add 401 responses for all endpoints 2018-08-14 13:35:59 -05:00
Erin Bleiweiss 66b761db15 Add doc for user operations 2018-08-14 13:19:56 -05:00
Erin Bleiweiss f7a0b201d7 Add authorization support for auth/bearer tokens 2018-08-14 11:51:15 -05:00
James Barnett 888dc43a7e
Land #10348, Add REST API for module queries
This PR also updates the local module queries with more query parameters
and logic.
2018-07-31 16:06:31 -05:00
Erin Bleiweiss 58b3f63c1a Update to reflect new JSON models 2018-07-31 15:57:26 -05:00
James Barnett 458fb36ec8
Update API docs for GET resource/ID 2018-07-31 15:43:57 -05:00
Erin Bleiweiss 3e8efea57a Merge branch 'conform_to_api_standards' into exploit-query
Prepare for new JSON format.
2018-07-31 14:48:37 -05:00
James Barnett 3411d0bce2
Refactor error JSON responses to use a helper method 2018-07-27 13:59:17 -05:00
Erin Bleiweiss 2572a297a2 clean up parameter delcarations in docs and rename doc files to module_search 2018-07-26 11:43:55 -05:00
James Barnett b1022d16bf
Fix typo in delete response message in docs 2018-07-26 08:43:05 -05:00
James Barnett ec62815d6e
Add error responses to API docs 2018-07-25 21:46:33 -05:00
James Barnett cc21c0a673
Update documentation for new format 2018-07-25 18:01:05 -05:00
Erin Bleiweiss 87434ef22d pull changes 2018-07-24 15:42:31 -05:00
James Barnett eccd223a3e
Merge branch 'master' into conform_to_api_standards 2018-07-24 12:11:14 -05:00
Erin Bleiweiss ce7eb9f3fe add list of valid fields to documenation and update aliases 2018-07-19 14:31:46 -05:00
Erin Bleiweiss 462655dea1 update response example documentation 2018-07-19 14:10:04 -05:00
Erin Bleiweiss 4c71268b38 add documentation for aliases 2018-07-19 13:38:18 -05:00
Erin Bleiweiss e3716305dc add new fields to swagger doc 2018-07-19 13:31:41 -05:00
Erin Bleiweiss 8010c58220 add module documentation to swagger (WIP) 2018-07-18 17:36:31 -05:00
James Barnett 4d2e0e51e4
Update docs for /endpoit/ID GET requests 2018-07-18 16:01:12 -05:00
James Barnett b119622408
GET with ID is NYI for credentials 2018-07-10 17:30:44 -05:00
James Barnett 0270b0269b
Update Credential API documentation 2018-07-10 17:29:25 -05:00
James Barnett e7ddb6fdf5
Add API docs for logins endpoints 2018-07-10 14:21:19 -05:00
James Barnett a8f19df4e6
Pass params through query string on creds GET
Also updated API docs to use correct params
2018-05-30 16:23:37 -05:00
James Barnett 44812852e2 Merge branch 'local_api_docs' of github.com:jbarnett-r7/metasploit-framework into local_api_docs 2018-05-29 12:33:30 -05:00
James Barnett f8317d3ae2
Address code review comments
- Don't document unsupported session POST
- Hide unimplemented loot/id and session/id GET methods
- Fix URL for msf doc
- Add missing workspace parament to vuln-attempts
- Remove unneccessary code for hosting the doc UI
2018-05-29 12:24:53 -05:00
jbarnett-r7 59e084aa46
Remote local version of remote data service help 2018-05-24 11:07:37 -05:00
James Barnett 8acc6daf9b
Add doc for running the remote data service 2018-05-23 11:54:57 -05:00
James Barnett 7d7f405234
Describe ALL the attributes! 2018-05-22 14:57:21 -05:00
James Barnett 132313ef34
Minor updates across all API docs. 2018-05-17 16:56:22 -05:00
James Barnett 94b32a3888
Workspace API Doc second pass 2018-05-17 11:22:43 -05:00
James Barnett e1f46b07f8
VulnAttempt API Doc second pass 2018-05-16 16:57:55 -05:00
James Barnett 43f410ccd3
Fix format of REFS_EXAMPLE 2018-05-16 15:37:33 -05:00
James Barnett 5e39314a72
Vuln API Doc second pass. 2018-05-16 15:26:44 -05:00
James Barnett edc06f6361
Second pass on SessionEvent API doc 2018-05-16 11:56:11 -05:00
James Barnett fc079138fd
Service API doc second pass 2018-05-15 14:34:15 -05:00
James Barnett d1701c37d6
Second pass on note API doc 2018-05-08 16:15:40 -05:00
James Barnett bba77596c0
Second pass on loot API doc 2018-05-08 15:41:17 -05:00
James Barnett 07eb79e183
Second pass on creds, hosts, events, db_export, and exploits 2018-05-08 12:38:04 -05:00
James Barnett 9228f4fb6b
Second pass on Event API doc 2018-05-04 17:08:33 -05:00
James Barnett a5b9cc8cb8
Add Msf endpoint API doc 2018-05-03 17:16:04 -05:00
James Barnett 40c978e040
First pass at Vuln Attempt API doc 2018-05-03 16:59:30 -05:00
James Barnett 728850c61a
First pass at Session Event API doc 2018-05-03 16:00:56 -05:00
James Barnett a11c7220b6
First pass at Event API doc 2018-05-03 14:20:23 -05:00
James Barnett 249db505c8
First pass at Credential API doc
Also get the workspace from the query string for credentials
2018-05-02 16:47:39 -05:00