From a5ffe74d24457614e812549e054f017310b35c97 Mon Sep 17 00:00:00 2001 From: Aravind Kumar Date: Mon, 8 Sep 2025 19:36:58 +0530 Subject: [PATCH 1/7] Delete secrets-scan.yml --- .github/workflows/secrets-scan.yml | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 .github/workflows/secrets-scan.yml diff --git a/.github/workflows/secrets-scan.yml b/.github/workflows/secrets-scan.yml deleted file mode 100644 index 049c02f..0000000 --- a/.github/workflows/secrets-scan.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: Secrets Scan -on: - pull_request: - types: [opened, synchronize, reopened] -jobs: - security-secrets: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: '2' - ref: '${{ github.event.pull_request.head.ref }}' - - run: | - git reset --soft HEAD~1 - - name: Install Talisman - run: | - # Download Talisman - wget https://github.com/thoughtworks/talisman/releases/download/v1.37.0/talisman_linux_amd64 -O talisman - - # Checksum verification - checksum=$(sha256sum ./talisman | awk '{print $1}') - if [ "$checksum" != "8e0ae8bb7b160bf10c4fa1448beb04a32a35e63505b3dddff74a092bccaaa7e4" ]; then exit 1; fi - - # Make it executable - chmod +x talisman - - name: Run talisman - run: | - # Run Talisman with the pre-commit hook - ./talisman --githook pre-commit \ No newline at end of file From ab59006300976773d8a3b6e14e0519d83492b40c Mon Sep 17 00:00:00 2001 From: Aravind Kumar Date: Mon, 8 Sep 2025 19:37:03 +0530 Subject: [PATCH 2/7] Updated codeowners --- CODEOWNERS | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 1be7e0d..9d29d2a 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1 +1,5 @@ -* @contentstack/security-admin +* @contentstack/dx-pr-reviewers + +.github/workflows/policy-scan.yml @contentstack/security-admin + +.github/workflows/issues-jira.yml @contentstack/security-admin From afa049a6439ede5733b8399048714f581a9a033a Mon Sep 17 00:00:00 2001 From: romydias21 Date: Wed, 4 Mar 2026 15:44:54 +0530 Subject: [PATCH 3/7] Updated README --- README.md | 139 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 73 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 4fe3c4c..ef58f7c 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,84 @@ + src="https://images.contentstack.io/v3/assets/blt2d43f51baca745a8/blt2c341bd633887e37/Contentstack-LogoLockup-AmethystShadowHeavy-RGB.png" />
-

Contentstack provides OpenAPI files for its Content Delivery and Content Management REST APIs. These files are in - JSON format. Using these JSON files, you can automatically generate API documentation, test API, and do a lot more. +

+Contentstack provides OpenAPI files for its Content Delivery and Content Management APIs in JSON format. These files allow you to automatically generate API documentation, test requests, and streamline your development workflow. +

+

+This tutorial walks you through how to use these JSON files with Swagger Editor to interact with Contentstack’s APIs.

-

This tutorial will walk you through the process of using Contentstack APIs (Content Delivery and Content Management - APIs) with Swagger.


Content Delivery API (CDA)

-

Version: 3.0.0 [Download]

-

Last Updated: Feb 06, 2023

-

Note: To use the latest version, download - the CDA file on your system.

-

To use Contentstack Content Delivery API (CDA) with Swagger, perform the following steps:

+ + +

+To use CDA with Swagger, follow these steps: +

    -
  1. Download - the CDA file and go to the Swagger Editor.
    2. -
  2. On the “Swagger Editor” page, click on File, and select the Import file option. -
    3. + +
  3. Download the latest CDA JSON file and navigate to Swagger Editor.
    4. + +
  4. Click File on top-right and select Import File to upload the JSON.
    5. + +
  5. Open any API request and click the Try it out button to unlock the parameter fields.
    6. + +
  6. Enter your stack's values or use the default demo stack credentials.
    7. + +
  7. Click Execute.
-

Alternatively, if you want to use the Import URL option, you can upload the CDA - file as an asset in Contentstack, and then paste the asset’s URL in the prompt.

-
    -
  1. Open any API request and click on the Try it out button. Clicking this button will unlock the - fields, so you can either run the API request on our demo stack or can use your own values.
    2. -
  2. Click on Execute.
    3. -

-

In the Responses section, you can see the following details:

+

+The Responses section will display the following: +

    -
  • API request in CURL format
    • -
  • Response body
    • -
  • Status code
    • -

-

Content Management API

-

Version: 3.0.0 [Download]

-

Last Updated: Feb 06, 2023

-

Note: To use the latest version, download - the CMA file on your system.

-

To use Contentstack Content Management API (CMA) with Swagger, perform the following steps:

