Add docstrings to Octopoes models

[stephanie0x00]

Changes

This PR adds docstrings to extend the Octopoes model.

Issue link

Issue: #2946

Closes #2946

Demo

n/a

QA notes

I've tried to describe all objects as best as I could. I'm fairly sure some are somewhat incorrect and/or miss data. This is the best I could do. The goal is to provide both Possible value/Example values where possible to make it more clear on what the object is, accepts, can do etc. etc. Please help me to enhance the PR. :)

---

Code Checklist

• All the commits in this PR are properly PGP-signed and verified.
• This PR only contains functionality relevant to the issue.
• I have written unit tests for the changes or fixes I made.
• I have checked the documentation and made changes where necessary.
• I have performed a self-review of my code and refactored it to the best of my abilities.

• Tickets have been created for newly discovered issues.
• For any non-trivial functionality, I have added integration and/or end-to-end tests.
• I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
• I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

---

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.

---

Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Donnype]

@stephanie0x00 Cool! I agree with @ammar92 that "Represents" would be better than "Returns". I guess these text show up on the octopoes model documentation page? Is the idea to extend this PR with docstrings for more of the suggested models in the ticket?

[stephanie0x00]

@stephanie0x00 Cool! I agree with @ammar92 that "Represents" would be better than "Returns". I guess these text show up on the octopoes model documentation page? Is the idea to extend this PR with docstrings for more of the suggested models in the ticket?

Yes, all models should, in the end, contain docstring data.

[noamblitz]

This is helpfull! Some tiny remarks. Overall, I think we can expand the docstrings to make them a bit more insightful, what do they do? when are they used? what do they actually show?

Also, I'm missing the oois in the DNS folder.

[Donnype]

In the process of fixing the CI; consider this QA'd ;)

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud