{
  "openapi" : "3.0.3",
  "info" : {
    "title" : "Postman Generator Attributes",
    "version" : "0.0.1-dev",
    "description" : "Specification contains various ApiBuilder attributes, which are recognized by Postman Collection Generator"
  },
  "components" : {
    "schemas" : {
      "IoPostmanGeneratorAttributesV0ModelsObjectReference" : {
        "description" : "Attribute instructs the generator to add a setup step with the referenced entity creation. This attribute should be attached to the field (that holds an identifier) inside model or to the resource object (that holds operations and a path with an identifier param).",
        "type" : "object",
        "required" : [
          "related_service_namespace",
          "resource_type",
          "operation_method",
          "operation_path",
          "identifier_field"
        ],
        "properties" : {
          "related_service_namespace" : {
            "description" : "ApiBuilder service's namespace, in which a target operation is specified.",
            "type" : "string"
          },
          "resource_type" : {
            "description" : "Resource type, that holds a referenced operation.",
            "type" : "string"
          },
          "operation_method" : {
            "$ref" : "#/components/schemas/IoApibuilderSpecV0EnumsMethod",
            "description" : "Referenced operation method."
          },
          "operation_path" : {
            "description" : "Operation path corresponding with the selected {{operation_method}}.",
            "type" : "string"
          },
          "identifier_field" : {
            "description" : "A field name. When the referenced operation is called, identifier_field is used to extract the corresponding field from the response JSON. If the response JSON is an array, then a value is extracted from the first object.",
            "type" : "string"
          },
          "query_params" : {
            "description" : "Optionally, the specified query params will be used to execute a referenced operation.",
            "type" : "object",
            "additionalProperties" : {
              "type" : "string"
            }
          },
          "delete_operation_path" : {
            "description" : "Optionally, the referenced entity's DELETE operation path can be put here. If specified, the generator will add a cleanup step for the referenced object.",
            "type" : "string"
          }
        }
      },
      "IoPostmanGeneratorAttributesV0ModelsValueSubstitute" : {
        "description" : "Attribute instructs the generator to substitute a field value (when generating examples) with specified value or variable reference. Attribute should be attached to a field inside model.",
        "type" : "object",
        "required" : [
          "substitute"
        ],
        "properties" : {
          "substitute" : {
            "description" : "Value, which will be put into the field marked by this attribute. It may be also a variable reference.",
            "type" : "string"
          }
        }
      },
      "IoPostmanGeneratorAttributesV0ModelsBasicAuth" : {
        "description" : "Attribute instructs the generator to add Basic Auth info to the whole Postman collection. Attribute should be defined on the root level of the ApiBuilder specification",
        "type" : "object",
        "required" : [
          "username",
          "password"
        ],
        "properties" : {
          "username" : {
            "description" : "Specifies the username to be used in Postman Collection auth definition. It may be also a variable reference.",
            "type" : "string"
          },
          "password" : {
            "description" : "Specified the password to be used in Postman Collection auth definition. It may be also a variable reference. Leave this string empty, when only a username is needed.",
            "type" : "string"
          }
        }
      },
      "IoPostmanGeneratorAttributesV0EnumsAttributeName" : {
        "description" : "A set of attribute names, that are recognized by Postman Generator",
        "type" : "string",
        "enum" : [
          "postman-basic-auth",
          "object-reference",
          "value-substitute"
        ]
      },
      "IoApibuilderSpecV0EnumsMethod" : {
        "type" : "string",
        "enum" : [
          "GET",
          "POST",
          "PUT",
          "PATCH",
          "DELETE",
          "HEAD",
          "CONNECT",
          "OPTIONS",
          "TRACE"
        ]
      }
    }
  }
}