Merge pull request #36 from ambitus/gh-pages-dev

Release 1.0b1

_config.yml

@@ -21,7 +21,7 @@ permalink: /:title/
 logo: "/assets/images/logo.png"
 
 # Build settings
-remote_theme: just-the-docs/just-the-docs@main
+remote_theme: just-the-docs/just-the-docs@v0.6.2
 include:
   - contribute.markdown
 color_scheme: dark
@@ -61,6 +61,12 @@ callouts:
   note:
     title: 💡 Note
     color: blue
+  experimental:
+    title: 🚧 Experimental
+    color: red
+  development_status:
+    title: 💻 Development Status
+    color: green
 
 mermaid:
   # Version of mermaid library

access/abstractions/index.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Abstractions
+parent: Access Admin
+has_children: true
+has_toc: false
+---
+
+# Abstractions
+
+Access Administration functions that provide simplified interfaces for atomic tasks.
+{: .fs-6 .fw-300 }

access/standard/delete.md → access/base/delete.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 grand_parent: Access Admin
-parent: Standard
+parent: Base Functions
 ---
 
 # Delete
@@ -28,7 +28,7 @@ Delete a specified **permission**
 
 #### 📥 Parameters
 * `resource`<br>
-  The **resource profile** to delete this permission from.
+  The **general resource profile** to delete this permission from.
 * `class_name`<br>
   The **class** that the specified resource profile belongs to.
 * `auth_id`<br>

access/base/index.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Base Functions
+parent: Access Admin
+has_children: true
+has_toc: false
+---
+
+# Base Functions
+
+Access Administration functions that support all Abstractions and provide interfaces for more complex and nuanced tasks.
+{: .fs-6 .fw-300 }

access/advanced/alter.md → access/base/permit.md

@@ -1,18 +1,18 @@
 ---
 layout: default
 grand_parent: Access Admin
-parent: Advanced
+parent: Base Functions
 ---
 
-# Alter
+# Permit
 
-Create a new permission.
+Create or change a permission
 {: .fs-6 .fw-300 }
 
-## `AccessAdmin.alter()`
+## `AccessAdmin.permit()`
 
 ```python
-def alter(
+def permit(
     self,
     resource: str,
     class_name: str,
@@ -27,17 +27,16 @@ def alter(
 
  
 
-{: .warning }
-> _Alter operations in pyracf require READ access to `IRR.IRRSMO00.PRECHECK` in the `XFACILIT` class_
-> _This function will not produce output unless the user running the command has this access._
+{: .experimental }
+> _Only a subset of available **Traits** are considered **Stable**. See [Traits](../segments_traits_operators#traits) for more details._
 
  
 
-Alter an existing **permission**.
+Create or change a **permission**.
 
 #### 📥 Parameters
 * `resource`<br>
-  The **resource profile** to alter this permission to.
+  The **general resource profile** to permit this permission to.
 * `class`<br>
   The **class** that the specified resource profile belongs to.
 * `auth_id`<br>
@@ -58,10 +57,12 @@ Alter an existing **permission**.
 #### ❌ Raises
 * `SecurityRequestError`<br>
   Raises `SecurityRequestError` when the **Return Code** of a **Security Result** returned by IRRSMO00 is **NOT** equal to `0`.
+* `SegmentTraitError`<br>
+  Raises `SegmentTraitError` when the dictionary of **traits/attributes** provided contains one or more **unknown** traits.
 
 #### 💻 Example
 
-The following example **alters** an existing **permission** for the **z/OS userid** `eswift` to the **resource profile** `testing` in the **class** `elijtest` with one **trait/attribute** as defined in the `traits` dictionary.
+The following example **permits** an existing **permission** for the **z/OS userid** `eswift` to the **general resource profile** `testing` in the **class** `elijtest` with one **trait/attribute** as defined in the `traits` dictionary.
 
 ###### Python Script
 ```python
@@ -72,7 +73,7 @@ traits = {
     "base:access": "NONE",
 }
 
-access_admin.alter("TESTING", "ELIJTEST", "ESWIFT", traits)
+access_admin.permit("TESTING", "ELIJTEST", "ESWIFT", traits=traits)
 ```
 
 ###### Security Result Dictionary as JSON

access/base/segments_traits_operators.md

@@ -0,0 +1,62 @@
+---
+layout: default
+grand_parent: Access Admin
+parent: Base Functions
+---
+
+# Segments, Traits, and Operators
+
+Information about permission `segments` dictionaries, `traits` dictionaries, and `operators`.
+{: .fs-6 .fw-300 }
+
+### Segments
+
+ 
+
+{: .experimental }
+> _Note that just because a **Segment** is considered **Stable** that does not mean that all of the **Traits** in that **Segment** are considered **Stable**. See [Traits](#traits) for more detail._
+
+ 
+
+{: .warning }
+> _There are no additional segments for **Access** administartion._
+> _Also, note that there is no **Profile Extract** function for **Access** administration. Some access information can be extracted using **[`ResourceAdmin.extract()`](../../../resource/base/extract#resourceadminextract)** or **[`DataSetAdmin.extract()`](../../../data_set/base/extract#datasetadminextract)** depending on the type of profile in question._
+
+ 
+
+| **Segment** | **Description** |
+| `Base` | Describes a permission's **Base** attributes. |
+
+### Traits
+
+ 
+
+{: .experimental }
+> _**Traits** that are **NOT** documented below are considered **Experimental**._
+
+ 
+
+{: .note }
+> _Some **Traits** can be set to `False` to delete their existing values._
+
+ 
+
+When using the **[`AccessAdmin.permit()`](../permit#accessadminpermit)** function, the following are valid access traits. Feel free to experiment with any of the other traits defined in `pyracf/access/access_admin.py` in the pyRACF source code.
+
+ 
+
+Traits use the following syntax: `<segment>:<trait>`
+
+&nbsp;
+
+| **Trait** | **Description** | **Valid Types** |
+| `base:access` | Set the **access level** associated with the permission. | `str` |
+
+### Operators
+
+Operators can be prepended to traits using the following syntax: `<operator>:<segment>:<trait>`
+
+&nbsp;
+
+{: .warning }
+> _There are no traits that support operators for **Access** administartion._