pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

md_processing/data/commands/commands_feedback.json

@@ -0,0 +1,155 @@
+{
+  "Command Specifications": {
+    "Create Comment": {
+      "display_name": "Comment",
+      "qn_prefix": "Comment",
+      "family": "Feedback Manager",
+      "description": "Add a comment to an associated element.",
+      "verb": "Create",
+      "find_method": "GovernanceOfficer.find_governance_definitions",
+      "Attributes": [
+        {
+          "Display Name": {
+            "variable_name": "display_name",
+            "attr_labels": "Name",
+            "description": "Name of the  Comment."
+          }
+        },
+        {
+          "Associated Element": {
+            "variable_name": "associated_element",
+            "attr_labels": "Element",
+            "description": "The element the comment is attached to. To reply to a previous comment, you would use the ID of the previous comment as the associated element.",
+            "style": "Reference Name",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Comment Text": {
+            "variable_name": "comment_text",
+            "attr_labels": "Comment, Description",
+            "description": "The Comment text.",
+            "input_required": true
+          }
+        },
+        {
+          "Comment Type": {
+            "variable_name": "comment_type",
+            "attr_labels": "",
+            "default_value": "STANDARD_COMMENT",
+            "valid_values": "STANDARD_COMMENT; QUESTION; ANSWER; SUGGESTION; USAGE_EXPERIENCE; REQUIREMENT; OTHER",
+            "description": "A user specified category name that can be used for example, to define product types or agreement types.",
+            "style": "Valid Value"
+          }
+        }
+      ]
+    },
+    "Create Journal Entry": {
+      "display_name": "NoteLog",
+      "qn_prefix": "NoteLog",
+      "alternate_names": "Note Log; Journal",
+      "family": "Feedback Manager",
+      "description": "Allows a sequence of notes to be attached to an associated element.",
+      "verb": "Create",
+      "find_method": "Client2.find_notes",
+      "Attributes": [
+        {
+          "Journal Name": {
+            "variable_name": "display_name",
+            "attr_labels": "Name; Title",
+            "description": "Name of the  NoteLog or Journal.",
+            "style": "ID",
+            "input_required": true
+          }
+        },
+        {
+          "Associated Element": {
+            "variable_name": "associated_element",
+            "attr_labels": "Element",
+            "description": "The element the NoteLog is attached to.",
+            "style": "Reference Name",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Journal Description": {
+            "variable_name": "journal_description",
+            "attr_labels": "",
+            "description": "Description of the NoteLog."
+          }
+        },
+        {
+          "Note Entry": {
+            "variable_name": "note_entry",
+            "attr_labels": "Note; Journal Entry",
+            "description": "The text of the journal entry.",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        }
+      ]
+    },
+    "Create Informal Tag": {
+      "display_name": "Informal Tag",
+      "qn_prefix": "InformalTag",
+      "family": "Feedback Manager",
+      "description": "Creates an informal tag that can be attached to elements. ",
+      "verb": "Create",
+      "find_method": "Client2.find_tags",
+      "Attributes": [
+        {
+          "Display Name": {
+            "variable_name": "display_name",
+            "attr_labels": "Name, Tag Name",
+            "description": "Name of the informal tag.",
+            "style": "ID",
+            "input_required": true
+          }
+        },
+        {
+          "Description": {
+            "variable_name": "description",
+            "attr_labels": "",
+            "description": "Description of the Informal Tag."
+          }
+        }
+      ]
+    },
+    "Link Tag->Element": {
+      "display_name": "Tag Element",
+      "qn_prefix": "",
+      "alternate_names": "Attach Tag; Tag Element",
+      "family": "Feedback Manager",
+      "description": "Used to attach an informal tag to an element.",
+      "verb": "Link",
+      "upsert": false,
+      "attach": true,
+      "find_method": "",
+      "Attributes": [
+        {
+          "Tag ID": {
+            "variable_name": "tag_id",
+            "attr_labels": "",
+            "existing_element": "Informal Tag",
+            "description": "Identity (usually qualified name) of the tag to attach.",
+            "style": "Reference Name",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Element ID": {
+            "variable_name": "element_id",
+            "attr_labels": "",
+            "existing_element": "Element GUID",
+            "description": "Identity (usually qualified name) of the element you are tagging.",
+            "style": "Reference Name",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        }
+      ]
+    }
+  }
+}

md_processing/data/commands/commands_general.json

@@ -0,0 +1,204 @@
+{
+  "Command Specifications": {
+    "View Report": {
+      "display_name": "View Report",
+      "qn_prefix": "",
+      "alternate_names": "View MD; View FORM; View DICT; View LIST; View HTML",
+      "family": "General",
+      "description": "This can be used to produce a report using any output format set.",
+      "verb": "View",
+      "upsert": false,
+      "find_method": "",
+      "Attributes": [
+        {
+          "Search String": {
+            "variable_name": "",
+            "attr_labels": "Filter",
+            "default_value": "*",
+            "description": "An optional search string to filter results by."
+          }
+        },
+        {
+          "Output Format": {
+            "variable_name": "",
+            "attr_labels": "Format",
+            "examples": "LIST, FORM",
+            "default_value": "LIST",
+            "valid_values": "LIST; FORM; REPORT; MERMAID; DICT",
+            "description": "Optional specification of output format for the query.",
+            "style": "Valid Value"
+          }
+        },
+        {
+          "Report Spec": {
+            "variable_name": "report_spec",
+            "attr_labels": "Output Format Set; Report",
+            "examples": "Collections, Agreements",
+            "default_value": "Referenceable",
+            "description": "Optional specification of an report  that defines the attributes/columns that will be returned.",
+            "input_required": true
+          }
+        },
+        {
+          "Starts With": {
+            "variable_name": "starts_with",
+            "inUpdate": false,
+            "attr_labels": "",
+            "default_value": "True",
+            "description": "If true, look for matches with the search string starting from the beginning of  a field.",
+            "style": "Bool",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Ends With": {
+            "variable_name": "ends_with",
+            "inUpdate": false,
+            "attr_labels": "",
+            "default_value": "False",
+            "description": "If true, look for matches with the search string starting from the end of  a field.",
+            "style": "Bool",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Ignore Case": {
+            "variable_name": "",
+            "attr_labels": "",
+            "default_value": "False",
+            "existing_element": "ignore_case",
+            "description": "If true, ignore the difference between upper and lower characters when matching the search string.",
+            "style": "Bool",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Limit Result by Status": {
+            "variable_name": "",
+            "attr_labels": "",
+            "default_value": "['ACTIVE']",
+            "valid_values": "'UNKNOWN'; 'DRAFT'; 'PREPARED'; 'PROPOSED'; 'APPROVED'; 'REJECTED';   'APPROVED_CONCEPT'; 'UNDER_DEVELOPMENT'; 'DEVELOPMENT_COMPLETE';                              'APPROVED_FOR_DEPLOYMENT'; 'STANDBY'; 'ACTIVE'; 'FAILED'; 'DISABLED'; 'COMPLETE';    'DEPRECATED'; 'OTHER' ; 'DELETED",
+            "description": "One of the status values from a list of valid values.",
+            "style": "Valid Value",
+            "min_cardinality": 1,
+            "level": "Advanced"
+          }
+        },
+        {
+          "Metadata Element Subtype Names": {
+            "variable_name": "metadata_element_subtype_names",
+            "attr_labels": "",
+            "description": "Filter results by the list of metadata elements. If none are provided, then no status filtering will be performed.",
+            "style": "Simple List"
+          }
+        },
+        {
+          "Metadata Element Type Name": {
+            "variable_name": "metadata_element_type_name",
+            "attr_labels": "",
+            "description": "Optionally filter results by the type of metadata element."
+          }
+        },
+        {
+          "Skip Relationshjps": {
+            "variable_name": "skip_relationships",
+            "attr_labels": "",
+            "description": "Allow listed relationships to be skipped in the output returned.",
+            "style": "Simple List",
+            "level": "Advanced"
+          }
+        },
+        {
+          "Include Only Relationships": {
+            "variable_name": "include_only_relationships",
+            "attr_labels": "",
+            "description": "Include information only about specified relationships.",
+            "style": "Simple List",
+            "level": "Advanced"
+          }
+        },
+        {
+          "Skip Classified Elements": {
+            "variable_name": "skip_classified_elements",
+            "attr_labels": "",
+            "description": "Skip elements with the any of the specified classifications.",
+            "style": "Simple List"
+          }
+        },
+        {
+          "Include Only Classified Elements": {
+            "variable_name": "include_only_classified_elements",
+            "attr_labels": "",
+            "description": "Include only elements with the specified classifications.",
+            "style": "Simple List"
+          }
+        },
+        {
+          "Governance Zone Filter": {
+            "variable_name": "governance_zone_filter",
+            "attr_labels": "",
+            "description": "Include only elements in one of the specified governance zones.",
+            "style": "Simple List",
+            "level": "Advanced"
+          }
+        },
+        {
+          "Graph Query Depth": {
+            "variable_name": "graph_query_depth",
+            "attr_labels": "",
+            "default_value": "1",
+            "description": "The depth of the hierarchy to return. Default is 5. Specifying 0 returns only the top level attributes. ",
+            "style": "Simple Int",
+            "level": "Advanced"
+          }
+        },
+        {
+          "AsOfTime": {
+            "variable_name": "as_of_time",
+            "attr_labels": "As Of Time",
+            "description": "An ISO-8601 string representing the time to view the state of the repository.",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Sort Order": {
+            "variable_name": "sort_order",
+            "inUpdate": false,
+            "attr_labels": "",
+            "examples": "LAST_UPDATE_RECENT",
+            "valid_values": "ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING",
+            "description": "How to order the results. The sort order can be selected from a list of valid value.",
+            "style": "Valid Value"
+          }
+        },
+        {
+          "Order Property Name": {
+            "variable_name": "order_property_name",
+            "inUpdate": false,
+            "attr_labels": "",
+            "existing_element": "order_property_name",
+            "description": "The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING"
+          }
+        },
+        {
+          "Page Size": {
+            "variable_name": "page_size",
+            "attr_labels": "",
+            "default_value": "0",
+            "description": "The number of elements returned per page.",
+            "style": "Simple Int"
+          }
+        },
+        {
+          "Start From": {
+            "variable_name": "start_from",
+            "attr_labels": "",
+            "default_value": "0",
+            "description": "When paging through results, the starting point of the results to return.",
+            "style": "Simple Int"
+          }
+        }
+      ]
+    }
+  }
+}

md_processing/data/commands/commands_glossary.json

@@ -0,0 +1,218 @@
+{
+  "Command Specifications": {
+    "Create Glossary": {
+      "display_name": "Glossary",
+      "qn_prefix": "Glossary",
+      "family": "Glossary",
+      "description": "A grouping of definitions.",
+      "verb": "Create",
+      "find_method": "CollectionManager.find_collections",
+      "find_constraints": "{\"metadata_element_subtypes\": [\"Glossary\"]}",
+      "Attributes": [
+        {
+          "Display Name": {
+            "variable_name": "display_name",
+            "attr_labels": "Glossary; Glossary Name",
+            "description": "The name of the glossary to create or update.",
+            "style": "ID",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Description": {
+            "variable_name": "description",
+            "attr_labels": "",
+            "description": "A description of the Glossary."
+          }
+        },
+        {
+          "Language": {
+            "variable_name": "language",
+            "attr_labels": "",
+            "examples": "English",
+            "description": "The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details."
+          }
+        },
+        {
+          "Usage": {
+            "variable_name": "",
+            "attr_labels": "",
+            "examples": "usage",
+            "description": "A description of how the glossary is to be used."
+          }
+        }
+      ]
+    },
+    "Create Glossary Term": {
+      "display_name": "Glossary Term",
+      "qn_prefix": "Term",
+      "alternate_names": "Term",
+      "family": "Glossary",
+      "description": "",
+      "verb": "Create",
+      "upsert": false,
+      "find_method": "GlossaryManager.find_glossary_terms",
+      "Attributes": [
+        {
+          "Display Name": {
+            "variable_name": "term_name",
+            "attr_labels": "Glossary Term ; Name; Term Name; Term",
+            "description": "The name of the term to create or update.",
+            "style": "ID",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Glossary": {
+            "variable_name": "glossary_name",
+            "attr_labels": "Glossaries; Glossary Name; Glossary Collection; Owning Glossary",
+            "existing_element": "Glossary Collection",
+            "description": "Zeroor more existing glossaries that a term is a member of.",
+            "style": "Reference Name"
+          }
+        },
+        {
+          "Summary": {
+            "variable_name": "summary",
+            "attr_labels": "",
+            "description": "A summary description of the term."
+          }
+        },
+        {
+          "Description": {
+            "variable_name": "description",
+            "attr_labels": "",
+            "description": "A description of the term."
+          }
+        },
+        {
+          "Folders": {
+            "variable_name": "folders",
+            "attr_labels": "Folder",
+            "existing_element": "Folder Collection",
+            "description": "Exixting folder collections that you'd like to make the term a member of.",
+            "style": "Reference Name List"
+          }
+        },
+        {
+          "Abbreviation": {
+            "variable_name": "abbreviation",
+            "attr_labels": "",
+            "examples": "CO2",
+            "description": "An abbreviation for the term."
+          }
+        },
+        {
+          "Example": {
+            "variable_name": "example",
+            "attr_labels": "",
+            "description": "An example of how the term is used."
+          }
+        },
+        {
+          "Usage": {
+            "variable_name": "usage",
+            "attr_labels": "",
+            "examples": "usage",
+            "description": "A description of how the term is to be used."
+          }
+        }
+      ]
+    },
+    "Link Term-Term Relationship": {
+      "display_name": "Term-Term Relationship",
+      "qn_prefix": "",
+      "alternate_names": "Terms",
+      "family": "Glossary",
+      "description": "Create a relationship between terms.",
+      "verb": "Link",
+      "upsert": false,
+      "attach": true,
+      "find_method": "",
+      "Attributes": [
+        {
+          "Term 1": {
+            "variable_name": "term_1",
+            "attr_labels": "Term Name 1; Term1",
+            "description": "The name of the first term term to connect.",
+            "style": "ID",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Term 2": {
+            "variable_name": "term_2",
+            "attr_labels": "Term Name 2; Term2",
+            "description": "The name of the second term term to connect.",
+            "style": "ID",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Relationship": {
+            "variable_name": "relationship",
+            "attr_labels": "",
+            "valid_values": "Synonym;  Translation;  PreferredTerm; TermISATYPEOFRelationship;  TermTYPEDBYRelationship;  Antonym; ReplacementTerm;  ValidValue; TermHASARelationship; RelatedTerm;   ISARelationship",
+            "description": "The type of relationship to connecting the two terms.",
+            "style": "Valid Value",
+            "input_required": true,
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Description": {
+            "variable_name": "description",
+            "attr_labels": "",
+            "description": "A description of the Relationship."
+          }
+        },
+        {
+          "Expression": {
+            "variable_name": "expression",
+            "attr_labels": "",
+            "description": "An expression describing the relationship.",
+            "min_cardinality": 1,
+            "level": "Advance"
+          }
+        },
+        {
+          "Confidence": {
+            "variable_name": "confidence",
+            "attr_labels": "",
+            "description": "Percent confidence in the relationship.",
+            "style": "Simple Int",
+            "level": "Advanced"
+          }
+        },
+        {
+          "Status": {
+            "variable_name": "",
+            "attr_labels": "",
+            "description": "",
+            "min_cardinality": 1
+          }
+        },
+        {
+          "Steward": {
+            "variable_name": "steward",
+            "attr_labels": "",
+            "description": "Steward responsible.",
+            "level": "Advance"
+          }
+        },
+        {
+          "Source": {
+            "variable_name": "source",
+            "attr_labels": "",
+            "description": "Source of the relationship",
+            "level": "Advance"
+          }
+        }
+      ]
+    }
+  }
+}