Merge pull request #48 from sailpoint-oss/devrel-1991

adding docs

Author: darrell-thobe-sp

.github/workflows/push_sdk_docs_to_dev_portal.yaml

@@ -0,0 +1,84 @@
+name: "Push python SDK Docs to Developer Portal"
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  push_spec_workflow:
+    name: Push API spec changes
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the master branch request to run rsync
+      - name: Checkout PR branch
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+          path: python-sdk
+
+      # Checkout the main branch of the developer portal to push changes
+      - name: Checkout API Specs Repo
+        uses: actions/checkout@v2
+        with:
+          repository: sailpoint-oss/developer.sailpoint.com
+          path: developer-community
+          ref: main
+
+      - name: Install rsync
+        run: |
+          sudo apt install rsync grsync
+
+      - name: Sync files between folders
+        run: |
+          CURRENT_V3_CODE_EXAMPLES_PATH="python-sdk/sailpoint/v3/docs/Examples/python_code_examples_overlay.yaml"
+          NEW_V3_CODE_EXAMPLES_PATH="developer-community/static/code-examples/v3/"
+          CURRENT_V3_SPEC_PATH_METHODS="python-sdk/sailpoint/v3/docs/Methods"
+          NEW_V3_API_SPEC_PATH_METHODS="developer-community/docs/tools/sdk/python/Reference/V3"
+          CURRENT_V3_SPEC_PATH_MODELS="python-sdk/sailpoint/v3/docs/Models"
+          NEW_V3_API_SPEC_PATH_MODELS="developer-community/docs/tools/sdk/python/Reference/V3"
+
+          CURRENT_BETA_CODE_EXAMPLES_PATH="python-sdk/sailpoint/beta/docs/Examples/python_code_examples_overlay.yaml"
+          NEW_BETA_CODE_EXAMPLES_PATH="developer-community/static/code-examples/beta/"
+          CURRENT_BETA_SPEC_PATH_METHODS="python-sdk/sailpoint/beta/docs/Methods"
+          NEW_BETA_API_SPEC_PATH_METHODS="developer-community/docs/tools/sdk/python/Reference/Beta"
+          CURRENT_BETA_SPEC_PATH_MODELS="python-sdk/sailpoint/beta/docs/Models"
+          NEW_BETA_API_SPEC_PATH_MODELS="developer-community/docs/tools/sdk/python/Reference/Beta"
+
+          CURRENT_V2024_CODE_EXAMPLES_PATH="python-sdk/sailpoint/v2024/docs/Examples/python_code_examples_overlay.yaml"
+          NEW_V2024_CODE_EXAMPLES_PATH="developer-community/static/code-examples/v2024/"
+          CURRENT_V2024_SPEC_PATH_METHODS="python-sdk/sailpoint/v2024/docs/Methods"
+          NEW_V2024_API_SPEC_PATH_METHODS="developer-community/docs/tools/sdk/python/Reference/V2024"
+          CURRENT_V2024_SPEC_PATH_MODELS="python-sdk/sailpoint/v2024/docs/Models"
+          NEW_V2024_API_SPEC_PATH_MODELS="developer-community/docs/tools/sdk/python/Reference/V2024"
+
+          rsync -cav --delete $CURRENT_V3_SPEC_PATH_METHODS $NEW_V3_API_SPEC_PATH_METHODS 
+          rsync -cav --delete $CURRENT_BETA_SPEC_PATH_METHODS $NEW_BETA_API_SPEC_PATH_METHODS
+          rsync -cav --delete $CURRENT_V2024_SPEC_PATH_METHODS $NEW_V2024_API_SPEC_PATH_METHODS
+          rsync -cav --delete $CURRENT_V3_SPEC_PATH_MODELS $NEW_V3_API_SPEC_PATH_MODELS
+          rsync -cav --delete $CURRENT_BETA_SPEC_PATH_MODELS $NEW_BETA_API_SPEC_PATH_MODELS
+          rsync -cav --delete $CURRENT_V2024_SPEC_PATH_MODELS $NEW_V2024_API_SPEC_PATH_MODELS
+    
+          rsync -av $CURRENT_V3_CODE_EXAMPLES_PATH $NEW_V3_CODE_EXAMPLES_PATH
+          rsync -av $CURRENT_BETA_CODE_EXAMPLES_PATH $NEW_BETA_CODE_EXAMPLES_PATH
+          rsync -av $CURRENT_V2024_CODE_EXAMPLES_PATH $NEW_V2024_CODE_EXAMPLES_PATH
+
+      - name: Check for changes and commit if any
+        run: |
+          cd developer-community
+          git status
+          if git diff --exit-code; then
+            echo "No changes to commit."
+            exit 0
+          else
+            git config --unset-all http.https://github.com/.extraheader
+            git config --local user.email "devrel-service@sailpoint.com"
+            git config --local user.name "developer-relations-sp"
+            git add .
+            git commit -m "Update to python SDK docs: ${{ github.run_id }}"
+            git status
+            git remote set-url origin https://${{secrets.DEVREL_SERVICE_TOKEN}}@github.com/sailpoint-oss/developer.sailpoint.com.git
+            git remote -v
+            git push
+          fi

.openapi-generator/FILES

@@ -0,0 +1,18 @@
+---
+id: models
+title: Models
+pagination_label: Models
+sidebar_label: Models
+sidebar_position: 3
+sidebar_class_name: models
+keywords: ['python', 'Python', 'sdk', 'models'] 
+slug: /tools/sdk/python/v2024/models
+tags: ['SDK', 'Software Development Kit', 'v2024', 'models']
+---
+
+The Python SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API.
+
+## Key Features
+- Attributes: Describe each attribute, including its name, data type, and whether it's required.
+- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits.
+- Example: Provides a sample of how the API uses the model. 

Index.md

@@ -55,7 +55,7 @@ def get_recommendations(
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RecommendationResponseDto:
-        """Returns a Recommendation Based on Object
+        """Returns Recommendation Based on Object
 
         The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
 
@@ -127,7 +127,7 @@ def get_recommendations_with_http_info(
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[RecommendationResponseDto]:
-        """Returns a Recommendation Based on Object
+        """Returns Recommendation Based on Object
 
         The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
 
@@ -199,7 +199,7 @@ def get_recommendations_without_preload_content(
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Returns a Recommendation Based on Object
+        """Returns Recommendation Based on Object
 
         The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
 
@@ -382,6 +382,7 @@ def get_recommendations_config(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(
@@ -449,6 +450,7 @@ def get_recommendations_config_with_http_info(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(
@@ -516,6 +518,7 @@ def get_recommendations_config_without_preload_content(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(
@@ -645,6 +648,7 @@ def update_recommendations_config(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(
@@ -716,6 +720,7 @@ def update_recommendations_config_with_http_info(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(
@@ -787,6 +792,7 @@ def update_recommendations_config_without_preload_content(
             '400': "ErrorResponseDto",
             '401': "ListAccessModelMetadataAttribute401Response",
             '403': "ErrorResponseDto",
+            '429': "ListAccessModelMetadataAttribute429Response",
             '500': "ErrorResponseDto",
         }
         response_data = self.api_client.call_api(