postman-collections/README.md

   1 <!--
   2   ============LICENSE_START=======================================================
   3      Copyright (C) 2024 Nordix Foundation.
   4   ================================================================================
   5   Licensed under the Apache License, Version 2.0 (the "License");
   6   you may not use this file except in compliance with the License.
   7   You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11   Unless required by applicable law or agreed to in writing, software
  12   distributed under the License is distributed on an "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   See the License for the specific language governing permissions and
  15   limitations under the License.
  16
  17   SPDX-License-Identifier: Apache-2.0
  18   ============LICENSE_END=========================================================
  19 -->
  20
  21 # Importing and running the CPS postman collections
  22 ## Importing the CPS collections
  23 To import the CPS collections and environment:
  24 1. Create a "Workspace" (or if you have one already you can use that)
  25 2. Click "Import" (or click "File" then "Import")
  26 3. Drag and drop the "postman-collection" folder into the import pop-up
  27 4. The collections and environment should now be imported
  28 5. Set the current environment to "CPS Environment" (usually at the top right. Default is "No Environment") This will provide the necessary variables such as "CPS_HOST" and "CPS_PORT" to allow the requests to be run
  29
  30 ## Running the collections
  31 To run the requests in the collections simply select the request and click send. "Create Schema Set" in "CPS-CORE" requires a file to send the request. Example files are provided: "bookstore.yang" and "bookstore-types.yang" (these files must be zipped before adding them to the request)
  32
  33 ## Notes
  34 When exporting postman collections tabs are used for spacing, so replacing all the tabs is necessary