├── .gitignore ├── LICENSE ├── PostmanCollectionJobTemplate.yml ├── PostmanCollectionResourceTemplate.yml ├── PostmanCollectionStepTemplate.yml ├── README.md ├── genConfig.json ├── playfab.json └── playfabV2.json /.gitignore: -------------------------------------------------------------------------------- 1 | **/*[Tt]estTitleData.json* 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 PlayFab Inc. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /PostmanCollectionJobTemplate.yml: -------------------------------------------------------------------------------- 1 | # JOB LEVEL TEMPLATE: 2 | # Used to build PostmanCollection 3 | # Reusable 4 | # Meant to be run from the single PostmanCollectionTemplate pipeline (default), or 5 | # from a multi-pipeline such as publishing (should specify alternate params) 6 | 7 | parameters: 8 | - name: ApiSpecSource 9 | displayName: ApiSpecSource 10 | type: string 11 | default: -apiSpecGitUrl https://raw.githubusercontent.com/PlayFab/API_Specs/master/ 12 | - name: CommitMessage 13 | displayName: CommitMessage 14 | type: string 15 | default: Automated build from ADO Pipeline 16 | - name: GitDestBranch 17 | displayName: GitDestBranch 18 | type: string 19 | default: doNotCommit 20 | - name: GitJSetupBranch 21 | displayName: GitJSetupBranch 22 | type: string 23 | default: master 24 | - name: GitSdkGenBranch 25 | displayName: GitSdkGenBranch 26 | type: string 27 | default: master 28 | - name: isVersioned 29 | displayName: isVersioned 30 | type: boolean 31 | default: false 32 | - name: SelfTemplateResource 33 | displayName: SelfTemplateResource 34 | type: string 35 | default: self 36 | 37 | jobs: 38 | - job: PostmanCollectionJobTemplate 39 | steps: 40 | - bash: echo PostmanCollectionJobTemplate 41 | - job: PostmanCollectionTemplate 42 | pool: 43 | vmImage: 'windows-latest' 44 | steps: 45 | - template: PostmanCollectionStepTemplate.yml 46 | parameters: 47 | ApiSpecSource: ${{ parameters.ApiSpecSource }} 48 | CommitMessage: ${{ parameters.CommitMessage }} 49 | GitDestBranch: ${{ parameters.GitDestBranch }} 50 | GitJSetupBranch: ${{ parameters.GitJSetupBranch }} 51 | GitSdkGenBranch: ${{ parameters.GitSdkGenBranch }} 52 | isVersioned: ${{ parameters.isVersioned }} 53 | SelfTemplateResource: ${{ parameters.SelfTemplateResource }} 54 | -------------------------------------------------------------------------------- /PostmanCollectionResourceTemplate.yml: -------------------------------------------------------------------------------- 1 | # TOP LEVEL TEMPLATE: 2 | # Can only be used to run the single PostmanCollectionTemplate pipeline. 3 | # Why: Resources can only be defined once. 4 | # This determines the resources available to all "jobs" and "steps" no matter which templates are loaded after this 5 | # If resources is ever defined again, it'll break so badly that the pipeline won't even parse 6 | 7 | resources: 8 | repositories: 9 | - repository: JenkinsSdkSetupScripts 10 | type: github 11 | endpoint: GitHub_PlayFab 12 | name: PlayFab/JenkinsSdkSetupScripts 13 | - repository: API_Specs 14 | type: github 15 | endpoint: GitHub_PlayFab 16 | name: PlayFab/API_Specs 17 | - repository: SdkGenerator 18 | type: github 19 | endpoint: GitHub_PlayFab 20 | name: PlayFab/SdkGenerator 21 | - repository: PostmanCollection 22 | endpoint: GitHub_PlayFab 23 | type: github 24 | name: PlayFab/PostmanCollection 25 | 26 | jobs: 27 | - job: PostmanCollectionResourceTemplate 28 | steps: 29 | - bash: echo PostmanCollectionResourceTemplate 30 | - template: PostmanCollectionJobTemplate.yml 31 | -------------------------------------------------------------------------------- /PostmanCollectionStepTemplate.yml: -------------------------------------------------------------------------------- 1 | # STEPS LEVEL TEMPLATE: 2 | # Used to build PostmanCollection 3 | # Reusable 4 | # Used to "hide" the additional variables specific to this SDK which shouldn't be set from a higher level, or 5 | # shared from a multi-build pipeline like a publish 6 | 7 | parameters: 8 | - name: ApiSpecSource 9 | displayName: ApiSpecSource 10 | type: string 11 | default: -apiSpecGitUrl https://raw.githubusercontent.com/PlayFab/API_Specs/master/ 12 | - name: CommitMessage 13 | displayName: CommitMessage 14 | type: string 15 | default: Automated build from ADO Pipeline 16 | - name: GitDestBranch 17 | displayName: GitDestBranch 18 | type: string 19 | default: doNotCommit 20 | - name: SdkName 21 | displayName: SdkName 22 | type: string 23 | default: PostmanCollection 24 | - name: GitJSetupBranch 25 | displayName: GitJSetupBranch 26 | type: string 27 | default: master 28 | - name: GitSdkGenBranch 29 | displayName: GitSdkGenBranch 30 | type: string 31 | default: master 32 | - name: isVersioned 33 | displayName: isVersioned 34 | type: boolean 35 | default: false 36 | - name: SelfTemplateResource 37 | displayName: SelfTemplateResource 38 | type: string 39 | default: self 40 | 41 | steps: 42 | - checkout: JenkinsSdkSetupScripts 43 | clean: true 44 | path: s 45 | - checkout: API_Specs 46 | clean: true 47 | path: s/API_Specs 48 | - checkout: SdkGenerator 49 | clean: true 50 | path: s/SdkGenerator 51 | - checkout: ${{ parameters.SelfTemplateResource }} 52 | clean: true 53 | submodules: true 54 | path: s/sdks/PostmanCollection 55 | persistCredentials: true 56 | - bash: | 57 | set -e 58 | 59 | echo alias the ADO variables into local variables 60 | ApiSpecSource="${{ parameters.ApiSpecSource }}" 61 | CommitMessage="${{ parameters.CommitMessage }}" 62 | GitDestBranch="${{ parameters.GitDestBranch }}" 63 | SdkName="${{ parameters.SdkName }}" 64 | WORKSPACE=$(pwd -W) 65 | # Hack attempt to get WORKSPACE into a sub-environment 66 | export WORKSPACE="$WORKSPACE" 67 | 68 | echo === load util.sh to find msbuild === 69 | . "$WORKSPACE/JenkinsSdkSetupScripts/JenkinsScripts/Pipeline/util.sh" 70 | 71 | . "$WORKSPACE/JenkinsSdkSetupScripts/JenkinsScripts/Pipeline/testInit.sh" 72 | 73 | cd "$WORKSPACE/SDKGenerator/SDKBuildScripts" 74 | export PF_TEST_TITLE_DATA_JSON="$WORKSPACE\JenkinsSdkSetupScripts\Creds\testTitleData.json" 75 | . ./shared_build.sh 76 | echo todo: at least parse and ensure the json file is valid? 77 | displayName: 'Build/Test/Report' 78 | - task: PublishTestResults@2 79 | inputs: 80 | testResultsFormat: 'JUnit' 81 | testResultsFiles: '*.xml' 82 | testRunTitle: PostmanCollectionTemplate 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PlayFab Postman Collection README 2 | 3 | 4 | ## 1. Overview: 5 | 6 | Postman Collection for PlayFab 7 | 8 | This is the all-inclusinve Postman collection for demonstrating the PlayFab API very quickly and easily from Postman. 9 | 10 | 11 | ## 2. Prerequisites: 12 | 13 | * Users should be very familiar with the topics covered in our [getting started guide](https://api.playfab.com/docs/general-getting-started). 14 | 15 | To connect to the PlayFab service, your machine must be running TLS v1.2 or better. 16 | * For Windows, this means Windows 7 and above 17 | * [Official Microsoft Documentation](https://msdn.microsoft.com/en-us/library/windows/desktop/aa380516%28v=vs.85%29.aspx) 18 | * [Support for SSL/TLS protocols on Windows](http://blogs.msdn.com/b/kaushal/archive/2011/10/02/support-for-ssl-tls-protocols-on-windows.aspx) 19 | 20 | 21 | ## 3. Setup: 22 | 23 | * Download and extract the PostMan collection to {PostmanLocation} 24 | * Load Postman from the Google Chrome App Launcher 25 | * Import {PostmanLocation}/playfab.json into Postman 26 | 27 | 28 | ## 4. Troubleshooting: 29 | 30 | For a complete list of available APIs, check out the [online documentation](http://api.playfab.com/Documentation/). 31 | 32 | #### Contact Us 33 | We love to hear from our developer community! 34 | Do you have ideas on how we can make our products and services better? 35 | 36 | Our Developer Success Team can assist with answering any questions as well as process any feedback you have about PlayFab services. 37 | 38 | [Forums, Support and Knowledge Base](https://community.playfab.com/index.html) 39 | 40 | 41 | ## 5. Copyright and Licensing Information: 42 | 43 | Apache License -- 44 | Version 2.0, January 2004 45 | http://www.apache.org/licenses/ 46 | 47 | Full details available within the LICENSE file. 48 | -------------------------------------------------------------------------------- /genConfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "buildFlags": "requiresoptionalvaluesupport", 4 | "templateFolder": "postman", 5 | "versionKey": "postman" 6 | } 7 | } --------------------------------------------------------------------------------