Commit Graph

107 Commits (3dba3f74f9df854498b2922d407f298776438b9e)

Author SHA1 Message Date
Rich Piazza 31b8892681 doc version fixes 2021-07-13 12:38:01 -04:00
Rich Piazza eaf578ff5c
Merge pull request #521 from oasis-open/fix-custom-markings
Fix custom markings
2021-07-12 16:23:49 -04:00
Michael Chisholm 295037f92c Fix parsing.ipynb to not mention SCOs "inside" observed-data
SDOs anymore.  That is no longer the case in STIX 2.1.
2021-07-12 16:16:29 -04:00
Michael Chisholm 3cee753852 In extensions.ipynb, ran the JSON syntax highlighting cell before
running the other cells, to produce HTML highlighted output cells,
which I think had been the intent.  I forgot and it produced
plain text... oops.
2021-07-11 21:04:38 -04:00
Michael Chisholm 79ceef5100 Fix parsing.ipynb to not use the deprecated "objects" property
of the observed-data SDO.
2021-07-11 20:44:45 -04:00
Michael Chisholm 9f428c5efd Updates to extensions.ipynb:
- Change CS 02 reference to CS 03
- Fix typos
- Remove the extension definition from the first example.
It's not relevant.  Change the explanation to explain the
real reason why that example works: if unregistered toplevel
property extensions are present, the library lets unrecognized
toplevel properties pass.
- Change the explained rationale for registering an extension.
It had described "repetitive instantiation" of an extension, but
I think it was referring to an extension definition, and that is
not what happens.  The benefit of registration is that the library
will know which properties are associated with the extension and
can enforce their requirements.  Changed the commentary to explain
this.
- Fix the custom marking example to not use the @CustomMarking
decorator.  It is no longer used for extension-based custom
markings.  Instead, it just shows a normal extension being
registered and applied to a marking-definition.  The commentary
is changed to explain this too.
2021-07-11 20:16:55 -04:00
Michael Chisholm 92903a4525 Fix the CustomExtension example in the custom.ipynb jupyter
notebook.
2021-07-08 17:48:41 -04:00
Chris Lenk a002c1736d Update guide docs, remove outdated comments 2021-04-14 16:39:56 -04:00
Emmanuelle Vargas-Gonzalez bc053da3c4 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into dev-extensions-proposal 2021-03-31 18:53:02 -04:00
Emmanuelle Vargas-Gonzalez af046beeb5 add new-sdo or new-sro option in CustomObject decorator, add a test, and example in guide 2021-03-31 18:46:37 -04:00
Emmanuelle Vargas-Gonzalez 08d5781f54 add entry on extensions.ipynb, typos, and a couple of fixes for registry module and Marking decorator 2021-03-31 18:11:38 -04:00
Emmanuelle Vargas-Gonzalez 294bd7309e add .serialize(pretty=True) around docs/guide/ to accommodate this change 2021-03-31 13:56:02 -04:00
Emmanuelle Vargas-Gonzalez 72a12e96ba update guide example, conf.py and remove some unused imports 2021-03-01 13:14:03 -05:00
Chris Lenk 4825f5e303 Small touchups 2021-02-19 16:57:15 -05:00
Emmanuelle Vargas-Gonzalez ecf952c07b it updated itself... 2021-02-19 14:50:52 -05:00
Emmanuelle Vargas-Gonzalez 2308528957 add text and example for equivalence.ipynb 2021-02-19 14:48:23 -05:00
Chris Lenk 35f4bb0443 Update the semantic equivalence user guide page
Differentiate between similarity and equivalence, and update functions
to their new names and locations.
2021-02-18 23:45:38 -05:00
Chris Lenk 71889b173f Touch up filesystem docs 2020-12-11 11:28:26 -05:00
Desai, Kartikey H 20a9bb316c Fix #476 2020-12-10 22:10:24 -06:00
Emmanuelle Vargas-Gonzalez 92ab1227ed docstrings, changes to equivalence.ipynb 2020-10-16 17:12:52 -04:00
Emmanuelle Vargas-Gonzalez 6daa9bd8a5 fix internal links to stix2.parsing.rst#stix2.parsing.parse 2020-07-01 11:21:53 -04:00
Emmanuelle Vargas-Gonzalez bc2a6322a9 update ts_support.ipynb 2020-06-30 23:11:59 -04:00
Emmanuelle Vargas-Gonzalez 056bc4de19 update custom.ipynb
update JSON to STIX 2.1
2020-06-30 22:54:40 -04:00
Emmanuelle Vargas-Gonzalez de4ea5b805 edits to parsing.ipynb and workbench.ipynb
Create the warning admonitions correctly
2020-06-30 22:11:29 -04:00
Chris Lenk d5d664ba41 Update docs for 2.1 as default 2020-06-26 16:43:19 -04:00
Chris Lenk d260aa8ebd Tweak custom SCO ID-generating properties docs 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 5df319bcbb Add documentation about id-contributing properties for 2.1 custom SCOs 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 02171996fa Add documentation about _id_contributing_properties for custom SCOs. Will add in code example once PR 354 is merged in 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 47b28d1194 Fixes #323 2020-03-05 00:11:24 -05:00
Michael Chisholm c6b2b6fbfa Change the warning in the jupyter notebook for creating content,
regarding name collisions between method and property names, to
not pick on the Mapping methods specifically.  The problem is
more general than that: stix objects have more methods than those.
Instead of listing them all out, a more general statement is
made, that accessing those attributes will result in a bound
method, not a STIX property value.
2020-02-03 16:51:12 -05:00
Michael Chisholm 1cadeaa1c6 Added a warning to creating.ipynb about Mapping attributes: they
can't be used to access STIX object properties.
2020-01-29 16:01:15 -05:00
Chris Lenk a6fefff33d Fix semantic equivalence documentation 2020-01-07 15:49:06 -05:00
Chris Lenk a9932c09c8 Update Semantic Equivalence documentation 2019-12-23 17:02:21 -05:00
Desai, Kartikey H f6e75cd8f8 Add debug logging messages and add documentation to equivalence.ipynb 2019-12-06 10:46:27 -05:00
Chris Lenk b5612c9dc2 Update semantic equivalence docs
- Comparing object type not in config dictionary now gives a warning and
result of 0 instead of an error.
- Adds an example of the new detailed debug output.
2019-10-16 09:08:03 -04:00
Chris Lenk 39e1ddbbf6 Update semantic equivalence docs 2019-10-14 14:31:44 -04:00
Emmanuelle Vargas-Gonzalez b9927fd4a5 update .ipynb files with correct references. update package requirements 2019-09-30 13:16:06 -04:00
Chris Lenk 47551b8cc1 Add documentation for semantic equivalence 2019-09-25 14:28:24 -04:00
Chris Lenk 401c9ad950
Merge branch 'master' into stix2.1 2019-09-23 12:26:27 -04:00
Desai, Kartikey H 8447c9fcd9 Add few tests to improve some code coverage 2019-09-11 14:21:41 -04:00
Chris Lenk 1a719db40a Add examples to docs for removing properties 2019-07-25 14:22:29 -04:00
Kartikey Desai 1bf12221a0 Update _valid_refs doc and add test to v20 test suite 2019-05-13 09:18:50 -04:00
Kartikey Desai 8946308527 Updated documentation for _valid_refs 2019-05-10 12:30:52 -04:00
Kartikey Desai 989f17e673 Add documentation for _valid_refs 2019-05-10 11:54:59 -04:00
Emmanuelle Vargas-Gonzalez 851ed3e85a marking-definition 2019-05-03 15:41:58 -04:00
Emmanuelle Vargas-Gonzalez 8d842aeb94 update user guide on marking extraction via API 2019-05-03 14:48:16 -04:00
Chris Lenk 0ca2bc087a Fix SDO link in docs 2019-02-06 14:27:33 -05:00
Emmanuelle Vargas-Gonzalez e521e24387 Update the details on technical specification support 2018-10-31 13:39:09 -04:00
Chris Lenk 6613b55a43 Update MemoryStore documentation
...now that MemorySource normalizes its data to python-stix2 objects.
2018-10-23 14:29:56 -04:00
Chris Lenk b70aed0ef7 Make a few word changes in patterning guide 2018-09-10 21:29:08 -04:00