BasePathMapping

Represents the base path that callers of the API must provide as part of the URL after the domain name.

APIs.ioEngineeringPlatform

Properties

Name Type Description
basePath object
restApiId object
stage object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-basepathmapping-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BasePathMapping",
  "title": "BasePathMapping",
  "type": "object",
  "properties": {
    "basePath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The base path name that callers of the API must provide as part of the URL after the domain name."
        }
      ]
    },
    "restApiId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The string identifier of the associated RestApi."
        }
      ]
    },
    "stage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the associated stage."
        }
      ]
    }
  },
  "description": "Represents the base path that callers of the API must provide as part of the URL after the domain name."
}