+ +
  • The API request in cURL format.
    • + +
  • The response body (JSON).
    • + +
  • The HTTP status code.
    • + +

    +Note: To ensure you are testing against the most accurate environment, always download the latest CDA file from the Contentstack documentation site. +

    +

    Content Management API (CMA)

    + + +

    +To use CDA with Swagger, follow these steps: +

      -
    1. Download - the CMA file and go to the Swagger Editor.
      2. -
    2. On the “Swagger Editor” page, click on File, and select the Import file option. -
      3. -
    3. Alternatively, you can upload the CMA - file as an asset in Contentstack. Then, you can use the Import URL option and paste the - asset’s URL in the prompt.
      4. -
    4. To run any API request for CMA, make sure you have either the Management token or Auth token in hand.
        -
      1. To use a management token, refer to the Generate Management token guide.
        2. -
      2. To use Auth token, run the Login API request, located under the User Session - section.
        3. -
      -
      5. -
    5. Open any API request and click on the Try it out button. Clicking this button will unlock the - fields for you to use your enter the values.
      6. -
    6. Click Execute.
      7. -

    -

    In the Responses section, you can see the following details:

    + +
  • Download the latest CMA JSON file and navigate to Swagger Editor.
    • + +
  • Click File on top-right and select Import File to upload the JSON.
    • + +
  • Before running a request, ensure you have an authentication method ready:
    • + +
  • Management Token: We recommend using a management token for CMA requests. Refer to the Generate Management Token guide for details.
    • + +
  • Authtoken: Run the Log in API request under the User Session section to retrieve an authtoken in the response.
    • + +
  • Open any API request and click the Try it out button to unlock the parameter fields.
    • + +
  • Enter your stack's values or use the default demo stack credentials.
    • + +
  • Click Execute.
    • + +

    +The Responses section will display the following: +

      -
    • API request in CURL format
      • -
    • Response body
      • -
    • Status code
      • + +
    • The API request in cURL format.
      • + +
    • The response body (JSON).
      • + +
    • The HTTP status code.
    -

    Points to note:

    +

    +Note: +

      -
    • We recommend using the Management token for executing CMA requests rather than Auth token.
      • -
    • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger. In such scenarios, - refer to the documentation link provided in the call for more details.
      • -

    \ No newline at end of file + +
  • We recommend using the Management token for executing CMA requests rather than authtoken.
    • + +
  • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger.
    • Date: Wed, 4 Mar 2026 15:53:59 +0530 Subject: [PATCH 4/7] Updated MIT license to include 2026 date. --- LICENSE | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 4ae8271..e0e3bd2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022-2025 Contentstack +Copyright (c) 2022-2026 Contentstack Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. From 1afb086bbe351f5e905756cbd67cde2ddd2dea44 Mon Sep 17 00:00:00 2001 From: romydias21 Date: Wed, 4 Mar 2026 16:08:54 +0530 Subject: [PATCH 5/7] Update logo and add heading in README Updated logo source and added a heading for the Contentstack OpenAPI. --- README.md | 141 ++++++++++++++++++++++++++---------------------------- 1 file changed, 67 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index ef58f7c..e034258 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,77 @@ -
    -

    -Contentstack provides OpenAPI files for its Content Delivery and Content Management APIs in JSON format. These files allow you to automatically generate API documentation, test requests, and streamline your development workflow. -

    -

    -This tutorial walks you through how to use these JSON files with Swagger Editor to interact with Contentstack’s APIs. + src="https://images.contentstack.io/v3/assets/blt2d43f51baca745a8/bltddc0acd6b98c881c/Contentstack-Logo" width="100" height="100"> +

    Contentstack CDA/CMA OpenAPI

    +

    Contentstack provides OpenAPI files for its Content Delivery and Content Management REST APIs. These files are in + JSON format. Using these JSON files, you can automatically generate API documentation, test API, and do a lot more.

    +

    This tutorial will walk you through the process of using Contentstack APIs (Content Delivery and Content Management + APIs) with Swagger.


    Content Delivery API (CDA)

    - - -

    -To use CDA with Swagger, follow these steps: -

    +

    Version: 3.0.0 [Download]

    +

    Last Updated: Feb 06, 2023

    +

    Note: To use the latest version, download + the CDA file on your system.

    +

    To use Contentstack Content Delivery API (CDA) with Swagger, perform the following steps:

      - -
    1. Download the latest CDA JSON file and navigate to Swagger Editor.
      2. - -
    2. Click File on top-right and select Import File to upload the JSON.
      3. - -
    3. Open any API request and click the Try it out button to unlock the parameter fields.
      4. - -
    4. Enter your stack's values or use the default demo stack credentials.
      5. - -
    5. Click Execute.
      6. +
    6. Download + the CDA file and go to the Swagger Editor.
      7. +
    7. On the “Swagger Editor” page, click on File, and select the Import file option. +
    -

    -The Responses section will display the following: -

    +

    Alternatively, if you want to use the Import URL option, you can upload the CDA + file as an asset in Contentstack, and then paste the asset’s URL in the prompt.

    +
      +
    1. Open any API request and click on the Try it out button. Clicking this button will unlock the + fields, so you can either run the API request on our demo stack or can use your own values.
      2. +
    2. Click on Execute.
      3. +

    +

    In the Responses section, you can see the following details:

      - -
    • The API request in cURL format.
      • - -
    • The response body (JSON).
      • - -
    • The HTTP status code.
      • -
    -

    -Note: To ensure you are testing against the most accurate environment, always download the latest CDA file from the Contentstack documentation site. -

    -

    Content Management API (CMA)

    - - -

    -To use CDA with Swagger, follow these steps: -

    +
  • API request in CURL format
    • +
  • Response body
    • +
  • Status code
    • +
    +

    Content Management API

    +

    Version: 3.0.0 [Download]

    +

    Last Updated: Feb 06, 2023

    +

    Note: To use the latest version, download + the CMA file on your system.

    +

    To use Contentstack Content Management API (CMA) with Swagger, perform the following steps:

      - -
    1. Download the latest CMA JSON file and navigate to Swagger Editor.
      2. - -
    2. Click File on top-right and select Import File to upload the JSON.
      3. - -
    3. Before running a request, ensure you have an authentication method ready:
      4. - -
    4. Management Token: We recommend using a management token for CMA requests. Refer to the Generate Management Token guide for details.
      5. - -
    5. Authtoken: Run the Log in API request under the User Session section to retrieve an authtoken in the response.
      6. - -
    6. Open any API request and click the Try it out button to unlock the parameter fields.
      7. - -
    7. Enter your stack's values or use the default demo stack credentials.
      8. - -
    8. Click Execute.
      9. -
    -

    -The Responses section will display the following: -

    +
  • Download + the CMA file and go to the Swagger Editor.
    • +
  • On the “Swagger Editor” page, click on File, and select the Import file option. +
    • +
  • Alternatively, you can upload the CMA + file as an asset in Contentstack. Then, you can use the Import URL option and paste the + asset’s URL in the prompt.
    • +
  • To run any API request for CMA, make sure you have either the Management token or Auth token in hand.
      +
    1. To use a management token, refer to the Generate Management token guide.
      2. +
    2. To use Auth token, run the Login API request, located under the User Session + section.
      3. +
    +
    • +
  • Open any API request and click on the Try it out button. Clicking this button will unlock the + fields for you to use your enter the values.
    • +
  • Click Execute.
    • +
    +

    In the Responses section, you can see the following details:

      - -
    • The API request in cURL format.
      • - -
    • The response body (JSON).
      • - -
    • The HTTP status code.
      • +
    • API request in CURL format
      • +
    • Response body
      • +
    • Status code
    -

    -Note: -

    +

    Points to note:

      - -
    • We recommend using the Management token for executing CMA requests rather than authtoken.
      • - -
    • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger.
    We recommend using the Management token for executing CMA requests rather than Auth token. +
  • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger. In such scenarios, + refer to the documentation link provided in the call for more details.
    • +
    From 240ba015bc3acb71b924a71f4b6c41d54408b6ca Mon Sep 17 00:00:00 2001 From: romydias21 Date: Wed, 4 Mar 2026 16:17:24 +0530 Subject: [PATCH 6/7] Change logo dimensions in README Updated logo size in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e034258..bbe89b5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ + src="https://images.contentstack.io/v3/assets/blt2d43f51baca745a8/bltddc0acd6b98c881c/Contentstack-Logo" width="70" height="75">

    Contentstack CDA/CMA OpenAPI

    Contentstack provides OpenAPI files for its Content Delivery and Content Management REST APIs. These files are in JSON format. Using these JSON files, you can automatically generate API documentation, test API, and do a lot more. From cab7e11c70c8ec8523a38b8c2da6f640c0ec4009 Mon Sep 17 00:00:00 2001 From: romydias21 Date: Wed, 4 Mar 2026 16:26:32 +0530 Subject: [PATCH 7/7] Revise README for improved API usage instructions Updated README to enhance clarity and provide detailed instructions for using Contentstack APIs with Swagger. --- README.md | 138 +++++++++++++++++++++++++++++------------------------- 1 file changed, 73 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index bbe89b5..b41ff9d 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,85 @@

    Contentstack CDA/CMA OpenAPI

    -

    Contentstack provides OpenAPI files for its Content Delivery and Content Management REST APIs. These files are in - JSON format. Using these JSON files, you can automatically generate API documentation, test API, and do a lot more. + +

    +Contentstack provides OpenAPI files for its Content Delivery and Content Management APIs in JSON format. These files allow you to automatically generate API documentation, test requests, and streamline your development workflow. +

    +

    +This tutorial walks you through how to use these JSON files with Swagger Editor to interact with Contentstack’s APIs.

    -

    This tutorial will walk you through the process of using Contentstack APIs (Content Delivery and Content Management - APIs) with Swagger.


    Content Delivery API (CDA)

    -

    Version: 3.0.0 [Download]

    -

    Last Updated: Feb 06, 2023

    -

    Note: To use the latest version, download - the CDA file on your system.

    -

    To use Contentstack Content Delivery API (CDA) with Swagger, perform the following steps:

    + + +

    +To use CDA with Swagger, follow these steps: +

      -
    1. Download - the CDA file and go to the Swagger Editor.
      2. -
    2. On the “Swagger Editor” page, click on File, and select the Import file option. -
      3. + +
    3. Download the latest CDA JSON file and navigate to Swagger Editor.
      4. + +
    4. Click File on top-right and select Import File to upload the JSON.
      5. + +
    5. Open any API request and click the Try it out button to unlock the parameter fields.
      6. + +
    6. Enter your stack's values or use the default demo stack credentials.
      7. + +
    7. Click Execute.
    -

    Alternatively, if you want to use the Import URL option, you can upload the CDA - file as an asset in Contentstack, and then paste the asset’s URL in the prompt.

    -
      -
    1. Open any API request and click on the Try it out button. Clicking this button will unlock the - fields, so you can either run the API request on our demo stack or can use your own values.
      2. -
    2. Click on Execute.
      3. -

    -

    In the Responses section, you can see the following details:

    +

    +The Responses section will display the following: +

      -
    • API request in CURL format
      • -
    • Response body
      • -
    • Status code
      • -

    -

    Content Management API

    -

    Version: 3.0.0 [Download]

    -

    Last Updated: Feb 06, 2023

    -

    Note: To use the latest version, download - the CMA file on your system.

    -

    To use Contentstack Content Management API (CMA) with Swagger, perform the following steps:

    + +
  • The API request in cURL format.
    • + +
  • The response body (JSON).
    • + +
  • The HTTP status code.
    • + +

    +Note: To ensure you are testing against the most accurate environment, always download the latest CDA file from the Contentstack documentation site. +

    +

    Content Management API (CMA)

    + + +

    +To use CDA with Swagger, follow these steps: +

      -
    1. Download - the CMA file and go to the Swagger Editor.
      2. -
    2. On the “Swagger Editor” page, click on File, and select the Import file option. -
      3. -
    3. Alternatively, you can upload the CMA - file as an asset in Contentstack. Then, you can use the Import URL option and paste the - asset’s URL in the prompt.
      4. -
    4. To run any API request for CMA, make sure you have either the Management token or Auth token in hand.
        -
      1. To use a management token, refer to the Generate Management token guide.
        2. -
      2. To use Auth token, run the Login API request, located under the User Session - section.
        3. -
      -
      5. -
    5. Open any API request and click on the Try it out button. Clicking this button will unlock the - fields for you to use your enter the values.
      6. -
    6. Click Execute.
      7. -

    -

    In the Responses section, you can see the following details:

    + +
  • Download the latest CMA JSON file and navigate to Swagger Editor.
    • + +
  • Click File on top-right and select Import File to upload the JSON.
    • + +
  • Before running a request, ensure you have an authentication method ready:
    • + +
  • Management Token: We recommend using a management token for CMA requests. Refer to the Generate Management Token guide for details.
    • + +
  • Authtoken: Run the Log in API request under the User Session section to retrieve an authtoken in the response.
    • + +
  • Open any API request and click the Try it out button to unlock the parameter fields.
    • + +
  • Enter your stack's values or use the default demo stack credentials.
    • + +
  • Click Execute.
    • + +

    +The Responses section will display the following: +

      -
    • API request in CURL format
      • -
    • Response body
      • -
    • Status code
      • + +
    • The API request in cURL format.
      • + +
    • The response body (JSON).
      • + +
    • The HTTP status code.
    -

    Points to note:

    +

    +Note: +

      -
    • We recommend using the Management token for executing CMA requests rather than Auth token.
      • -
    • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger. In such scenarios, - refer to the documentation link provided in the call for more details.
      • -

    + +
  • We recommend using the Management token for executing CMA requests rather than authtoken.
    • + +
  • For any DELETE request that has a request body in it, you won’t be able to run it in Swagger.