From 9c66f787125fe70d8705f652f192539fb5ee9c9b Mon Sep 17 00:00:00 2001 From: domi41 Date: Sun, 6 Sep 2020 09:25:41 +0200 Subject: [PATCH] docs: add a basic description of the API, as a markdown file --- openapi/DESCRIPTION.md | 35 +++++++++++++++++++++++++++++++++++ openapi/mv-openapi-root.yaml | 5 +++-- 2 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 openapi/DESCRIPTION.md diff --git a/openapi/DESCRIPTION.md b/openapi/DESCRIPTION.md new file mode 100644 index 0000000..0ed05cf --- /dev/null +++ b/openapi/DESCRIPTION.md @@ -0,0 +1,35 @@ +## What is this? + +An _Application Programming Interface_ (API) for a polling application +using **Majority Judgment**. + +You are looking at the specifications of the communication between server and clients, usually because you want to make your own client. + +### Help, I'm lost! + +Best head to the official application client, then: +[Application MieuxVoter](https://app.mieuxvoter.fr). +See you there ! + + +## What is Majority Judgment? + +We believe that it is the most elegant polling system that is available right now. + +It was discovered in 2002 by 🇫🇷 french researchers, and it comes from 🍷 wine 🏆 contests. + + +## Contributing + +### I've found a bug! + +Head over to our [issues tracker](https://github.com/MieuxVoter/mv-api-spec/issues) with your ideas and contributions. + +### But I don't understand code! + +It's okay, we need everyone! +There's lots you can do to help, such as translating, documenting, reporting issues, painting pixels, promoting majority judgment… + +### Shut up and take my money! + +Donations help us boost development : [Donate](https://mieuxvoter.fr/index.php/participer/). diff --git a/openapi/mv-openapi-root.yaml b/openapi/mv-openapi-root.yaml index 95e5a20..2b10b24 100644 --- a/openapi/mv-openapi-root.yaml +++ b/openapi/mv-openapi-root.yaml @@ -1,7 +1,8 @@ openapi: 3.0.0 info: - title: Mieux Voter - description: A poll application based on Majority Judgment. + title: API Mieux Voter + description: + $ref: 'DESCRIPTION.md' version: 1.0.1-oas3 termsOfService: 'https://github.com/MieuxVoter' contact: