diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a179851
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+# Dir for bundles
+dist
+node_modules
diff --git a/.redocly.yaml b/.redocly.yaml
new file mode 100644
index 0000000..a4edca8
--- /dev/null
+++ b/.redocly.yaml
@@ -0,0 +1,12 @@
+# See https://docs.redoc.ly/cli/configuration/ for more information.
+apiDefinitions:
+ main: openapi/openapi.yaml
+lint:
+ rules:
+ no-unused-schemas: warning
+referenceDocs:
+ htmlTemplate: ./docs/index.html
+ theme:
+ colors:
+ primary:
+ main: "#32329f"
diff --git a/LICENSE b/LICENSE
index 0ad25db..d41b8bd 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,661 +1,21 @@
- GNU AFFERO GENERAL PUBLIC LICENSE
- Version 3, 19 November 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
- A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
- The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
- An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU Affero General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Remote Network Interaction; Use with the GNU General Public License.
-
- Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software. This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time. Such new versions
-will be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-.
+The MIT License (MIT)
+
+Copyright (c) 2016 Ivan Goncharov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 7726f00..4821af7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,250 @@
-# mvspec
-Specifications for OpenAPI
+# Mieux Voter OpenAPI Definition
+
+## Working on your OpenAPI Definition
+
+### Install
+
+1. Install [Node JS](https://nodejs.org/).
+2. Clone this repo and run `npm install` in the repo root.
+
+### Usage
+
+#### `npm start`
+Starts the reference docs preview server.
+
+#### `npm run build`
+Bundles the definition to the dist folder.
+
+#### `npm test`
+Validates the definition.
+
+## Contribution Guide
+
+Below is a sample contribution guide. The tools
+in the repository don't restrict you to any
+specific structure. Adjust the contribution guide
+to match your own structure. However, if you
+don't have a structure in mind, this is a
+good place to start.
+
+Update this contribution guide if you
+adjust the file/folder organization.
+
+The `.redocly.yaml` controls settings for various
+tools including the lint tool and the reference
+docs engine. Open it to find examples and
+[read the docs](https://docs.redoc.ly/cli/configuration/)
+for more information.
+
+
+### Schemas
+
+#### Adding Schemas
+
+1. Navigate to the `openapi/components/schemas` folder.
+2. Add a file named as you wish to name the schema.
+3. Define the schema.
+4. Refer to the schema using the `$ref` (see example below).
+
+##### Example Schema
+This is a very simple schema example:
+```yaml
+type: string
+description: The resource ID. Defaults to UUID v4
+maxLength: 50
+example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
+```
+This is a more complex schema example:
+```yaml
+type: object
+properties:
+ id:
+ description: The customer identifier string
+ readOnly: true
+ allOf:
+ - $ref: ./ResourceId.yaml
+ websiteId:
+ description: The website's ID
+ allOf:
+ - $ref: ./ResourceId.yaml
+ paymentToken:
+ type: string
+ writeOnly: true
+ description: |
+ A write-only payment token; if supplied, it will be converted into a
+ payment instrument and be set as the `defaultPaymentInstrument`. The
+ value of this property will override the `defaultPaymentInstrument`
+ in the case that both are supplied. The token may only be used once
+ before it is expired.
+ defaultPaymentInstrument:
+ $ref: ./PaymentInstrument.yaml
+ createdTime:
+ description: The customer created time
+ allOf:
+ - $ref: ./ServerTimestamp.yaml
+ updatedTime:
+ description: The customer updated time
+ allOf:
+ - $ref: ./ServerTimestamp.yaml
+ tags:
+ description: A list of customer's tags
+ readOnly: true
+ type: array
+ items:
+ $ref: ./Tags/Tag.yaml
+ revision:
+ description: >
+ The number of times the customer data has been modified.
+
+ The revision is useful when analyzing webhook data to determine if the
+ change takes precedence over the current representation.
+ type: integer
+ readOnly: true
+ _links:
+ type: array
+ description: The links related to resource
+ readOnly: true
+ minItems: 3
+ items:
+ anyOf:
+ - $ref: ./Links/SelfLink.yaml
+ - $ref: ./Links/NotesLink.yaml
+ - $ref: ./Links/DefaultPaymentInstrumentLink.yaml
+ - $ref: ./Links/LeadSourceLink.yaml
+ - $ref: ./Links/WebsiteLink.yaml
+ _embedded:
+ type: array
+ description: >-
+ Any embedded objects available that are requested by the `expand`
+ querystring parameter.
+ readOnly: true
+ minItems: 1
+ items:
+ anyOf:
+ - $ref: ./Embeds/LeadSourceEmbed.yaml
+
+```
+
+##### Using the `$ref`
+
+Notice in the complex example above the schema definition itself has `$ref` links to other schemas defined.
+
+Here is a small excerpt with an example:
+
+```yaml
+defaultPaymentInstrument:
+ $ref: ./PaymentInstrument.yaml
+```
+
+The value of the `$ref` is the path to the other schema definition.
+
+You may use `$ref`s to compose schema from other existing schema to avoid duplication.
+
+You will use `$ref`s to reference schema from your path definitions.
+
+#### Editing Schemas
+
+1. Navigate to the `openapi/components/schemas` folder.
+2. Open the file you wish to edit.
+3. Edit.
+
+### Paths
+
+#### Adding a Path
+
+1. Navigate to the `openapi/paths` folder.
+2. Add a new YAML file named like your URL endpoint except replacing `/` with `@` and putting path parameters into curly braces like `{example}`.
+3. Add the path and a ref to it inside of your `openapi.yaml` file inside of the `openapi` folder.
+
+Example addition to the `openapi.yaml` file:
+```yaml
+'/customers/{id}':
+ $ref: './paths/customers@{id}.yaml'
+```
+
+Here is an example of a YAML file named `customers@{id}.yaml` in the `paths` folder:
+
+```yaml
+get:
+ tags:
+ - Customers
+ summary: Retrieve a list of customers
+ operationId: GetCustomerCollection
+ description: |
+ You can have a markdown description here.
+ parameters:
+ - $ref: ../components/parameters/collectionLimit.yaml
+ - $ref: ../components/parameters/collectionOffset.yaml
+ - $ref: ../components/parameters/collectionFilter.yaml
+ - $ref: ../components/parameters/collectionQuery.yaml
+ - $ref: ../components/parameters/collectionExpand.yaml
+ - $ref: ../components/parameters/collectionFields.yaml
+ responses:
+ '200':
+ description: A list of Customers was retrieved successfully
+ headers:
+ Rate-Limit-Limit:
+ $ref: ../components/headers/Rate-Limit-Limit.yaml
+ Rate-Limit-Remaining:
+ $ref: ../components/headers/Rate-Limit-Remaining.yaml
+ Rate-Limit-Reset:
+ $ref: ../components/headers/Rate-Limit-Reset.yaml
+ Pagination-Total:
+ $ref: ../components/headers/Pagination-Total.yaml
+ Pagination-Limit:
+ $ref: ../components/headers/Pagination-Limit.yaml
+ Pagination-Offset:
+ $ref: ../components/headers/Pagination-Offset.yaml
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: ../components/schemas/Customer.yaml
+ text/csv:
+ schema:
+ type: array
+ items:
+ $ref: ../components/schemas/Customer.yaml
+ '401':
+ $ref: ../components/responses/AccessForbidden.yaml
+ x-code-samples:
+ - lang: PHP
+ source:
+ $ref: ../code_samples/PHP/customers/get.php
+post:
+ tags:
+ - Customers
+ summary: Create a customer (without an ID)
+ operationId: PostCustomer
+ description: Another markdown description here.
+ requestBody:
+ $ref: ../components/requestBodies/Customer.yaml
+ responses:
+ '201':
+ $ref: ../components/responses/Customer.yaml
+ '401':
+ $ref: ../components/responses/AccessForbidden.yaml
+ '409':
+ $ref: ../components/responses/Conflict.yaml
+ '422':
+ $ref: ../components/responses/InvalidDataError.yaml
+ x-code-samples:
+ - lang: PHP
+ source:
+ $ref: ../code_samples/PHP/customers/post.php
+```
+
+You'll see extensive usage of `$ref`s in this example to different types of components including schemas.
+
+You'll also notice `$ref`s to code samples.
+
+### Code samples
+
+1. Navigate to the `openapi/code_samples` folder.
+2. Navigate to the `` (e.g. PHP) sub-folder.
+3. Navigate to the `path` folder, and add ref to the code sample.
+
+You can add languages by adding new folders at the appropriate path level.
+
+More details inside the `code_samples` folder README.
diff --git a/docs/favicon.png b/docs/favicon.png
new file mode 100644
index 0000000..b5c1a2d
Binary files /dev/null and b/docs/favicon.png differ
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..e4b8502
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,24 @@
+
+
+
+ API Reference | ReDoc
+
+
+
+
+
+
+ {{{redocHead}}}
+
+
+ {{{redocHTML}}}
+
+
diff --git a/openapi/README.md b/openapi/README.md
new file mode 100644
index 0000000..a9c9533
--- /dev/null
+++ b/openapi/README.md
@@ -0,0 +1,13 @@
+## The `openapi` folder
+
+This folder contains your entrypoint `openapi.yaml`.
+
+That file contains references to the entire API definition.
+
+Here are some sections to pay attention to:
+
+* Top-level **description**: this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs. Consider maintaining your markdown in a separate file and [embedding it](https://docs.redoc.ly/api-reference-docs/embedded-markdown/). Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown.
+* Security schemes: you will define the scheme(s) your API uses for security (eg OAuth2, API Key, etc...). The security schemes are used by the Redocly API Reference "Try It" API console feature.
+* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
+* Tags: it's a good idea to organize each operation. Each tag can have a description. The description is used as a section description within the reference docs.
+* Servers: a list of your servers, each with a URL.
diff --git a/openapi/components/README.md b/openapi/components/README.md
new file mode 100644
index 0000000..26eaeb5
--- /dev/null
+++ b/openapi/components/README.md
@@ -0,0 +1,14 @@
+Reusable components
+===========
+
+* You can create the following folders here:
+ - `schemas` - reusable [Schema Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
+ - `responses` - reusable [Response Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject)
+ - `parameters` - reusable [Parameter Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject)
+ - `examples` - reusable [Example Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)
+ - `headers` - reusable [Header Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject)
+ - `requestBodies` - reusable [Request Body Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject)
+ - `links` - reusable [Link Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#linkObject)
+ - `callbacks` - reusable [Callback Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject)
+ - `securitySchemes` - reusable [Security Scheme Objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securitySchemeObject)
+* Filename of files inside the folders represent component name, e.g. `Customer.yaml`
diff --git a/openapi/components/links/DelJudgmentByJudgmentId.yaml b/openapi/components/links/DelJudgmentByJudgmentId.yaml
new file mode 100644
index 0000000..f8d60b4
--- /dev/null
+++ b/openapi/components/links/DelJudgmentByJudgmentId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1judgments/~1{judgment-id}/delete'
+parameters:
+ judgmentId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `judgment-id`
+ parameter in DELETE /judgments/{judgment-id}.
diff --git a/openapi/components/links/DelPollByPollId.yaml b/openapi/components/links/DelPollByPollId.yaml
new file mode 100644
index 0000000..377cd5f
--- /dev/null
+++ b/openapi/components/links/DelPollByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1polls/~1{poll-id}/delete'
+parameters:
+ pollId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in DELETE /polls/{poll-id}.
diff --git a/openapi/components/links/GetJudgmentByJudgmentId.yaml b/openapi/components/links/GetJudgmentByJudgmentId.yaml
new file mode 100644
index 0000000..bd5888d
--- /dev/null
+++ b/openapi/components/links/GetJudgmentByJudgmentId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1judgments/~1{judgment-id}/get'
+parameters:
+ judgmentId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `judgment-id`
+ parameter in GET /judgments/{judgment-id}.
diff --git a/openapi/components/links/GetPollByPollId.yaml b/openapi/components/links/GetPollByPollId.yaml
new file mode 100644
index 0000000..125dc06
--- /dev/null
+++ b/openapi/components/links/GetPollByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1polls/~1{poll-id}/get'
+parameters:
+ pollId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in GET /polls/{poll-id}.
diff --git a/openapi/components/links/InviteByPollId.yaml b/openapi/components/links/InviteByPollId.yaml
new file mode 100644
index 0000000..08f07a7
--- /dev/null
+++ b/openapi/components/links/InviteByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1polls/~1{poll-id}/judges/post'
+parameters:
+ userId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in GET /invites/{poll-id}.
diff --git a/openapi/components/links/JudgeByPollId.yaml b/openapi/components/links/JudgeByPollId.yaml
new file mode 100644
index 0000000..bf76496
--- /dev/null
+++ b/openapi/components/links/JudgeByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1judges/~1{poll-id}/post'
+parameters:
+ userId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in GET /judgments/{poll-id}.
diff --git a/openapi/components/links/ResultsByPollId.yaml b/openapi/components/links/ResultsByPollId.yaml
new file mode 100644
index 0000000..a314386
--- /dev/null
+++ b/openapi/components/links/ResultsByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1polls/~1{poll-id}/results/get'
+parameters:
+ pollId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in GET /results/{result-id}.
diff --git a/openapi/components/links/SetPollByPollId.yaml b/openapi/components/links/SetPollByPollId.yaml
new file mode 100644
index 0000000..21d1869
--- /dev/null
+++ b/openapi/components/links/SetPollByPollId.yaml
@@ -0,0 +1,6 @@
+operationRef: '#/paths/~1polls/~1{poll-id}/patch'
+parameters:
+ pollId: $response.body#/id
+description: >
+ The `id` value returned in the response can be used as the `poll-id` parameter
+ in PATCH /polls/{poll-id}.
diff --git a/openapi/components/responses/JudgeNotFound.yaml b/openapi/components/responses/JudgeNotFound.yaml
new file mode 100644
index 0000000..d244bd2
--- /dev/null
+++ b/openapi/components/responses/JudgeNotFound.yaml
@@ -0,0 +1,5 @@
+description: The specified judge was not found
+content:
+ application/json:
+ schema:
+ $ref: ../schemas/Error.yaml
diff --git a/openapi/components/responses/JudgmentNotFound.yaml b/openapi/components/responses/JudgmentNotFound.yaml
new file mode 100644
index 0000000..464fa5e
--- /dev/null
+++ b/openapi/components/responses/JudgmentNotFound.yaml
@@ -0,0 +1,5 @@
+description: The specified judgment was not found
+content:
+ application/json:
+ schema:
+ $ref: ../schemas/Error.yaml
diff --git a/openapi/components/responses/PollNotFound.yaml b/openapi/components/responses/PollNotFound.yaml
new file mode 100644
index 0000000..a25eafb
--- /dev/null
+++ b/openapi/components/responses/PollNotFound.yaml
@@ -0,0 +1,5 @@
+description: The specified poll was not found
+content:
+ application/json:
+ schema:
+ $ref: ../schemas/Error.yaml
diff --git a/openapi/components/responses/Unauthorized.yaml b/openapi/components/responses/Unauthorized.yaml
new file mode 100644
index 0000000..b097902
--- /dev/null
+++ b/openapi/components/responses/Unauthorized.yaml
@@ -0,0 +1,5 @@
+description: Unauthorized
+content:
+ application/json:
+ schema:
+ $ref: ../schemas/Error.yaml
diff --git a/openapi/components/schemas/Candidate.yaml b/openapi/components/schemas/Candidate.yaml
new file mode 100644
index 0000000..63f03f4
--- /dev/null
+++ b/openapi/components/schemas/Candidate.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+ id:
+ type: string
+ readOnly: true
+ name:
+ type: string
+ description: Unique but short name of the candidate.
+ judgments:
+ type: array
+ items:
+ $ref: ./Judgment.yaml
+ description: The judgments received by this candidate.
diff --git a/openapi/components/schemas/Error.yaml b/openapi/components/schemas/Error.yaml
new file mode 100644
index 0000000..fecef03
--- /dev/null
+++ b/openapi/components/schemas/Error.yaml
@@ -0,0 +1,9 @@
+type: object
+properties:
+ code:
+ type: string
+ message:
+ type: string
+required:
+ - code
+ - message
diff --git a/openapi/components/schemas/Grade.yaml b/openapi/components/schemas/Grade.yaml
new file mode 100644
index 0000000..bd23855
--- /dev/null
+++ b/openapi/components/schemas/Grade.yaml
@@ -0,0 +1,8 @@
+type: object
+properties:
+ id:
+ type: string
+ readOnly: true
+ name:
+ type: string
+ description: 'Unique but short name of the grade, like "Excellent" or "To reject".'
diff --git a/openapi/components/schemas/Judge.yaml b/openapi/components/schemas/Judge.yaml
new file mode 100644
index 0000000..5114595
--- /dev/null
+++ b/openapi/components/schemas/Judge.yaml
@@ -0,0 +1,12 @@
+type: object
+properties:
+ id:
+ type: string
+ readOnly: true
+ has-voted:
+ type: string
+ poll-id:
+ type: string
+ mail:
+ type: object
+ description: Send a mail at the creation of the judge. The mail is not kept in memory.
diff --git a/openapi/components/schemas/Judgment.yaml b/openapi/components/schemas/Judgment.yaml
new file mode 100644
index 0000000..e0cd858
--- /dev/null
+++ b/openapi/components/schemas/Judgment.yaml
@@ -0,0 +1,7 @@
+type: object
+properties:
+ id:
+ type: string
+ readOnly: true
+ grade:
+ type: string
diff --git a/openapi/components/schemas/Poll.yaml b/openapi/components/schemas/Poll.yaml
new file mode 100644
index 0000000..97c4118
--- /dev/null
+++ b/openapi/components/schemas/Poll.yaml
@@ -0,0 +1,28 @@
+type: object
+properties:
+ id:
+ type: string
+ readOnly: true
+ title:
+ type: string
+ description: 'As , I find these candidates:'
+ candidates:
+ type: array
+ minItems: 2
+ maxItems: 20
+ items:
+ $ref: ./Candidate.yaml
+ description: The candidates being judged in a poll.
+ grades:
+ type: array
+ items:
+ $ref: ./Grade.yaml
+ description: The grades on which one judges a candidate.
+ judges:
+ type: array
+ items:
+ $ref: ./Judge.yaml
+ description: The judges that are allowed to participate to the election.
+ restrict_judges:
+ type: boolean
+ description: Can anyone create a judge?
diff --git a/openapi/components/schemas/Result.yaml b/openapi/components/schemas/Result.yaml
new file mode 100644
index 0000000..ce7d2d6
--- /dev/null
+++ b/openapi/components/schemas/Result.yaml
@@ -0,0 +1,9 @@
+type: object
+properties:
+ poll:
+ $ref: ./Poll.yaml
+ ranking:
+ type: array
+ items:
+ type: integer
+ format: int16
diff --git a/openapi/components/securitySchemes/judgeAuth.yaml b/openapi/components/securitySchemes/judgeAuth.yaml
new file mode 100644
index 0000000..fadb6e0
--- /dev/null
+++ b/openapi/components/securitySchemes/judgeAuth.yaml
@@ -0,0 +1,2 @@
+type: http
+scheme: bearer
diff --git a/openapi/components/securitySchemes/pollAuth.yaml b/openapi/components/securitySchemes/pollAuth.yaml
new file mode 100644
index 0000000..fadb6e0
--- /dev/null
+++ b/openapi/components/securitySchemes/pollAuth.yaml
@@ -0,0 +1,2 @@
+type: http
+scheme: bearer
diff --git a/openapi/components/securitySchemes/resultAuth.yaml b/openapi/components/securitySchemes/resultAuth.yaml
new file mode 100644
index 0000000..fadb6e0
--- /dev/null
+++ b/openapi/components/securitySchemes/resultAuth.yaml
@@ -0,0 +1,2 @@
+type: http
+scheme: bearer
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
new file mode 100644
index 0000000..756a718
--- /dev/null
+++ b/openapi/openapi.yaml
@@ -0,0 +1,41 @@
+openapi: 3.0.0
+info:
+ title: Mieux Voter
+ description: >-
+ An Application Programming Interface (API) for Majority Judgment (MJ)
+ Polling.
+ version: 1.0.1-oas3
+ termsOfService: 'https://github.com/MieuxVoter'
+ contact:
+ email: app@mieuxvoter.fr
+servers:
+ - url: 'https://api.mieuxvoter.fr/v1'
+ description: Main (production) server
+ - url: 'https://sandboxapi.mieuxvoter.fr/v1'
+ description: Internal staging server for testing
+paths:
+ /polls:
+ $ref: paths/polls.yaml
+ '/polls/{poll-id}':
+ $ref: 'paths/polls@{poll-id}.yaml'
+ '/polls/{poll-id}/judges':
+ $ref: 'paths/polls@{poll-id}@judges.yaml'
+ '/polls/{poll-id}/results':
+ $ref: 'paths/polls@{poll-id}@results.yaml'
+ '/polls/{poll-id}/judgments':
+ $ref: 'paths/polls@{poll-id}@judgments.yaml'
+ '/judgments/{judgment-id}':
+ $ref: 'paths/judgments@{judgment-id}.yaml'
+ '/polls/{poll-id}/judges/{judge-id}/':
+ $ref: 'paths/polls@{poll-id}@judges@{judge-id}@.yaml'
+components:
+ securitySchemes:
+ judgeAuth:
+ type: http
+ scheme: bearer
+ pollAuth:
+ type: http
+ scheme: bearer
+ resultAuth:
+ type: http
+ scheme: bearer
diff --git a/openapi/paths/README.md b/openapi/paths/README.md
new file mode 100644
index 0000000..0449659
--- /dev/null
+++ b/openapi/paths/README.md
@@ -0,0 +1,105 @@
+Paths
+=====
+
+Organize your path definitions within this folder. You will reference your paths from your main `openapi.yaml` entrypoint file.
+
+It may help you to adopt some conventions:
+
+* path separator token (e.g. `@`) or subfolders
+* path parameter (e.g. `{example}`)
+* file-per-path or file-per-operation
+
+There are different benefits and drawbacks to each decision.
+
+You can adopt any organization you wish. We have some tips for organizing paths based on common practices.
+
+## Each path in a separate file
+
+Use a predefined "path separator" and keep all of your path files in the top level of the `paths` folder.
+
+```
+# todo: insert tree view of paths folder
+```
+
+Redocly recommends using the `@` character for this case.
+
+In addition, Redocly recommends placing path parameters within `{}` curly braces if you adopt this style.
+
+#### Motivations
+
+* Quickly see a list of all paths. Many people think in terms of the "number" of "endpoints" (paths), and not the "number" of "operations" (paths * http methods).
+
+* Only the "file-per-path" option is semantically correct with the OpenAPI Specification 3.0.2. However, Redocly's openapi-cli will build valid bundles for any of the other options too.
+
+
+#### Drawbacks
+
+* This may require multiple definitions per http method within a single file.
+* It requires settling on a path separator (that is allowed to be used in filenames) and sticking to that convention.
+
+## Each operation in a separate file
+
+You may also place each operation in a separate file.
+
+In this case, if you want all paths at the top-level, you can concatenate the http method to the path name. Similar to the above option, you can
+
+### Files at top-level of `paths`
+
+You may name your files with some concatenation for the http method. For example, following a convention such as: `-.yaml`.
+
+#### Motivations
+
+* Quickly see all operations without needing to navigate subfolders.
+
+#### Drawbacks
+
+* Adopting an unusual path separator convention, instead of using subfolders.
+
+### Use subfolders to mirror API path structure
+
+Example:
+```
+GET /customers
+
+/paths/customers/get.yaml
+```
+
+In this case, the path id defined within subfolders which mirror the API URL structure.
+
+Example with path parameter:
+```
+GET /customers/{id}
+
+/paths/customers/{id}/get.yaml
+```
+
+#### Motivations
+
+It matches the URL structure.
+
+It is pretty easy to reference:
+
+```yaml
+paths:
+ '/customers/{id}':
+ get:
+ $ref: ./paths/customers/{id}/get.yaml
+ put:
+ $ref: ./paths/customers/{id}/put.yaml
+```
+
+#### Drawbacks
+
+If you have a lot of nested folders, it may be confusing to reference your schemas.
+
+Example
+```
+file: /paths/customers/{id}/timeline/{messageId}/get.yaml
+
+# excerpt of file
+ headers:
+ Rate-Limit-Remaining:
+ $ref: ../../../../../components/headers/Rate-Limit-Remaining.yaml
+
+```
+Notice the `../../../../../` in the ref which requires some attention to formulate correctly. While openapi-cli has a linter which suggests possible refs when there is a mistake, this is still a net drawback for APIs with deep paths.
diff --git a/openapi/paths/judgments@{judgment-id}.yaml b/openapi/paths/judgments@{judgment-id}.yaml
new file mode 100644
index 0000000..e2f25f3
--- /dev/null
+++ b/openapi/paths/judgments@{judgment-id}.yaml
@@ -0,0 +1,24 @@
+parameters:
+ - in: path
+ name: judgment-id
+ required: true
+ schema:
+ type: string
+get:
+ summary: Gets a judgment by ID
+ responses:
+ '200':
+ description: A judgment object
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Judgment.yaml
+delete:
+ summary: Deletes a judgment
+ responses:
+ '200':
+ description: OK
+ '404':
+ $ref: ../components/responses/JudgmentNotFound.yaml
+ security:
+ - judgeAuth: []
diff --git a/openapi/paths/polls.yaml b/openapi/paths/polls.yaml
new file mode 100644
index 0000000..b23583b
--- /dev/null
+++ b/openapi/paths/polls.yaml
@@ -0,0 +1,43 @@
+get:
+ summary: Gets all polls.
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: ../components/schemas/Poll.yaml
+post:
+ summary: Creates a poll.
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Poll.yaml
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Id of the created poll.
+ links:
+ GetPollByPollId:
+ $ref: ../components/links/GetPollByPollId.yaml
+ SetPollByPollId:
+ $ref: ../components/links/SetPollByPollId.yaml
+ DelPollByPollId:
+ $ref: ../components/links/DelPollByPollId.yaml
+ JudgeByPollId:
+ $ref: ../components/links/JudgeByPollId.yaml
+ ResultsByPollId:
+ $ref: ../components/links/ResultsByPollId.yaml
+ '400':
+ description: Bad Request. Expect at least 2 candidates and a title.
diff --git a/openapi/paths/polls@{poll-id}.yaml b/openapi/paths/polls@{poll-id}.yaml
new file mode 100644
index 0000000..8c2cd56
--- /dev/null
+++ b/openapi/paths/polls@{poll-id}.yaml
@@ -0,0 +1,47 @@
+parameters:
+ - in: path
+ name: poll-id
+ required: true
+ schema:
+ type: integer
+ format: int64
+get:
+ summary: Gets a poll by ID
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Poll.yaml
+ '404':
+ $ref: ../components/responses/PollNotFound.yaml
+patch:
+ summary: Updates a poll
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Poll.yaml
+ security:
+ - {}
+ - pollAuth: []
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: ../components/schemas/Poll.yaml
+delete:
+ summary: Deletes a poll
+ responses:
+ '200':
+ description: OK
+ '404':
+ $ref: ../components/responses/PollNotFound.yaml
+ security:
+ - pollAuth: []
diff --git a/openapi/paths/polls@{poll-id}@judges.yaml b/openapi/paths/polls@{poll-id}@judges.yaml
new file mode 100644
index 0000000..486f4db
--- /dev/null
+++ b/openapi/paths/polls@{poll-id}@judges.yaml
@@ -0,0 +1,22 @@
+parameters:
+ - in: path
+ name: poll-id
+ required: true
+ schema:
+ type: string
+post:
+ description: Add a judge to a poll
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Judge.yaml
+ responses:
+ '200':
+ description: Invitation was sent
+ content:
+ text/plain:
+ schema:
+ type: string
+ '404':
+ $ref: ../components/responses/PollNotFound.yaml
diff --git a/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml b/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml
new file mode 100644
index 0000000..3666269
--- /dev/null
+++ b/openapi/paths/polls@{poll-id}@judges@{judge-id}@.yaml
@@ -0,0 +1,29 @@
+parameters:
+ - in: path
+ name: judge-id
+ required: true
+ schema:
+ type: string
+get:
+ summary: Get a judge from a poll
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Judge.yaml
+ '404':
+ $ref: ../components/responses/JudgeNotFound.yaml
+ security:
+ - {}
+ - pollAuth: []
+delete:
+ summary: Delete a judge from a poll
+ responses:
+ '200':
+ description: OK
+ '404':
+ $ref: ../components/responses/JudgeNotFound.yaml
+ security:
+ - pollAuth: []
diff --git a/openapi/paths/polls@{poll-id}@judgments.yaml b/openapi/paths/polls@{poll-id}@judgments.yaml
new file mode 100644
index 0000000..6743c27
--- /dev/null
+++ b/openapi/paths/polls@{poll-id}@judgments.yaml
@@ -0,0 +1,33 @@
+parameters:
+ - in: path
+ name: poll-id
+ required: true
+ schema:
+ type: string
+post:
+ summary: Creates a judgment
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/Judgment.yaml
+ security:
+ - {}
+ - judgeAuth: []
+ responses:
+ '201':
+ description: Created
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Id of the created judgment.
+ links:
+ GetJudgmentByJudgmentId:
+ $ref: ../components/links/GetJudgmentByJudgmentId.yaml
+ DelJudgmentByJudgmentId:
+ $ref: ../components/links/DelJudgmentByJudgmentId.yaml
diff --git a/openapi/paths/polls@{poll-id}@results.yaml b/openapi/paths/polls@{poll-id}@results.yaml
new file mode 100644
index 0000000..895dd6b
--- /dev/null
+++ b/openapi/paths/polls@{poll-id}@results.yaml
@@ -0,0 +1,17 @@
+parameters:
+ - in: path
+ name: poll-id
+ required: true
+ schema:
+ type: string
+get:
+ description: Get results of a poll
+ responses:
+ '200':
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: ../components/schemas/Result.yaml
+ '404':
+ $ref: ../components/responses/PollNotFound.yaml
diff --git a/package-lock.json b/package-lock.json
new file mode 100644
index 0000000..bc7b6a7
--- /dev/null
+++ b/package-lock.json
@@ -0,0 +1,545 @@
+{
+ "name": "mieux-voter",
+ "version": "1.0.0",
+ "lockfileVersion": 1,
+ "requires": true,
+ "dependencies": {
+ "@redocly/openapi-cli": {
+ "version": "0.12.10",
+ "resolved": "https://registry.npmjs.org/@redocly/openapi-cli/-/openapi-cli-0.12.10.tgz",
+ "integrity": "sha512-Rv7l49kI7tuBePPztjVdjwUdWnu4k3j7JxOVc4gOwp9XXbHP2NDtbbk0tV9V7/aWn+8izSNED8c2mZ5dx9/8Ow==",
+ "requires": {
+ "chalk": "^3.0.0",
+ "chokidar": "^3.3.1",
+ "commander": "^5.0.0",
+ "handlebars": "^4.7.3",
+ "js-yaml": "^3.13.1",
+ "lodash.isequal": "^4.5.0",
+ "merge-deep": "^3.0.2",
+ "minimatch": "^3.0.4",
+ "node-fetch": "^2.6.0",
+ "portfinder": "^1.0.25",
+ "simple-websocket": "^8.1.1",
+ "yaml-ast-parser": "0.0.43"
+ }
+ },
+ "@types/color-name": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz",
+ "integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ=="
+ },
+ "ansi-styles": {
+ "version": "4.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz",
+ "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==",
+ "requires": {
+ "@types/color-name": "^1.1.1",
+ "color-convert": "^2.0.1"
+ }
+ },
+ "anymatch": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.1.tgz",
+ "integrity": "sha512-mM8522psRCqzV+6LhomX5wgp25YVibjh8Wj23I5RPkPppSVSjyKD2A2mBJmWGa+KN7f2D6LNh9jkBCeyLktzjg==",
+ "requires": {
+ "normalize-path": "^3.0.0",
+ "picomatch": "^2.0.4"
+ }
+ },
+ "argparse": {
+ "version": "1.0.10",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
+ "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
+ "requires": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "arr-union": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz",
+ "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ="
+ },
+ "async": {
+ "version": "2.6.3",
+ "resolved": "https://registry.npmjs.org/async/-/async-2.6.3.tgz",
+ "integrity": "sha512-zflvls11DCy+dQWzTW2dzuilv8Z5X/pjfmZOWba6TNIVDm+2UDaJmXSOXlasHKfNBs8oo3M0aT50fDEWfKZjXg==",
+ "requires": {
+ "lodash": "^4.17.14"
+ }
+ },
+ "balanced-match": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
+ "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c="
+ },
+ "binary-extensions": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.0.0.tgz",
+ "integrity": "sha512-Phlt0plgpIIBOGTT/ehfFnbNlfsDEiqmzE2KRXoX1bLIlir4X/MR+zSyBEkL05ffWgnRSf/DXv+WrUAVr93/ow=="
+ },
+ "brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "requires": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "requires": {
+ "fill-range": "^7.0.1"
+ }
+ },
+ "chalk": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz",
+ "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==",
+ "requires": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ }
+ },
+ "chokidar": {
+ "version": "3.4.0",
+ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.4.0.tgz",
+ "integrity": "sha512-aXAaho2VJtisB/1fg1+3nlLJqGOuewTzQpd/Tz0yTg2R0e4IGtshYvtjowyEumcBv2z+y4+kc75Mz7j5xJskcQ==",
+ "requires": {
+ "anymatch": "~3.1.1",
+ "braces": "~3.0.2",
+ "fsevents": "~2.1.2",
+ "glob-parent": "~5.1.0",
+ "is-binary-path": "~2.1.0",
+ "is-glob": "~4.0.1",
+ "normalize-path": "~3.0.0",
+ "readdirp": "~3.4.0"
+ }
+ },
+ "clone-deep": {
+ "version": "0.2.4",
+ "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-0.2.4.tgz",
+ "integrity": "sha1-TnPdCen7lxzDhnDF3O2cGJZIHMY=",
+ "requires": {
+ "for-own": "^0.1.3",
+ "is-plain-object": "^2.0.1",
+ "kind-of": "^3.0.2",
+ "lazy-cache": "^1.0.3",
+ "shallow-clone": "^0.1.2"
+ }
+ },
+ "color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "requires": {
+ "color-name": "~1.1.4"
+ }
+ },
+ "color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "commander": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz",
+ "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg=="
+ },
+ "concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
+ },
+ "debug": {
+ "version": "3.2.6",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz",
+ "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==",
+ "requires": {
+ "ms": "^2.1.1"
+ }
+ },
+ "esprima": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
+ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A=="
+ },
+ "fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "requires": {
+ "to-regex-range": "^5.0.1"
+ }
+ },
+ "for-in": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz",
+ "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA="
+ },
+ "for-own": {
+ "version": "0.1.5",
+ "resolved": "https://registry.npmjs.org/for-own/-/for-own-0.1.5.tgz",
+ "integrity": "sha1-UmXGgaTylNq78XyVCbZ2OqhFEM4=",
+ "requires": {
+ "for-in": "^1.0.1"
+ }
+ },
+ "fsevents": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.1.3.tgz",
+ "integrity": "sha512-Auw9a4AxqWpa9GUfj370BMPzzyncfBABW8Mab7BGWBYDj4Isgq+cDKtx0i6u9jcX9pQDnswsaaOTgTmA5pEjuQ==",
+ "optional": true
+ },
+ "glob-parent": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz",
+ "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==",
+ "requires": {
+ "is-glob": "^4.0.1"
+ }
+ },
+ "handlebars": {
+ "version": "4.7.6",
+ "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.6.tgz",
+ "integrity": "sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==",
+ "requires": {
+ "minimist": "^1.2.5",
+ "neo-async": "^2.6.0",
+ "source-map": "^0.6.1",
+ "uglify-js": "^3.1.4",
+ "wordwrap": "^1.0.0"
+ }
+ },
+ "has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
+ },
+ "inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "is-binary-path": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz",
+ "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==",
+ "requires": {
+ "binary-extensions": "^2.0.0"
+ }
+ },
+ "is-buffer": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz",
+ "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w=="
+ },
+ "is-extendable": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz",
+ "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik="
+ },
+ "is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI="
+ },
+ "is-glob": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz",
+ "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==",
+ "requires": {
+ "is-extglob": "^2.1.1"
+ }
+ },
+ "is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="
+ },
+ "is-plain-object": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
+ "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==",
+ "requires": {
+ "isobject": "^3.0.1"
+ }
+ },
+ "isobject": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
+ },
+ "js-yaml": {
+ "version": "3.14.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.0.tgz",
+ "integrity": "sha512-/4IbIeHcD9VMHFqDR/gQ7EdZdLimOvW2DdcxFjdyyZ9NsbS+ccrXqVWDtab/lRl5AlUqmpBx8EhPaWR+OtY17A==",
+ "requires": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ }
+ },
+ "kind-of": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
+ "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
+ "requires": {
+ "is-buffer": "^1.1.5"
+ }
+ },
+ "lazy-cache": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/lazy-cache/-/lazy-cache-1.0.4.tgz",
+ "integrity": "sha1-odePw6UEdMuAhF07O24dpJpEbo4="
+ },
+ "lodash": {
+ "version": "4.17.15",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
+ "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+ },
+ "lodash.isequal": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+ "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA="
+ },
+ "merge-deep": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/merge-deep/-/merge-deep-3.0.2.tgz",
+ "integrity": "sha512-T7qC8kg4Zoti1cFd8Cr0M+qaZfOwjlPDEdZIIPPB2JZctjaPM4fX+i7HOId69tAti2fvO6X5ldfYUONDODsrkA==",
+ "requires": {
+ "arr-union": "^3.1.0",
+ "clone-deep": "^0.2.4",
+ "kind-of": "^3.0.2"
+ }
+ },
+ "minimatch": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+ "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+ "requires": {
+ "brace-expansion": "^1.1.7"
+ }
+ },
+ "minimist": {
+ "version": "1.2.5",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
+ "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+ },
+ "mixin-object": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/mixin-object/-/mixin-object-2.0.1.tgz",
+ "integrity": "sha1-T7lJRB2rGCVA8f4DW6YOGUel5X4=",
+ "requires": {
+ "for-in": "^0.1.3",
+ "is-extendable": "^0.1.1"
+ },
+ "dependencies": {
+ "for-in": {
+ "version": "0.1.8",
+ "resolved": "https://registry.npmjs.org/for-in/-/for-in-0.1.8.tgz",
+ "integrity": "sha1-2Hc5COMSVhCZUrH9ubP6hn0ndeE="
+ }
+ }
+ },
+ "mkdirp": {
+ "version": "0.5.5",
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.5.tgz",
+ "integrity": "sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==",
+ "requires": {
+ "minimist": "^1.2.5"
+ }
+ },
+ "ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "neo-async": {
+ "version": "2.6.1",
+ "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.1.tgz",
+ "integrity": "sha512-iyam8fBuCUpWeKPGpaNMetEocMt364qkCsfL9JuhjXX6dRnguRVOfk2GZaDpPjcOKiiXCPINZC1GczQ7iTq3Zw=="
+ },
+ "node-fetch": {
+ "version": "2.6.0",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz",
+ "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA=="
+ },
+ "normalize-path": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
+ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA=="
+ },
+ "picomatch": {
+ "version": "2.2.2",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz",
+ "integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg=="
+ },
+ "portfinder": {
+ "version": "1.0.26",
+ "resolved": "https://registry.npmjs.org/portfinder/-/portfinder-1.0.26.tgz",
+ "integrity": "sha512-Xi7mKxJHHMI3rIUrnm/jjUgwhbYMkp/XKEcZX3aG4BrumLpq3nmoQMX+ClYnDZnZ/New7IatC1no5RX0zo1vXQ==",
+ "requires": {
+ "async": "^2.6.2",
+ "debug": "^3.1.1",
+ "mkdirp": "^0.5.1"
+ }
+ },
+ "queue-microtask": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.1.2.tgz",
+ "integrity": "sha512-F9wwNePtXrzZenAB3ax0Y8TSKGvuB7Qw16J30hspEUTbfUM+H827XyN3rlpwhVmtm5wuZtbKIHjOnwDn7MUxWQ=="
+ },
+ "randombytes": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz",
+ "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==",
+ "requires": {
+ "safe-buffer": "^5.1.0"
+ }
+ },
+ "readable-stream": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz",
+ "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==",
+ "requires": {
+ "inherits": "^2.0.3",
+ "string_decoder": "^1.1.1",
+ "util-deprecate": "^1.0.1"
+ }
+ },
+ "readdirp": {
+ "version": "3.4.0",
+ "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.4.0.tgz",
+ "integrity": "sha512-0xe001vZBnJEK+uKcj8qOhyAKPzIT+gStxWr3LCB0DwcXR5NZJ3IaC+yGnHCYzB/S7ov3m3EEbZI2zeNvX+hGQ==",
+ "requires": {
+ "picomatch": "^2.2.1"
+ }
+ },
+ "safe-buffer": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
+ "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ=="
+ },
+ "shallow-clone": {
+ "version": "0.1.2",
+ "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-0.1.2.tgz",
+ "integrity": "sha1-WQnodLp3EG1zrEFM/sH/yofZcGA=",
+ "requires": {
+ "is-extendable": "^0.1.1",
+ "kind-of": "^2.0.1",
+ "lazy-cache": "^0.2.3",
+ "mixin-object": "^2.0.1"
+ },
+ "dependencies": {
+ "kind-of": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-2.0.1.tgz",
+ "integrity": "sha1-AY7HpM5+OobLkUG+UZ0kyPqpgbU=",
+ "requires": {
+ "is-buffer": "^1.0.2"
+ }
+ },
+ "lazy-cache": {
+ "version": "0.2.7",
+ "resolved": "https://registry.npmjs.org/lazy-cache/-/lazy-cache-0.2.7.tgz",
+ "integrity": "sha1-f+3fLctu23fRHvHRF6tf/fCrG2U="
+ }
+ }
+ },
+ "simple-websocket": {
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/simple-websocket/-/simple-websocket-8.1.1.tgz",
+ "integrity": "sha512-06I3cwOD5Q3LdVd6qfyDGp1U9eau9x9qniSL3b/aDgM5bsJX4nZfCuii2UCFcTfrDq0jCXF4NQ/38qeC8CJZTg==",
+ "requires": {
+ "debug": "^4.1.1",
+ "queue-microtask": "^1.1.0",
+ "randombytes": "^2.0.3",
+ "readable-stream": "^3.1.1",
+ "ws": "^7.0.0"
+ },
+ "dependencies": {
+ "debug": {
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz",
+ "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
+ "requires": {
+ "ms": "^2.1.1"
+ }
+ }
+ }
+ },
+ "source-map": {
+ "version": "0.6.1",
+ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+ "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g=="
+ },
+ "sprintf-js": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
+ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
+ },
+ "string_decoder": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
+ "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==",
+ "requires": {
+ "safe-buffer": "~5.2.0"
+ }
+ },
+ "supports-color": {
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz",
+ "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==",
+ "requires": {
+ "has-flag": "^4.0.0"
+ }
+ },
+ "to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "requires": {
+ "is-number": "^7.0.0"
+ }
+ },
+ "uglify-js": {
+ "version": "3.9.3",
+ "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.3.tgz",
+ "integrity": "sha512-r5ImcL6QyzQGVimQoov3aL2ZScywrOgBXGndbWrdehKoSvGe/RmiE5Jpw/v+GvxODt6l2tpBXwA7n+qZVlHBMA==",
+ "optional": true,
+ "requires": {
+ "commander": "~2.20.3"
+ },
+ "dependencies": {
+ "commander": {
+ "version": "2.20.3",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz",
+ "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==",
+ "optional": true
+ }
+ }
+ },
+ "util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
+ },
+ "wordwrap": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+ "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus="
+ },
+ "ws": {
+ "version": "7.3.0",
+ "resolved": "https://registry.npmjs.org/ws/-/ws-7.3.0.tgz",
+ "integrity": "sha512-iFtXzngZVXPGgpTlP1rBqsUK82p9tKqsWRPg5L56egiljujJT3vGAYnHANvFxBieXrTFavhzhxW52jnaWV+w2w=="
+ },
+ "yaml-ast-parser": {
+ "version": "0.0.43",
+ "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz",
+ "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A=="
+ }
+ }
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..84df584
--- /dev/null
+++ b/package.json
@@ -0,0 +1,13 @@
+{
+ "name": "mieux-voter",
+ "version": "1.0.0",
+ "dependencies": {
+ "@redocly/openapi-cli": "^0.12.10"
+ },
+ "private": true,
+ "scripts": {
+ "start": "openapi preview-docs",
+ "build": "openapi bundle -o dist",
+ "test": "openapi validate"
+ }
+}