Skip to content

Commit

Permalink
Add documentation for VocabStrings. Fix #242.
Browse files Browse the repository at this point in the history
  • Loading branch information
@gtback
gtback committed Apr 24, 2015
1 parent 57ababa commit 1856414
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/api/coverage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,20 +120,20 @@ CybOX Vocabularies
========================================= ======================================== ===========================================================
CybOX Construct API Coverage Documentation
========================================= ======================================== ===========================================================
ActionArgumentNameVocab-1.0 ✓ Full :class:`cybox.core.action.ArgumentName`
ActionArgumentNameVocab-1.0 ✓ Full :class:`cybox.common.vocabs.ActionArgumentName`
ActionNameVocab-1.0 × None *(replaced by version 1.1)*
ActionNameVocab-1.1 ✓ Full :class:`cybox.core.action.ActionName`
ActionObjectAssociationTypeVocab-1.0 ✓ Full :class:`cybox.core.associated_object.AssociationType`
ActionNameVocab-1.1 ✓ Full :class:`cybox.common.vocabs.ActionName`
ActionObjectAssociationTypeVocab-1.0 ✓ Full :class:`cybox.common.vocabs.AssociationType`
ActionRelationshipTypeVocab-1.0 × None
ActionTypeVocab-1.0 ✓ Full :class:`cybox.core.action.ActionType`
CharacterEncodingVocab-1.0 ✓ Full :class:`cybox.common.extracted_string.CharacterEncoding`
ActionTypeVocab-1.0 ✓ Full :class:`cybox.common.vocabs.ActionType`
CharacterEncodingVocab-1.0 ✓ Full :class:`cybox.common.vocabs.CharacterEncoding`
EventTypeVocab-1.0 × None *(replaced by version 1.0.1)*
EventTypeVocab-1.0.1 ✓ Full :class:`cybox.core.event.EventType`
HashNameVocab-1.0 ✓ Full :class:`cybox.common.hashes.HashName`
InformationSourceTypeVocab-1.0 ✓ Full :class:`cybox.common.measuresource.InformationSourceType`
EventTypeVocab-1.0.1 ✓ Full :class:`cybox.common.vocabs.EventType`
HashNameVocab-1.0 ✓ Full :class:`cybox.common.vocabs.HashName`
InformationSourceTypeVocab-1.0 ✓ Full :class:`cybox.common.vocabs.InformationSourceType`
ObjectRelationshipVocab-1.0 × None *(replaced by version 1.1)*
ObjectRelationshipVocab-1.1 ✓ Full :class:`cybox.core.object.Relationship`
ObjectRelationshipVocab-1.1 ✓ Full :class:`cybox.common.vocabs.ObjectRelationship`
ObjectStateVocab-1.0 × None
ToolTypeVocab-1.0 × None *(replaced by version 1.1)*
ToolTypeVocab-1.1 ✓ Full :class:`cybox.common.tools.ToolType`
ToolTypeVocab-1.1 ✓ Full :class:`cybox.common.vocabs.ToolType`
========================================= ======================================== ===========================================================
15 changes: 15 additions & 0 deletions docs/overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,18 @@ that many enumerated values are implemented using the
sure they are valid enumeration values.

.. note:: Not all CybOX types have yet been implemented.

Controlled Vocabulary Strings
-----------------------------

Controlled Vocabulary strings are a concept originally designed for STIX and
adapted for use in CybOX as well. For background, see the `STIX
documentation`_. Controlled Vocabulary strings are implemented in the ``cybox``
Python package very similarly to how they are implemented in the ``stix``
package, so viewing the `python-stix documentation`_ should help explain how to
work with CybOX Controlled Vocabulary strings as well. CybOX vocabularies are
defined in the :mod:`cybox.common.vocabs` module.

.. _STIX documentation: https://stixproject.github.io/documentation/concepts/controlled-vocabularies/
.. _python-stix documentation: https://stix.readthedocs.org/en/latest/examples/index.html#controlled-vocabularies-vocabstring

0 comments on commit 1856414

Please sign in to comment.