Skip to content
Snippets Groups Projects
Commit 2d6d1086 authored by Eric Poirier's avatar Eric Poirier
Browse files

Update Mailing List documentation


Change-Id: I0811ea91c4a20995c04c8bae1977af5aae73ce54
Signed-off-by: default avatarEric Poirier <eric.poirier@eclipse-foundation.org>
parent d53bc509
No related branches found
No related tags found
No related merge requests found
...@@ -205,8 +205,8 @@ are used.</p> ...@@ -205,8 +205,8 @@ are used.</p>
] ]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted"> </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">
Copyright &copy; Copyright &copy;
2018 2019
The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 12 Jun 2018</p><script>/* eslint-env browser */ The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 23 Jan 2019</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
This diff is collapsed.
...@@ -120,8 +120,8 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> ...@@ -120,8 +120,8 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p>Please note that these are not on production and ready to use.</p> <p>Please note that these are not on production and ready to use.</p>
</div></div></div><p style="text-align: center;" class="text-muted"> </div></div></div><p style="text-align: center;" class="text-muted">
Copyright &copy; Copyright &copy;
2018 2019
The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 15 May 2018</p><script>/* eslint-env browser */ The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 23 Jan 2019</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
Eclipse Mailing Lists are available through this resource. Eclipse Mailing Lists are available through this resource.
## Fetch Mailing lists Metadata [GET /mailing_lists/metadata{?name,search,page,pagesize,order_by}] ## Fetch Mailing lists [GET /foundation/mailing-list{?search,page,pagesize,order_by}]
### Overview ### Overview
...@@ -11,11 +11,17 @@ Retrieve metadata for all the mailing lists. ...@@ -11,11 +11,17 @@ Retrieve metadata for all the mailing lists.
### Result definition ### Result definition
+ **list_name:** name of the mailing list + **list_name:** name of the mailing list
+ **list_description:** description of the mailing list
+ **project_id:** Id of the project related to the mailing list
+ **list_short_description:** short description of the mailing list
+ **is_disabled:** if the mailing list is disabled
+ **is_deleted:** if the mailing list is deleted
+ **is_subscribable:** if the mailing list is subscribable
+ **create_date:** the date the mailing list was created
+ **url:** url of the mailing list + **url:** url of the mailing list
+ **email:** email of the mailing list + **email:** email of the mailing list
+ Parameters + Parameters
+ name (string, optional) - The name of a specific mailing list
+ search (string, optional) - A keyword to search for in a mailing list name + search (string, optional) - A keyword to search for in a mailing list name
+ page (integer, optional) - The index of the page to get, defaults to 1. + page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100. + pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
...@@ -23,13 +29,46 @@ Retrieve metadata for all the mailing lists. ...@@ -23,13 +29,46 @@ Retrieve metadata for all the mailing lists.
+ Response 200 (application/json) + Response 200 (application/json)
+ Headers + Headers
Link:<https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=20>; rel="next", <https://api.eclipse.org/mailing_lists/metadata?page=99&amp;pagesize=5>; rel="last", <https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=5>; rel="self" Link:<https://api.eclipse.org/foundation/mailing-list?page=1&amp;pagesize=20>; rel="next", <https://api.eclipse.org/foundation/mailing-list?page=99&amp;pagesize=5>; rel="last", <https://api.eclipse.org/foundation/mailing-list?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/foundation/mailing-list?page=1&amp;pagesize=5>; rel="self"
X-Rate-Limit-Limit: 1000 X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 964 X-Rate-Limit-Remaining: 964
X-Rate-Limit-Reset: 3553 X-Rate-Limit-Reset: 3553
Content-Type: application/json Content-Type: application/json
+ Body + Body
[{"list_name":"example-list1","url":"https://accounts.eclipse.org/mailing-list/example-list1","email":"example-list1@eclipse.org"},{"list_name":"example-list2","url":"https://accounts.eclipse.org/mailing-list/example-list2","email":"example-list2@eclipse.org"}] [{"list_name":"dash-dev","list_description":"Tools for Committer Community","project_id":"","list_short_description":null,"is_disabled":"0","is_deleted":"0","is_subscribable":"1","create_date":null,"url":"https://accounts.eclipse.org/mailing-list/dash-dev","email":"dash-dev@eclipse.org"}]
## Retrieve Mailing List [GET /foundation/mailing-list/{mailing_list_id}]
### Overview
Retrieve information for a specific mailing list
### Result definition
+ **list_name:** name of the mailing list
+ **list_description:** description of the mailing list
+ **project_id:** Id of the project related to the mailing list
+ **list_short_description:** short description of the mailing list
+ **is_disabled:** if the mailing list is disabled
+ **is_deleted:** if the mailing list is deleted
+ **is_subscribable:** if the mailing list is subscribable
+ **create_date:** the date the mailing list was created
+ **url:** url of the mailing list
+ **email:** email of the mailing list
+ Parameters
+ name (integer) - Name of the mailing list
+ Response 200 (application/json)
+ Headers
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 964
X-Rate-Limit-Reset: 3553
Content-Type: application/json
+ Body
[{"list_name":"dash-dev","list_description":"Tools for Committer Community","project_id":"","list_short_description":null,"is_disabled":"0","is_deleted":"0","is_subscribable":"1","create_date":null,"url":"https://accounts.eclipse.org/mailing-list/dash-dev","email":"dash-dev@eclipse.org"}]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment