Skip to content

Conversation

@nineinchnick
Copy link
Collaborator

@nineinchnick nineinchnick commented Mar 22, 2020

Greatly improve the --describe command by adding class attributes docs and marking which ones are required. Also print default values.

Note: in this MR I do not try to document all attributes but only the most obvious ones

Here's the current (truncated) output of the make describe command:

TM class attributes:
  description     Model description, required
  isOrdered       Automatically order all Dataflows, default: False
  mergeResponses  Merge response edges in DFDs, default: False
  name            Model name, required
  threatsFile     JSON file with custom threats, default: /home/jwas/src/pytm/pytm/threatlib/threats.json

Element class attributes:
  OS
  definesConnectionTimeout        default: False
  description
  handlesResources                default: False
  implementsAuthenticationScheme  default: False
  implementsNonce                 default: False
  inBoundary
  inScope                         Is the element in scope of the threat model, default: True
  isAdmin                         default: False
  isHardened                      default: False
  name                            required
  onAWS                           default: False

...

Possibly closes #78

@nineinchnick nineinchnick requested a review from izar as a code owner March 22, 2020 11:01
@ghost
Copy link

ghost commented Mar 22, 2020

Congratulations 🍻. DeepCode analyzed your code in 0.299 seconds and we found no issues. Enjoy a moment of no bugs ☀️.

💬 This comment has been generated by the DeepCode bot, installed by the owner of the repository. The DeepCode bot protects your repository by detecting and commenting on security vulnerabilities or other critical issues.


☺️ If you want to provide feedback on our bot, here is how to contact us.

@izar izar merged commit d6d0afe into OWASP:master Mar 24, 2020
@nineinchnick nineinchnick deleted the attr-docs branch December 18, 2022 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for attributes: Mandatory/Optional/Default

2 participants