Platform-specific UI Schema

PUT /1/platform-schemas/{platform}

Request

Base URL
https://developer.geforcenow.com/api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/geforcenow/apis/nvidia-build-management-api/docs/1/platform-schemas/:platform/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

platform'EPIC' | 'STEAM' | 'GOG'

Platform / App store from which the build needs to be pulled

descriptionstring

Details about the platform from which the build is pulled

Example request

{
  "platform": "STEAM",
  "description": "STEAM",
  "fields": [
    {
      "name": "branchName",
      "label": "Branch Name",
      "description": "Name of the branch that contains the build",
      "valueType": "string",
      "inputType": "text",
      "placeholder": "Enter branch name here",
      "maxLength": 50,
      "sortOrder": 10
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "platform": "STEAM",
    "description": "STEAM",
    "fields": [
      {
        "name": "branchName",
        "label": "Branch Name",
        "description": "Name of the branch that contains the build",
        "valueType": "string",
        "inputType": "text",
        "placeholder": "Enter branch name here",
        "maxLength": 50,
        "sortOrder": 10
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.