/* eslint-disable */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

/**
 * Resource Type definition for AWS::ApiGateway::DocumentationPart
 */
export interface AwsApigatewayDocumentationpart {
  /**
   * The identifier of the documentation Part.
   */
  DocumentationPartId?: string;
  Location: Location;
  /**
   * The documentation content map of the targeted API entity.
   */
  Properties: string;
  /**
   * Identifier of the targeted API entity
   */
  RestApiId: string;
}
/**
 * The location of the API entity that the documentation applies to.
 */
export interface Location {
  /**
   * The HTTP verb of a method.
   */
  Method?: string;
  /**
   * The name of the targeted API entity.
   */
  Name?: string;
  /**
   * The URL path of the target.
   */
  Path?: string;
  /**
   * The HTTP status code of a response.
   */
  StatusCode?: string;
  /**
   * The type of API entity that the documentation content applies to.
   */
  Type?:
    | "API"
    | "AUTHORIZER"
    | "MODEL"
    | "RESOURCE"
    | "METHOD"
    | "PATH_PARAMETER"
    | "QUERY_PARAMETER"
    | "REQUEST_HEADER"
    | "REQUEST_BODY"
    | "RESPONSE"
    | "RESPONSE_HEADER"
    | "RESPONSE_BODY";
}