action openlinksw_describe_action {
  label: "Describe action"
  description: "Returns a description of a given service action."
  provider: openlinksw
  method: GET
  path: "/api/v1/actions/{serviceId}/{actionId}"
  encoding: json
  input: {
    type: "object"
    properties: {
      actionId: {
        type: "string"
      }
      serviceId: {
        type: "string"
      }
    }
    required: ["actionId", "serviceId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["api", "method", "response", "status"]
    properties: {
      api: {
        type: "string"
        description: "The path of the REST API method"
      }
      method: {
        type: "string"
        description: "The name of the REST API method"
      }
      response: {
        type: "object"
        required: ["action_id", "entry_point"]
        properties: {
          action_id: {
            type: "string"
            description: "A unique one word identifier for the action."
          }
          description: {
            type: "string"
            description: "A short description of the action."
          }
          entry_point: {
            type: "object"
            required: ["content_types", "description", "encoding_types", "http_method", "name", "parameters", "url", "url_template"]
            properties: {
              content_types: {
                type: "array"
                description: "The supported MIME type(s) for an EntryPoint response."
                items: {
                  type: "string"
                }
              }
              description: {
                type: "string"
                description: "A short description of the action. Optional - may be null."
              }
              encoding_types: {
                type: "array"
                description: "The supported MIME type(s) for an EntryPoint request. Null if not applicable."
                items: {
                  type: "string"
                }
              }
              http_method: {
                type: "string"
                description: "The HTTP method used by the EntryPoint."
                enum: ["GET", "PUT", "POST", "DELETE"]
              }
              name: {
                type: "string"
                description: "A word or short phrase to be used as the action's display name. Optional - may be null."
              }
              parameters: {
                type: "array"
                description: "Descriptions of the EntryPoint parameters. Null if not applicable."
                items: {
                  type: "object"
                  required: ["parameter_name", "display_name", "description", "type", "required", "permitted_values"]
                  properties: {
                    description: {
                      type: "string"
                      description: "A short description of the parameter for use in the OSDB Action Console. Optional - may be null."
                    }
                    display_name: {
                      type: "string"
                      description: "The parameter's display name in the OSDB Action Console. Optional - may be null."
                    }
                    parameter_name: {
                      type: "string"
                      description: "The parameter name as present in the HTTP request. e.g. the key name in a query string key-value pair."
                    }
                    permitted_values: {
                      type: "array"
                      description: "If the parameter accepts only a limited set of values, the allowed set of values. Null if not applicable."
                      items: {
                        type: "string"
                      }
                    }
                    required: {
                      type: "integer"
                      format: "int32"
                      description: "A flag indicating if the parameter is optional."
                    }
                    type: {
                      type: "string"
                      description: "The type of the parameter, indicating its location in the HTTP request."
                      enum: ["query", "header", "uri", "path", "body"]
                    }
                  }
                }
              }
              url: {
                type: "string"
                format: "uri"
                description: "The EntryPoint URL. It will be non-null if url_template is null."
              }
              url_template: {
                type: "string"
                format: "uri-template"
                description: "The EntryPoint's URL template. Only required if the entry point URL is parameterized. Property 'url' will be null if url_template is non-null."
              }
            }
          }
        }
      }
      status: {
        type: "string"
        enum: ["success"]
      }
    }
  }
}