SpecterOps
Nemesis 2.0 API Documentation
Is it possible to add updated api documentation to the docs page? Searching for api documentation online is difficult since there isn't a clear source of what endpoints have changed/been removed since version 1. The /api/docs swagger endpoint is helpful, however it doesn't include any of the graphql schemas. Ideally there would be a section noting all the api documentation across all of the nemesis containers on the docs page, as well as how to access them. As an example getting the value of the HASURA_ADMIN_SECRET environment variable isn't well documented, I had to dig into config.yaml and get the appended secret since there wasn't one set. Additionally, the documentation page still links to blog posts that are outdated and incompatible with v2.
Apologies for the frustration, all very good points.
I've updated the index.md doc (https://github.com/SpecterOps/Nemesis/blob/nemesis-2.1.3/docs/index.md#overview - this branch will be merged within the next week) that breaks out v1.0 / v2.0 tags for the blog posts.
Also, there was a recent pull request that documented the HASURA_ADMIN_SECRET in the env.example.
As far as the API documentation, we'll see if we can work on some kind of automatic OpenAPI export to markdown so we can publish the docs on any web_api file change. I'll leave this issue open until if/when we complete that part of the process.
We're currently merging in some major changes, and a part of this we now have a github workflow that should auto-generate the openapi json spec and update the API docs on the github pages site