| 1 |
1.1.104 2023-09-30 Released-By: PERLANCAR; Urgency: low |
| 2 |
|
| 3 |
- No spec changes. |
| 4 |
|
| 5 |
- Add FAQ item: where are the metadata stored?. |
| 6 |
|
| 7 |
|
| 8 |
1.1.103 2022-10-21 Released-By: PERLANCAR; Urgency: low |
| 9 |
|
| 10 |
- No spec changes. |
| 11 |
|
| 12 |
- Fix POD formatting. |
| 13 |
|
| 14 |
|
| 15 |
1.1.102 2022-04-22 Released-By: PERLANCAR; Urgency: medium |
| 16 |
|
| 17 |
- In function argument property 'deps' and for dep type 'prog', |
| 18 |
introduce property 'path'. |
| 19 |
|
| 20 |
|
| 21 |
1.1.101 2022-03-20 Released-By: PERLANCAR; Urgency: medium |
| 22 |
|
| 23 |
- Specify that in function argument property 'deps', the dep type |
| 24 |
'prog' can also be a defhash containing properties 'name' and |
| 25 |
'min_version'. |
| 26 |
|
| 27 |
|
| 28 |
1.1.100 2022-01-23 Released-By: PERLANCAR; Urgency: medium; Backward-Incompatible: yes |
| 29 |
|
| 30 |
- [incompatible change] Rename 'title' result metadata property to |
| 31 |
'caption', which is a standard DefHash property. |
| 32 |
|
| 33 |
- [removed] Remove deprecated specification Rinci::Undo. |
| 34 |
|
| 35 |
|
| 36 |
1.1.99 2021-12-09 Released-By: PERLANCAR; Urgency: medium |
| 37 |
|
| 38 |
[Specification] |
| 39 |
|
| 40 |
- Introduce 'title' property in result metadata. |
| 41 |
|
| 42 |
[Others] |
| 43 |
|
| 44 |
- Sort POD headings, fix formatting. |
| 45 |
|
| 46 |
- Tweak Abstract of Rinci::FAQ. |
| 47 |
|
| 48 |
|
| 49 |
1.1.98 2021-01-22 Released-By: PERLANCAR; Urgency: low |
| 50 |
|
| 51 |
- No spec changes. |
| 52 |
|
| 53 |
- Fix wording/formatting. |
| 54 |
|
| 55 |
|
| 56 |
1.1.97 2021-01-22 Released-By: PERLANCAR; Urgency: low |
| 57 |
|
| 58 |
- No spec changes. |
| 59 |
|
| 60 |
- Edit Changes. |
| 61 |
|
| 62 |
|
| 63 |
1.1.96 2021-01-22 Released-By: PERLANCAR; Urgency: medium |
| 64 |
|
| 65 |
- Introduce result metadata properties: content_type, location, |
| 66 |
func_content_type.*. |
| 67 |
|
| 68 |
- Introduce special function argument -content_type_ARGNAME. |
| 69 |
|
| 70 |
|
| 71 |
1.1.95 2020-10-01 Released-By: PERLANCAR; Urgency: low |
| 72 |
|
| 73 |
- No spec changes. |
| 74 |
|
| 75 |
- POD formatting tweak so 'Enveloped result' heading can be referred |
| 76 |
with a POD link. |
| 77 |
|
| 78 |
|
| 79 |
1.1.94 2020-09-23 Released-By: PERLANCAR; Urgency: medium |
| 80 |
|
| 81 |
- Introduce function example's env_result and naked_result |
| 82 |
properties. |
| 83 |
|
| 84 |
|
| 85 |
1.1.93 2019-07-19 Released-By: PERLANCAR; Urgency: low |
| 86 |
|
| 87 |
- No spec changes. |
| 88 |
|
| 89 |
- [pod] Fix link to Sah's 'examples' clause. |
| 90 |
|
| 91 |
|
| 92 |
1.1.92 2019-07-19 Released-By: PERLANCAR; Urgency: low |
| 93 |
|
| 94 |
- No spec changes. |
| 95 |
|
| 96 |
- Expand on function argument's 'examples' property, and mention Sah's |
| 97 |
'examples' clause. |
| 98 |
|
| 99 |
|
| 100 |
1.1.91 2019-05-25 Released-By: PERLANCAR |
| 101 |
|
| 102 |
- Declare the priority of result schema from result metadata to be |
| 103 |
*lower* than schema from function metadata's result property. |
| 104 |
|
| 105 |
|
| 106 |
1.1.90 2019-05-24 Released-By: PERLANCAR |
| 107 |
|
| 108 |
- Introduce result metadata property: schema. |
| 109 |
|
| 110 |
|
| 111 |
1.1.89 2019-04-15 Released-By: PERLANCAR |
| 112 |
|
| 113 |
- No spec changes. |
| 114 |
|
| 115 |
- Replace greedy with slurpy in examples. |
| 116 |
|
| 117 |
|
| 118 |
1.1.88 2019-04-15 Released-By: PERLANCAR |
| 119 |
|
| 120 |
- Introduce argument property 'slurpy' as replacement for 'greedy', |
| 121 |
note that 'greedy' will be removed in Rinci 1.2. |
| 122 |
|
| 123 |
|
| 124 |
1.1.87 2018-11-29 Released-By: PERLANCAR |
| 125 |
|
| 126 |
- Specify function argument 'examples'. |
| 127 |
|
| 128 |
|
| 129 |
1.1.86 2017-12-09 Released-By: PERLANCAR |
| 130 |
|
| 131 |
- [Incompatible change] Revert 1.1.85's change: "Specify that example's |
| 132 |
result must always be in enveloped form, to remove ambiguity and to |
| 133 |
have the ability to specify status." |
| 134 |
|
| 135 |
|
| 136 |
1.1.85 2017-10-26 Released-By: PERLANCAR |
| 137 |
|
| 138 |
- Specify that example's result must always be in enveloped form, to |
| 139 |
remove ambiguity and to have the ability to specify status. [UPDATE |
| 140 |
2017-12-09: reverted in 1.1.86]. |
| 141 |
|
| 142 |
|
| 143 |
1.1.84 2016-12-28 Released-By: PERLANCAR |
| 144 |
|
| 145 |
- No spec changes. |
| 146 |
|
| 147 |
- [dist] Remove spec prereq to Sah::Schemas since Sah::Schema::rinci::* |
| 148 |
have been split to Sah-Schemas-Rinci. |
| 149 |
|
| 150 |
- [dist] Fix expressing spec prereq relationship with x_spec. |
| 151 |
|
| 152 |
|
| 153 |
1.1.83 2016-12-15 Released-By: PERLANCAR |
| 154 |
|
| 155 |
- Specify that dry_run feature can also be a hash, to be able to |
| 156 |
set default dry_run mode. |
| 157 |
|
| 158 |
|
| 159 |
1.1.82 2016-12-10 Released-By: PERLANCAR |
| 160 |
|
| 161 |
- Introduce argument spec property 'index_completion'. |
| 162 |
|
| 163 |
- Typo [RT#118381]. |
| 164 |
|
| 165 |
|
| 166 |
1.1.81 2016-07-28 Released-By: PERLANCAR |
| 167 |
|
| 168 |
- No spec changes. |
| 169 |
|
| 170 |
- Split Sah schemas to Sah-Schemas-Rinci so that schema tweaks |
| 171 |
don't require releasing a new spec release. |
| 172 |
|
| 173 |
|
| 174 |
1.1.80 2016-05-10 Released-By: PERLANCAR |
| 175 |
|
| 176 |
- No spec changes. |
| 177 |
|
| 178 |
- [Incompatible change] Follow Sah::Schemas spec (each individual schema |
| 179 |
is put in a separate Sah::Schema::* package). Sah::Schema::Rinci is |
| 180 |
now replaced with Sah::Schema::rinci::* packages. |
| 181 |
|
| 182 |
|
| 183 |
1.1.79 2016-02-25 Released-By: PERLANCAR |
| 184 |
|
| 185 |
- Define new command-line source for function argument |
| 186 |
(cmdline_src): stdin_or_args. |
| 187 |
|
| 188 |
|
| 189 |
1.1.78 2015-09-03 Released-By: PERLANCAR |
| 190 |
|
| 191 |
- No spec changes. |
| 192 |
|
| 193 |
- [dist] Move spec prereqs from RuntimeRequires to |
| 194 |
DevelopRecommends to reduce deps but still allow indicating spec |
| 195 |
requirement. |
| 196 |
|
| 197 |
|
| 198 |
1.1.77 2015-05-01 Released-By: PERLANCAR |
| 199 |
|
| 200 |
- No spec changes. |
| 201 |
|
| 202 |
- Typos (args_rels, not args_schema) & wording. |
| 203 |
|
| 204 |
|
| 205 |
1.1.76 2015-04-30 Released-By: PERLANCAR |
| 206 |
|
| 207 |
- Replace function property 'args_groups' with 'args_rels'. This |
| 208 |
allows us to reuse the Sah 0.9.34+ specification, since the hash type |
| 209 |
now also contains clauses that specifies relationships between keys |
| 210 |
(arguments), e.g. choose_one, choose_all, req_one, req_all, dep_one, |
| 211 |
dep_all, req_dep_one, req_dep_all. |
| 212 |
|
| 213 |
|
| 214 |
1.1.75 2015-03-28 Released-By: PERLANCAR |
| 215 |
|
| 216 |
- Add (experimental) argument specification: filters. |
| 217 |
|
| 218 |
|
| 219 |
1.1.74 2015-03-18 Released-By: PERLANCAR |
| 220 |
|
| 221 |
- [Incompatible change] Use DefHash's 'caption' property for link title, |
| 222 |
instead of using another ('title'). |
| 223 |
|
| 224 |
- Introduce another value for 'cmdline_src' argument spec property: |
| 225 |
'stdin_or_file' (in addition to 'stdin_or_files'). |
| 226 |
|
| 227 |
|
| 228 |
1.1.73 2015-02-07 Released-By: PERLANCAR |
| 229 |
|
| 230 |
- No spec changes. |
| 231 |
|
| 232 |
- Forgot to update schema. |
| 233 |
|
| 234 |
|
| 235 |
1.1.72 2015-02-07 Released-By: PERLANCAR |
| 236 |
|
| 237 |
- Introduce function property 'args_groups' to allow things like |
| 238 |
requiring {only one,all} members of a group of args must be specified |
| 239 |
(and possibly others in the future). UPDATE: Now replaced with |
| 240 |
'args_rels'. |
| 241 |
|
| 242 |
- Specify argument specification property 'deps', to allow an argument |
| 243 |
to depend on others. |
| 244 |
|
| 245 |
|
| 246 |
1.1.71 2015-01-17 Released-By: PERLANCAR |
| 247 |
|
| 248 |
- Specify that streaming input and output now uses coderef instead of |
| 249 |
filehandle/etc. This is simpler and has the side-effects of easier to |
| 250 |
do wrapping for (see Perinci::Sub::Wrapper) where one can just wrap |
| 251 |
the coderef to do per-record validation of streaming input/output. |
| 252 |
|
| 253 |
|
| 254 |
1.1.70 2014-11-19 Released-By: PERLANCAR |
| 255 |
|
| 256 |
- Add 'links' property to arg spec. |
| 257 |
|
| 258 |
|
| 259 |
1.1.69 2014-10-30 Released-By: PERLANCAR |
| 260 |
|
| 261 |
- No spec changes. |
| 262 |
|
| 263 |
- [Bugfix] forgot to update Sah schema. |
| 264 |
|
| 265 |
|
| 266 |
1.1.68 2014-10-30 Released-By: PERLANCAR |
| 267 |
|
| 268 |
- Forgot to mention 'stream' argument spec property. |
| 269 |
|
| 270 |
|
| 271 |
1.1.67 2014-10-30 Released-By: PERLANCAR |
| 272 |
|
| 273 |
[INCOMPATIBLE CHANGES] |
| 274 |
|
| 275 |
- Tweaks/changes to sending of partial argument value: feature |
| 276 |
'partial_arg' is removed as it is redundant (argument property |
| 277 |
'partial' already hints this capability). When sending partial value, |
| 278 |
aside from '-arg_part_start' and '-arg_part_len', client now must also |
| 279 |
send '-arg_len' which is the total size. This is to follow more |
| 280 |
closely with HTTP Content-Range semantic. |
| 281 |
|
| 282 |
- Tweaks/changes to returning partial result: feature 'partial_res' is |
| 283 |
removed, function can now instead hint using the 'partial' property in |
| 284 |
its 'result' property. Result metadata properties 'res_part_start' and |
| 285 |
'res_part_len' are now renamed to 'part_start' and 'part_len'. 'len' |
| 286 |
is now also added to return information on total size (to follow HTTP |
| 287 |
Content-Range semantic more closely). |
| 288 |
|
| 289 |
[ENHANCEMENTS] |
| 290 |
|
| 291 |
- Introduce argument property 'stream' to signify accepting input |
| 292 |
stream. Input stream (like stdin) is a basic feature in most |
| 293 |
programming environment so it should be supported. Implementation of |
| 294 |
command-line framework will provide a filehandle for the argument, |
| 295 |
where the function can read data from. |
| 296 |
|
| 297 |
- Introduce result metadata property 'stream' to signify output is a |
| 298 |
stream. Output stream (like stdout) is a basic feature in most |
| 299 |
programming environment so it should be supported. This feature is |
| 300 |
actually already in Unixish for some time. |
| 301 |
|
| 302 |
|
| 303 |
1.1.66 2014-10-29 Released-By: PERLANCAR |
| 304 |
|
| 305 |
- Currently limit that there should at most be one argument with |
| 306 |
partial=1. The special arguments become just '-arg_part_start' and |
| 307 |
'-arg_part_len'. |
| 308 |
|
| 309 |
|
| 310 |
1.1.65 2014-10-29 Released-By: PERLANCAR |
| 311 |
|
| 312 |
- No spec changes. |
| 313 |
|
| 314 |
- [Bugfix] Forgot to update Sah schema. |
| 315 |
|
| 316 |
|
| 317 |
1.1.64 2014-10-29 Released-By: PERLANCAR |
| 318 |
|
| 319 |
[ENHANCEMENTS] |
| 320 |
|
| 321 |
- Introduce sending partial arguments and returning partial result, |
| 322 |
similar in spirit to Ranges in HTTP/1.1. New argument specification |
| 323 |
properties: 'partial'. New features: 'partial_arg', 'partial_res'. New |
| 324 |
special arguments: '-arg_part_start', '-arg_part_len', |
| 325 |
'-res_part_start', '-res_part_len'. New result metadata properties: |
| 326 |
'res_part_start', 'res_part_len'. UPDATE in 1.1.67: 'partial_res' is |
| 327 |
removed, '-res_part_start' & '-res_part_len' renamed to 'part_start & |
| 328 |
part_len'. |
| 329 |
|
| 330 |
|
| 331 |
1.1.63 2014-10-28 Released-By: PERLANCAR |
| 332 |
|
| 333 |
[ENHANCEMENTS] |
| 334 |
|
| 335 |
- Introduce statuses 201, 204. |
| 336 |
|
| 337 |
[INCOMPATIBLE CHANGES] |
| 338 |
|
| 339 |
- Introduce status 207. Replace result metadata properties 'arg_errors' |
| 340 |
& 'arg_warnings' with the more generic 'results' to report |
| 341 |
per-item/detailed statuses. |
| 342 |
|
| 343 |
|
| 344 |
1.1.62 2014-10-23 Released-By: PERLANCAR |
| 345 |
|
| 346 |
[REMOVED FEATURES] |
| 347 |
|
| 348 |
- Cancel support for 'encoding' (in result metadata as well in argument |
| 349 |
specification and result specification). This is an issue with JSON |
| 350 |
which cannot handle binary data and should be handled in the Riap |
| 351 |
level, not Rinci. Note: to mark a function argument or result as |
| 352 |
containing binary data, use the schema type 'buf'. |
| 353 |
|
| 354 |
|
| 355 |
1.1.61 2014-10-22 Released-By: PERLANCAR |
| 356 |
|
| 357 |
- Introduce 'encoding' property in result specification, to give hints |
| 358 |
to tools that function wants to encode its result by default. Said |
| 359 |
tool can encode the result and set the 'encoding' property in the |
| 360 |
result metadata. UPDATE in 1.1.62: removed. |
| 361 |
|
| 362 |
|
| 363 |
1.1.60 2014-10-22 Released-By: PERLANCAR |
| 364 |
|
| 365 |
- No spec changes. |
| 366 |
|
| 367 |
- Forgot to update Sah schemas. |
| 368 |
|
| 369 |
|
| 370 |
1.1.59 2014-10-22 Released-By: PERLANCAR |
| 371 |
|
| 372 |
- Update to DefHash 1.0.6 (introduced 'caption' property, which actually |
| 373 |
doesn't affect us much). |
| 374 |
|
| 375 |
- Introduce 'encoding' property in result metadata and argument |
| 376 |
specification. Currently the only known encoding is 'base64'. This is |
| 377 |
for functions that want to accept/return binary data, when transport |
| 378 |
protocol (e.g. 'json' format in Riap) does not support binary data |
| 379 |
(one can also use binary-safe formats in Riap e.g. Storable or Sereal, |
| 380 |
but this is not widely supported across languages like JSON). Tools |
| 381 |
can be written to support automatic decoding of function arguments and |
| 382 |
automatic encoding of function result. In Perl, see CPAN module |
| 383 |
Perinci::Sub::Wrapper. UPDATE in 1.1.62: removed. |
| 384 |
|
| 385 |
- Introduce 'arg_errors' and 'arg_warnings' properties in result |
| 386 |
metadata. This is for functions that do form processing, because often |
| 387 |
we want to send the error message for all non-validating arguments |
| 388 |
(form fields) instead of just the first one found. In Perl, see CPAN |
| 389 |
module Borang. UPDATE in 1.1.63: replaced with 'results'. |
| 390 |
|
| 391 |
- Introduce '-action' special argument and the 'check_arg' feature. The |
| 392 |
'-action' can toggle special invocation modes to the function. This is |
| 393 |
like '-tx_action' except is not necessarily related to transactions. |
| 394 |
Currently the only known action is 'check_arg', to check a single |
| 395 |
argument. This is for functions that do form processing, e.g. when |
| 396 |
user is editing a form field on the browser and we do AJAX calls to |
| 397 |
do validation as user types. |
| 398 |
|
| 399 |
|
| 400 |
1.1.58 2014-10-16 Released-By: PERLANCAR |
| 401 |
|
| 402 |
- No functional changes. |
| 403 |
|
| 404 |
- Rename Rinci::result -> Rinci::resmeta. |
| 405 |
|
| 406 |
|
| 407 |
1.1.57 2014-10-11 Released-By: PERLANCAR |
| 408 |
|
| 409 |
- Introduce is_flag bool property on command-line alias. This is just a |
| 410 |
convenience so you don't have to write: schema => [bool => {is=>1}]. |
| 411 |
|
| 412 |
|
| 413 |
1.1.56 2014-10-10 Released-By: PERLANCAR |
| 414 |
|
| 415 |
- Introduce argument element submetadata (element_meta property in |
| 416 |
argument specification, experimental). This is to support forms. |
| 417 |
|
| 418 |
|
| 419 |
1.1.55 2014-10-09 Released-By: PERLANCAR |
| 420 |
|
| 421 |
- Introduce argument submetadata (experimental). This is to support |
| 422 |
forms where one submits form (including subforms) to a function. |
| 423 |
|
| 424 |
|
| 425 |
1.1.54 2014-09-12 Released-By: PERLANCAR |
| 426 |
|
| 427 |
- Add result metadata property: perm_err. |
| 428 |
|
| 429 |
- Add FAQ and other POD tweaks. |
| 430 |
|
| 431 |
|
| 432 |
1.1.53 2014-09-11 Released-By: PERLANCAR |
| 433 |
|
| 434 |
- Introduce function argument spec properties: cmdline_prompt, |
| 435 |
is_password. This is to enable CLI programs to prompt password |
| 436 |
interactively. |
| 437 |
|
| 438 |
|
| 439 |
1.1.52 2014-06-29 Released-By: SHARYANTO |
| 440 |
|
| 441 |
- Allow completion routine to return hash (completion reply + metadata) |
| 442 |
instead of just array (completion reply), as already implemented in |
| 443 |
Perinci::Sub::Complete and Complete::Util. This allows giving hints |
| 444 |
on how to escape completion entries (which might be different |
| 445 |
depending on the type of completion, e.g. files vs environment |
| 446 |
variables where we don't want to escape '$', and so on). |
| 447 |
|
| 448 |
|
| 449 |
1.1.51 2014-06-25 Released-By: SHARYANTO |
| 450 |
|
| 451 |
- No spec changes. |
| 452 |
|
| 453 |
- Tweak/fix Sah schema. |
| 454 |
|
| 455 |
|
| 456 |
1.1.50 2014-06-13 Released-By: SHARYANTO |
| 457 |
|
| 458 |
[INCOMPATIBLE CHANGES] |
| 459 |
|
| 460 |
- Revert previous change (args/as -> args_as; args/as conflicts with |
| 461 |
actual arguments!). Revert result/is_naked -> result_naked too, not |
| 462 |
worth the trouble of breaking every function out there. What was |
| 463 |
steven-- thinking? |
| 464 |
|
| 465 |
|
| 466 |
1.1.49 2014-06-13 Released-By: SHARYANTO |
| 467 |
|
| 468 |
[INCOMPATIBLE CHANGES] |
| 469 |
|
| 470 |
- Rename args_as to args/as, result_naked to result/is_naked to make |
| 471 |
top-level properties cleaner. Implementation should still support the |
| 472 |
old properties for a while. UPDATE in 1.1.50: renamed back. |
| 473 |
|
| 474 |
[BUG FIXES] |
| 475 |
|
| 476 |
- Checking dep func/pkg should be done using Riap info action and not |
| 477 |
meta. |
| 478 |
|
| 479 |
|
| 480 |
1.1.48 2014-05-28 Released-By: SHARYANTO |
| 481 |
|
| 482 |
- function: Specify two new function dependency: pkg & func. |
| 483 |
|
| 484 |
|
| 485 |
1.1.47 2014-05-01 Released-By: SHARYANTO |
| 486 |
|
| 487 |
- No spec changes. |
| 488 |
|
| 489 |
- Tweak/fix schema. |
| 490 |
|
| 491 |
|
| 492 |
1.1.46 2014-04-30 Released-By: SHARYANTO |
| 493 |
|
| 494 |
- No spec changes. |
| 495 |
|
| 496 |
- Tweak/fix schema. |
| 497 |
|
| 498 |
|
| 499 |
1.1.45 2014-04-28 Released-By: SHARYANTO |
| 500 |
|
| 501 |
- No spec changes. |
| 502 |
|
| 503 |
- Tweak schema. |
| 504 |
|
| 505 |
|
| 506 |
1.1.44 2014-04-27 Released-By: SHARYANTO |
| 507 |
|
| 508 |
- Add Sah::Schema::Rinci (replaces Rinci::Schema). |
| 509 |
|
| 510 |
[REMOVED FEATURES] |
| 511 |
|
| 512 |
- function: Remove argument spec's 'cmdline_on_getarg' (for now?) |
| 513 |
because the current implementation does not allow calling the hook on |
| 514 |
a per-encountered basis (the argv is remainder from Getopt::Long |
| 515 |
after all the options have been processed). |
| 516 |
|
| 517 |
|
| 518 |
1.1.43 2013-12-25 Released-By: SHARYANTO; Note: Ho ho ho! |
| 519 |
|
| 520 |
- function: Add argument spec's 'cmdline_on_getopt' and |
| 521 |
'cmdline_on_getarg'. UPDATE in 1.1.44: 'cmdline_on_getarg' removed. |
| 522 |
|
| 523 |
|
| 524 |
1.1.42 2013-11-14 Released-By: SHARYANTO |
| 525 |
|
| 526 |
- function: Add argument spec's 'delete' and 'element_completion' |
| 527 |
properties. |
| 528 |
|
| 529 |
|
| 530 |
1.1.41 2013-11-08 Released-By: SHARYANTO |
| 531 |
|
| 532 |
- function: Introduce value 'file' for argument spec property |
| 533 |
'cmdline_src', to allow function to get file content in its |
| 534 |
argument. |
| 535 |
|
| 536 |
- function: Introduce property 'test' on example spec, to allow test |
| 537 |
module to skip testing a certain examples. |
| 538 |
|
| 539 |
|
| 540 |
1.1.40 2013-10-28 Released-By: SHARYANTO |
| 541 |
|
| 542 |
- result: Add properties 'func.*'. |
| 543 |
|
| 544 |
|
| 545 |
1.1.39 2013-10-15 Released-By: SHARYANTO; Note: with the smell of burning goat meat in the house! |
| 546 |
|
| 547 |
- function: examples: Introduce 'src' and 'src_plang' so that more |
| 548 |
general examples can be specified. |
| 549 |
|
| 550 |
- function: cmdline_aliases: 'code' now gets (\%args, $val) instead of |
| 551 |
just (\%args). |
| 552 |
|
| 553 |
|
| 554 |
1.1.38 2013-09-15 Released-By: SHARYANTO |
| 555 |
|
| 556 |
- result: Add property 'logs'. |
| 557 |
|
| 558 |
|
| 559 |
1.1.37 2013-09-13 Released-By: SHARYANTO |
| 560 |
|
| 561 |
- result: Replace property 'error_stack' with 'prev'. |
| 562 |
|
| 563 |
|
| 564 |
1.1.36 2013-09-07 Released-By: SHARYANTO |
| 565 |
|
| 566 |
- Rename property 'entity_version' to 'entity_v' to be more consistent |
| 567 |
with DefHash ('defhash_v'). |
| 568 |
|
| 569 |
|
| 570 |
1.1.35 2013-04-11 Released-By: SHARYANTO |
| 571 |
|
| 572 |
- Introduce property 'x' (from DefHash 1.0.3). |
| 573 |
|
| 574 |
|
| 575 |
1.1.34 2012-11-07 Released-By: SHARYANTO |
| 576 |
|
| 577 |
- function: Introduce status 44x and 54x (experimental). |
| 578 |
|
| 579 |
|
| 580 |
1.1.33 2012-11-07 Released-By: SHARYANTO |
| 581 |
|
| 582 |
- No spec changes. (Temporarily?) split Rinci::Schema to its own dist |
| 583 |
so I can release them often separately. UPDATE in 1.1.44: |
| 584 |
Rinci::Schema replaced with Sah::Schema::Rinci. |
| 585 |
|
| 586 |
|
| 587 |
1.1.32 2012-11-01 Released-By: SHARYANTO |
| 588 |
|
| 589 |
- result: Add property 'error_stack'. |
| 590 |
|
| 591 |
- function: property 'result': Add key 'statuses'. |
| 592 |
|
| 593 |
|
| 594 |
1.1.31 2012-09-19 Released-By: SHARYANTO |
| 595 |
|
| 596 |
- Base specification on DefHash. |
| 597 |
|
| 598 |
- Remove 'text_markup' property. Will depend on DefHash for this. |
| 599 |
|
| 600 |
|
| 601 |
1.1.30 2012-09-07 Released-By: SHARYANTO |
| 602 |
|
| 603 |
- No spec changes. Rename back a file (Rinci/Schema.pm) that I thought |
| 604 |
was not used (me--). [CT] |
| 605 |
|
| 606 |
|
| 607 |
1.1.29 2012-09-04 Released-By: SHARYANTO |
| 608 |
|
| 609 |
- Transaction: In 'check_state' phase, specify that result message |
| 610 |
should contain a description of what needs to be fixed, or how it is |
| 611 |
already fixed, or how it is unfixable; the message can then be logged |
| 612 |
by TM to be displayed to user. |
| 613 |
|
| 614 |
|
| 615 |
1.1.28 2012-08-29 Released-By: SHARYANTO |
| 616 |
|
| 617 |
[INCOMPATIBLE CHANGE] |
| 618 |
|
| 619 |
- Transaction: To link between 'check_state' call and 'fix_state' call |
| 620 |
(e.g. function want to preserve some value between call), previously |
| 621 |
in 'fix_state' call TM passes '-tx_undo_actions' containing the undo |
| 622 |
actions from the 'check_state'. Now a simpler way is introduced to |
| 623 |
replace this: '-tx_action_id' containing a unique UUID (in |
| 624 |
32-character hexdigit). BTW, '-tx_undo_actions' has not been |
| 625 |
implemented in Perinci::Tx::Manager, so the next release of |
| 626 |
Perinci::Tx::Manager will just implement '-tx_action_id'. |
| 627 |
|
| 628 |
|
| 629 |
1.1.27 2012-08-28 Released-By: SHARYANTO |
| 630 |
|
| 631 |
- Introduce status code 331. |
| 632 |
|
| 633 |
- Mark which status codes are in HTTP spec, which are introduced by us. |
| 634 |
|
| 635 |
|
| 636 |
1.1.26 2012-08-22 Released-By: SHARYANTO |
| 637 |
|
| 638 |
- Term change: call -> action. |
| 639 |
|
| 640 |
|
| 641 |
1.1.25 2012-08-22 Released-By: SHARYANTO |
| 642 |
|
| 643 |
[INCOMPATIBLE CHANGES] |
| 644 |
|
| 645 |
- Remove properties 'use' and 'req' in 'tx' feature. This is to make |
| 646 |
things simpler. use=>1 is redundant, if function follows transaction |
| 647 |
protocol it means you can use it in transaction. req=>1 is also |
| 648 |
removed, all functions should just require transaction and |
| 649 |
potentially return 'do_actions'. A simple wrapper can be created to |
| 650 |
execute those actions without transaction, if wanted. |
| 651 |
|
| 652 |
|
| 653 |
1.1.24 2012-08-21 Released-By: SHARYANTO |
| 654 |
|
| 655 |
[INCOMPATIBLE CHANGES] |
| 656 |
|
| 657 |
- Deprecate undo protocol, now undo should be implemented solely using |
| 658 |
transaction. |
| 659 |
|
| 660 |
- Revise transaction specification. Introduce protocol version (v) and |
| 661 |
bump it to v=2. Require 'tx' feature to specify protocol version. |
| 662 |
Incompatibilities include: 1) transaction now no longer uses undo |
| 663 |
protocol but adapts mechanism from Perinci::Sub::Gen::Undoable (which |
| 664 |
will also be deprecated as the mechanism is now elevated into |
| 665 |
standards); 2) TM object no longer needs to be passed to function, |
| 666 |
this should be safer; function now detects transaction using |
| 667 |
'-tx_action' special argument. |
| 668 |
|
| 669 |
[ENHANCEMENTS] |
| 670 |
|
| 671 |
- Specify TM's interface in more details (moved from Riap::Transaction, |
| 672 |
which now becomes shorter). |
| 673 |
|
| 674 |
- Specify steps for action, rollback, and crash recovery in more |
| 675 |
details, with example. |
| 676 |
|
| 677 |
|
| 678 |
1.1.23 2012-08-14 Released-By: SHARYANTO |
| 679 |
|
| 680 |
- Major rewrite of transaction specification. The main motivation is to |
| 681 |
remove the concept of 'steps' as this is a false dichotomy. Steps are |
| 682 |
actually functions themselves, the units of work are still functions. |
| 683 |
Eventually, a complex system will need to nest functions inside |
| 684 |
functions, to more than two levels of nesting. Why divide and limit |
| 685 |
into two levels (function-step)? So: |
| 686 |
|
| 687 |
- Everything is a bit clearer now |
| 688 |
|
| 689 |
- $tm interface is saner ($tm->call, easier to call function inside |
| 690 |
another) |
| 691 |
|
| 692 |
- No more mention of unused transaction status: e |
| 693 |
|
| 694 |
- New transaction statuses: v (rollback of undoing process), e |
| 695 |
(rollback of redoing process). |
| 696 |
|
| 697 |
- Recovery does not always mean rollback (to R). For transactions in u |
| 698 |
and d status, we continue the undoing/redoing. For transactions in v |
| 699 |
and e status, we continue the rollback to final status C and U, |
| 700 |
respectively. |
| 701 |
|
| 702 |
|
| 703 |
1.1.22 2012-08-09 Released-By: SHARYANTO |
| 704 |
|
| 705 |
- tx: Describe the ordering of calls during undo/rollback/redo when |
| 706 |
there is nested call. The same function may be called twice or more |
| 707 |
with parts of undo/redo steps. |
| 708 |
|
| 709 |
- tx: In transaction mode, function now gets undo/redo data from the |
| 710 |
usual -undo_data special argument, like in non-transaction mode. |
| 711 |
Txm's API get_undo_steps() and get_redo_steps() are now removed. |
| 712 |
|
| 713 |
|
| 714 |
1.1.21 2012-07-23 Released-By: SHARYANTO |
| 715 |
|
| 716 |
[INCOMPATIBLE CHANGES] |
| 717 |
|
| 718 |
- function: Remove argument specification key 'src', use 'cmdline_src' |
| 719 |
instead. I think 'src' is too general. |
| 720 |
|
| 721 |
|
| 722 |
1.1.20 2012-07-21 Released-By: SHARYANTO |
| 723 |
|
| 724 |
- function: Add argument specification keys 'src' and 'cmdline_src'. |
| 725 |
UPDATE in 1.1.21: 'src' removed. |
| 726 |
|
| 727 |
|
| 728 |
1.1.19 2012-06-22 Released-By: SHARYANTO |
| 729 |
|
| 730 |
- Adjust transaction status labels. Final statuses are now in |
| 731 |
uppercase: C, R, U, X; while transient statuses are in lowercase: i, |
| 732 |
a, u, d, e. |
| 733 |
|
| 734 |
- Add response status 429 (too many requests). |
| 735 |
|
| 736 |
|
| 737 |
1.1.18 2012-06-06 Released-By: SHARYANTO |
| 738 |
|
| 739 |
- Refinements to transaction details. |
| 740 |
|
| 741 |
- Remove dependency clause 'undo_storage'. Add dependency clauses |
| 742 |
'tmp_dir', 'trash_dir', 'undo_trash_dir'. |
| 743 |
|
| 744 |
|
| 745 |
1.1.17 2012-05-31 Released-By: SHARYANTO |
| 746 |
|
| 747 |
- Specify transactional system (Rinci::function::Transaction). Split |
| 748 |
specification for undo to Rinci::function::Undo and specify undo/redo |
| 749 |
protocol under transaction. UPDATE in 1.1.24: Undo protocol |
| 750 |
deprecated. |
| 751 |
|
| 752 |
|
| 753 |
1.1.16 2012-05-03 Released-By: SHARYANTO |
| 754 |
|
| 755 |
- Refine undo protocol documentation. Specify interaction with |
| 756 |
undo/transaction manager. '-undo_hint' is now replaced by |
| 757 |
'-undo_storage'. Declare 'undo_storage' dependency clause. UPDATE |
| 758 |
in 1.1.24: Undo protocol deprecated in favor of transaction. |
| 759 |
|
| 760 |
|
| 761 |
1.1.15 2012-05-02 Released-By: SHARYANTO |
| 762 |
|
| 763 |
- No spec changes. |
| 764 |
|
| 765 |
[INCOMPATIBLE CHANGE] |
| 766 |
|
| 767 |
- Update Sah schema syntax (pre-0.03, [merge:X] -> [mergeX]) |
| 768 |
|
| 769 |
|
| 770 |
1.1.14 2012-05-02 Released-By: SHARYANTO |
| 771 |
|
| 772 |
[INCOMPATIBLE CHANGE] |
| 773 |
|
| 774 |
- Change 'exec' dependency clause to 'prog' (avoid possible confusion |
| 775 |
because 'exec' can imply that we need to execute the program; there |
| 776 |
can be other future dep clause for that). |
| 777 |
|
| 778 |
|
| 779 |
1.1.13 2012-03-23 Released-By: SHARYANTO |
| 780 |
|
| 781 |
[ENHANCEMENTS] |
| 782 |
|
| 783 |
- Each tag in 'tags' property can also be a tag metadata hash (for |
| 784 |
translatable message, etc). |
| 785 |
|
| 786 |
|
| 787 |
1.1.12 2012-03-13 Released-By: SHARYANTO |
| 788 |
|
| 789 |
[ENHANCEMENTS] |
| 790 |
|
| 791 |
- Add 'Rinci::result'. |
| 792 |
|
| 793 |
|
| 794 |
1.1.11 2012-03-13 Released-By: SHARYANTO |
| 795 |
|
| 796 |
[INCOMPATIBLE CHANGES] |
| 797 |
|
| 798 |
- package: Remove property 'pkg_version' (use 'entity_version' |
| 799 |
instead). |
| 800 |
|
| 801 |
[ENHANCEMENTS] |
| 802 |
|
| 803 |
- Add property 'entity_version'. UPDATE in 1.1.36: renamed to |
| 804 |
'entity_v'. |
| 805 |
|
| 806 |
|
| 807 |
1.1.10 2012-02-28 Released-By: SHARYANTO |
| 808 |
|
| 809 |
- function: arg spec 'aliases': Add alias spec 'schema' |
| 810 |
|
| 811 |
|
| 812 |
1.1.9 2012-02-28 Released-By: SHARYANTO |
| 813 |
|
| 814 |
[INCOMPATIBLE CHANGE] |
| 815 |
|
| 816 |
- function: Change (back) 'set' alias spec to 'code', in arg spec |
| 817 |
'aliases' (for backward compatibility with 1.0) |
| 818 |
|
| 819 |
|
| 820 |
1.1.8 2012-02-28 Released-By: SHARYANTO |
| 821 |
|
| 822 |
[INCOMPATIBLE CHANGES] |
| 823 |
|
| 824 |
- function: Replace (back) 'alias_for' argument spec with |
| 825 |
'cmdline_aliases'. I first used 'alias_for' so I can list each alias |
| 826 |
as a key in 'args' property. The goal is so I can get all argument |
| 827 |
names (- aliases) simply by doing a keys() on 'args' hash. And the |
| 828 |
goal of that is to add a 'complete_arg_name' Riap action which is |
| 829 |
more lightweight than a full 'meta' just to get argument names. Turns |
| 830 |
out that I don't need 'alias_for' just to support |
| 831 |
'complete_arg_name', and also turns out that completing argument name |
| 832 |
needs more than just all argument names - aliases. You also need |
| 833 |
'pos' information. So a full 'meta' is currently used. The reason I |
| 834 |
now revert to 'cmdline_aliases' style is because I don't want |
| 835 |
command-line aliases to become full/first-class argument. |
| 836 |
|
| 837 |
|
| 838 |
1.1.7 2012-02-23 Released-By: SHARYANTO |
| 839 |
|
| 840 |
- package: Add property 'pkg_version'. UPDATE in 1.1.11 & 1.1.36: |
| 841 |
replaced by 'entity_v'. |
| 842 |
|
| 843 |
|
| 844 |
1.1.6 2012-02-21 Released-By: SHARYANTO |
| 845 |
|
| 846 |
- function: Add 'alias_for' argument specification. UPDATE 1.1.8: |
| 847 |
removed. |
| 848 |
|
| 849 |
|
| 850 |
1.1.5 2012-02-10 Released-By: SHARYANTO |
| 851 |
|
| 852 |
- No spec changes. |
| 853 |
|
| 854 |
- Add Rinci::Schema. |
| 855 |
|
| 856 |
|
| 857 |
1.1.4 2012-02-01 Released-By: SHARYANTO |
| 858 |
|
| 859 |
- Declare that 1.1 series might introduce minor backward compatibility |
| 860 |
problems between revisions. |
| 861 |
|
| 862 |
- Rename 'arg_pass_style' and 'result_envelope' to the old |
| 863 |
(Sub::Spec-era) 'args_as' and 'result_naked'. New names are not |
| 864 |
better. |
| 865 |
|
| 866 |
- Code entity URI now moved to Riap specification as the 'riap' URI |
| 867 |
scheme. |
| 868 |
|
| 869 |
- Some minor revisions. |
| 870 |
|
| 871 |
|
| 872 |
1.1.3 2012-01-27 Released-By: SHARYANTO |
| 873 |
|
| 874 |
- Change syntax of code entity URI, from 'Pkg.SubPkg.func' to |
| 875 |
'pm:/Pkg/SubPkg/func' (or 'py:', 'php:', and so on). |
| 876 |
|
| 877 |
- Some minor revisions like wording and paragraph reorganization. |
| 878 |
|
| 879 |
|
| 880 |
1.1.2 2012-01-19 Released-By: SHARYANTO |
| 881 |
|
| 882 |
- Add 'default_lang' property. Add guidelines on what to put in 'summary' |
| 883 |
and 'description'. |
| 884 |
|
| 885 |
- variable: Add 'schema' property. |
| 886 |
|
| 887 |
|
| 888 |
1.1.1 2012-01-18 Released-By: SHARYANTO |
| 889 |
|
| 890 |
- No spec changes. Update module names (Rinci::HTTP -> Riap, Rias -> |
| 891 |
Perinci). Add documents Rinci::Upgrading and Rinci::Tutorial (stub). |
| 892 |
|
| 893 |
|
| 894 |
1.1.0 2012-01-15 Released-By: SHARYANTO |
| 895 |
|
| 896 |
- First release. Spun off from Sub::Spec. |
| 897 |
|
| 898 |
[INCOMPATIBLE CHANGES FROM Sub::Spec 1.0.x] |
| 899 |
|
| 900 |
- Terminology: 'spec clause' becomes 'property'. This is to avoid |
| 901 |
confusion with 'clause' as used in Sah schema language. |
| 902 |
|
| 903 |
- Default text markup format changed from Org to Markdown, but a new |
| 904 |
properties 'text_markup' is added to allow specifying 'org' or |
| 905 |
'markdown' (or 'none'). UPDATE in 1.1.31: 'text_markup' property |
| 906 |
removed. |
| 907 |
|
| 908 |
- 'v' clause is now required to declare Rinci spec version (with value |
| 909 |
1.1, if unspecified then assumed spec is old Sub::Spec 1.0). |
| 910 |
|
| 911 |
- function: Incompatible changes to 'args' and 'result' properties; |
| 912 |
'args' is now a hash of arg names and arg *specs* (instead of arg |
| 913 |
schemas). 'result' is now a hash of data, instead of schema. The |
| 914 |
purpose is to keep Sah schema clean from custom, non-schema-related |
| 915 |
schema clauses, like arg_* (thus requiring custom Sah extensions, |
| 916 |
etc). Mixing them into schemas was not the right way. |
| 917 |
|
| 918 |
- function: property 'type' removed, replaced with 'is_func', |
| 919 |
'is_meth', 'is_static_meth'. This is because a single |
| 920 |
subroutine/function can act as all. |
| 921 |
|
| 922 |
- function: Other properties which are also removed/replaced: 'timeout' |
| 923 |
(non-core), 'retry' (non-core), 'scope' (can be replaced by using |
| 924 |
tags), 'result_naked' (replaced by 'result_envelope'), 'args_as' |
| 925 |
(replaced by 'arg_pass_style'). UPDATE in 1.1.4: 'arg_pass_style' |
| 926 |
renamed back to 'args_as', 'result_envelope' renamed back to |
| 927 |
'result_naked' because the new names are not deemed as better. |
| 928 |
|
| 929 |
- function: property 'deps': terminology change ('dep clause' -> 'dep |
| 930 |
type'), rename dep types: 'sub' -> 'func', 'mod' -> 'perl_module'. |
| 931 |
|
| 932 |
[NEW FEATURES FROM Sub::Spec 1.0.x] |
| 933 |
|
| 934 |
- Keys beginning with "_" are allowed and ignored. This can be used to |
| 935 |
store extra information. |
| 936 |
|
| 937 |
- New properties: 'tags', 'links', 'examples'. |