Resource

Represents an API resource.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id object
parentId object
pathPart object
path object
resourceMethods object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-resource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Resource",
  "title": "Resource",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The resource's identifier."
        }
      ]
    },
    "parentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The parent resource's identifier."
        }
      ]
    },
    "pathPart": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The last path segment for this resource."
        }
      ]
    },
    "path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The full path for this resource."
        }
      ]
    },
    "resourceMethods": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfMethod"
        },
        {
          "description": "Gets an API resource's method of a given HTTP verb."
        }
      ]
    }
  },
  "description": "Represents an API resource."
}