Tags:
create new tag
view all tags

Feature Proposals » manage script to be made program friendly

Summary

Current State: Developer: Reason: Date: Concerns By: Bug Tracking: Proposed For:
UnderInvestigation HideyoImazu None 2020-06-10     LimaRelease

Edit Form

TopicSummary:
CurrentState:
CommittedDeveloper:
ReasonForDecision:
DateOfCommitment:   Format: YYYY-MM-DD
ConcernRaisedBy:
BugTracking:
OutstandingIssues:
RelatedTopics:
InterestedParties:
ProposedFor:
TWikiContributors:
 

Motivation

The manage script may be used from a program -- either via HTTP or by program execution. In that case, it's handy if an operation success/failure can be determined easily by the program.

Description and Documentation

The TWiki::OopsException with the following def values will return "400 bad request" status code.

  • unrecognized_action
  • missing_action
  • notwikiuser
  • in_a_group
  • wrong_password
  • web_missing
  • invalid_web_name
  • no_web_metadata
  • base_web_missing
  • web_exists
  • topic_exists_new_web
  • invalid_web_color
  • web_creation_error
  • not_wikiword
  • delete_err
  • move_err
  • rename_topic_exists
  • web_exists_topic_rename
  • system_web_name
  • rename_web_exists
  • topic_exists_web_rename
  • rename_web_prerequisites
  • rename_err
  • rename_web_err
  • save_error

The TWiki::OopsException with following def values is already returning 4XX status code.

  • post_method_only
  • topic_access

In addition, when the manage script is executed from command line, if it causes 4XX status code, it will exist with 1 status code. Otherwise, it exists with 0. This will make it trivial to determine if the manage script execution succeeded or not.

Examples

Impact

Implementation

-- Contributors: Hideyo Imazu - 2020-06-10

Discussion

Perfect, any improvements that support automation is good!

-- Peter Thoeny - 2020-06-11

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 2020-06-11 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.