Skip to content

Latest commit

 

History

History
66 lines (35 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

66 lines (35 loc) · 3.7 KB
Raw

Contributing to the Postman Collection

This collection is open source and we welcome your contributions!

Contributions usually come in the form of enhancements to Postman files or documentation via pull requests as well as by reporting bugs as issues.

area chart banner

About the repository: This GitHub repository is only used for issue tracking. Use Salesforce Developer's Postman workspace to get the latest versions of the collection and environment files for your own use. The collection and environment files are hosted on Postman and synchronized to this repository for source control. For more information, see the How to Use the Collection section.


Make a Postman pull request

Make your pull requests (PR) for contributions to the collection in the Postman environment, not on this repo!

The basic steps are very similar to making a pull request in Git:

  1. Start in a Postman workspace that is public. You can't make a Postman PR from a private workspace.

    Note that you can move your fork of the Tableau collection from a private workspace to a public one to make a PR and then move it back to your private workspace once the request is merged. For more info, see Using and managing workspaces.

  2. Create a fork of the collection in Postman.

  3. Make additions or other changes (see details in the following section of this page).

  4. Choose Create a pull request using the three dots to the right of the collection name.

  5. Open an issue in this repo describing the enhancement your pull request makes.

For details, see creating a Postman pull request for a fork.


Use environment variables for new or changed methods

This collection uses Postman environment variables to enable each person to customize for their own environment without editing requests. To add or change a method's request to the collection:

  1. Determine whether the existing environment variable file already has a variable for each resource the user will need to make the request.

  2. If you need to add a variable for your collection change, then for each method:

    1. Also fork the environment file.

    2. Add the variable to the environment file list

      Add the variable to the environment file list

      Environment variable names in this collection are simple, lower case, hyphen separated descriptions of the resource they are pointed to.

  3. Create a new request.

  4. Use the appropriate environment variables in the URI and request body of your request.

    For example, for the Create Connected App Secret request, note that the :connected-app-id path parameter uses the value of the connected-app-id environment variable.

    Add tags to data source example

Report or explore issues in Github

Issues are tracked in this GitHub repo.

Use the Issues page of this repo to create or see existing issues with the collection.