AWS CodeCommit Integration

Number of APIs: 2

Introduction

This collection is intended to upload Qodex collections to AWS CodeCommit.

Prerequisites

This collection requires that you have both a Qodex API key ([learn more about the Qodex API here] and get your Qodex API key here) and AWS access keys (learn more about AWS access keys here).

Forking Collections

In order to use this integration, you will need to fork this collection. You can do this by left clicking on a collection and pressing create a fork. You will also need to fork the environment named AWS CodeCommit Integration ([learn more about forking collections and environments here]

Monitors

In the integration, a monitor is used to automatically check to update the changes made to a collection once a day.

In order to make this monitor, input the desired Monitor Name, select the AWS CodeCommit Integration collection as the Collection. Select the AWS CodeCommit environment as the environment and select how often you want it to be run to check if your collection has been updated (we recommend once a day). Then, your monitor should be created ([learn more about creating a monitor here]

Mocks

If you would like to see example responses and run and interact with the collection without having to input valid credentials, you will need to create a mock server. You can do this by left clicking on your forked version of this integration and selecting Mock Collection ([learn more about creating a mock server here]

Then you will also nee to fork the [MOCK] AWS CodeCommit Integration environment. Copy the mock server url and assign it to the environment variable mockUrl. If you run the collection with the mock environment selected, it will show you what a successful request looks so long as you fill out the environment variables with the correct variable type.

Workflow Diagram

Environment Setup

To use this collection, the following environment variables must be defined:

Key	Description
`x-api-key`	Your Qodex API key ([learn more about the Qodex API here] and get your Qodex API key here)
`awsAccessKey`	Your AWS access key (learn more about AWS access keys here)
`awsSecretKey`	Your AWS secret key (learn more about AWS access keys here)
`awsRegion`	The region in which your AWS service is located (e.g.: us-east-1, us-west-2)
`collectionUID`	The UID of your collection (found under the collection details tab)
`repositoryName`	The name of the AWS CodeCommit repository you would like to upload your Qodex collection to
`directory`	The directory in which commits are saved. If left blank, the default directory is set to Qodex Collections
`fileName`	The file name in AWS CodeCommit you would like your uploaded Qodex collection to have, without the .json extension
`branchName`	The name of the AWS CodeCommit branch you would like to upload your Qodex collection to. If no branch is entered, the default branch of the repository is used. If a new repo was created, the default branch is main
`collectionContent`	A serialized version of your Qodex collection (auto-generated by the Get Collection request)
`commitId`	The ID of the commit of your Qodex collection (auto-generated by the Get Branch request)
`filePath`	Autogenerated file path created during request call.
`mode`	Autogenerated string to track deletion/creation.
`isCreated`	Autogenerated boolean value to track if a file has been committed to the repo.

Get Branch POST {{baseUrl}}
Get Collection GET {{baseUrl}}/collections/{{collectionUID}}