.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Rinci::Upgrading 3pm" .TH Rinci::Upgrading 3pm "2016-12-28" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Rinci::Upgrading \- Upgrading from previous version of specification .SH "VERSION" .IX Header "VERSION" This document describes version 1.1.84 of Rinci::Upgrading (from Perl distribution Rinci), released on 2016\-12\-28. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This document gives guide on how to convert your metadata from older version. .PP Examples are written in Perl, but are not limited to this language. .SH "UPGRADING FROM SUB::SPEC 1.0 TO RINCI 1.1" .IX Header "UPGRADING FROM SUB::SPEC 1.0 TO RINCI 1.1" .SS "Upgrading function metadata" .IX Subsection "Upgrading function metadata" In Perl, you can use Perinci::Sub::Wrapper (which in turn is used by Perinci::Access) to automatically convert Sub::Spec 1.0 metadata to 1.1, so you can skip this document if you want. .PP Terminology change: \fB(sub) spec\fR is now called metadata: the reason is because there are now metadata for functions as well as other code entities like variables, packages, etc. \fBclause\fR is now called \fBproperty\fR: the reason is to avoid confusion with Data::Sah's clause. .PP The \f(CW\*(C`v\*(C'\fR (spec version) property is required, add .PP .Vb 1 \& v => 1.1 .Ve .PP to your function metadata. .PP Each argument in the \f(CW\*(C`args\*(C'\fR property is now a hash, instead of a schema. Move the schema to the \f(CW\*(C`schema\*(C'\fR key of the hash. To specify required argument, add \&\f(CW\*(C`req\*(C'\fR set to 1 to hash key. Move \f(CW\*(C`arg_pos\*(C'\fR Sah clause to \f(CW\*(C`pos\*(C'\fR hash key. Move \&\f(CW\*(C`arg_greedy\*(C'\fR Sah clause to \f(CW\*(C`greedy\*(C'\fR hash key. Move \f(CW\*(C`arg_completion\*(C'\fR Sah clause to \f(CW\*(C`completion\*(C'\fR hash key. .PP Example, change this: .PP .Vb 7 \& args => { \& # a required argument \& arg1 => [\*(Aqint*\*(Aq, { \& summary => \*(AqBlah ...\*(Aq, \& min => 1, max => 100, \& arg_pos => 0, \& }], \& \& # an optional argument \& arg2 => [\*(Aqbool\*(Aq, { \& summary => \*(AqBlah ...\*(Aq, \& default => 0, \& }], \& } .Ve .PP Into this: .PP .Vb 7 \& args => { \& arg1 => { \& summary => \*(AqBlah ...\*(Aq, \& schema => [\*(Aqint*\*(Aq, {min=>1, max=>100}], \& req => 1, \& pos => 0, \& }, \& \& arg2 => { \& summary => \*(AqBlah ...\*(Aq, \& schema => [bool => {default=>0}], \& }, \& } .Ve .PP It is now possible to give summary and description to the schema as well as to the argument. .PP Accordingly, the \f(CW\*(C`result\*(C'\fR property is also now a hash, instead of schema. Move the schema into the \f(CW\*(C`schema\*(C'\fR hash key. .SS "Sub::Spec::HTTP" .IX Subsection "Sub::Spec::HTTP" For the most part, you only need to upgrade client and server library. Client library is now Perinci::CmdLine and Perinci::Access. Server library is now \&\f(CW\*(C`Perinci::Access::HTTP::Server\*(C'\fR. .PP Specification is now Riap and Riap::HTTP. Terminology changes. \fB\s-1SS\s0 request\fR now becomes \fBRiap request\fR. Some key names changed (shortened). Special headers are now prefixed with \fBX\-Riap\-*\fR instead of \fBX\-SS\-Req\-*\fR. .PP Log levels are now numeric only (1\-6) instead of numeric/string. .SH "HOMEPAGE" .IX Header "HOMEPAGE" Please visit the project's homepage at . .SH "SOURCE" .IX Header "SOURCE" Source repository is at . .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. .SH "AUTHOR" .IX Header "AUTHOR" perlancar .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2016 by perlancar@cpan.org. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.