Unified REST API docs #3780
Unified REST API docs #3780
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Codecov ReportBase: 82.92% // Head: 82.90% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## feature/unified-rest-api #3780 +/- ##
============================================================
- Coverage 82.92% 82.90% -0.03%
============================================================
Files 529 529
Lines 33761 33761
============================================================
- Hits 27996 27988 -8
- Misses 5765 5773 +8
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
small_tests_24 / small_tests / b7e8518 small_tests_25 / small_tests / b7e8518 ldap_mnesia_24 / ldap_mnesia / b7e8518 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / b7e8518 dynamic_domains_mysql_redis_25 / mysql_redis / b7e8518 ldap_mnesia_25 / ldap_mnesia / b7e8518 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / b7e8518 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / b7e8518 internal_mnesia_25 / internal_mnesia / b7e8518 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / b7e8518 pgsql_mnesia_25 / pgsql_mnesia / b7e8518 mysql_redis_25 / mysql_redis / b7e8518 riak_mnesia_24 / riak_mnesia / b7e8518 mssql_mnesia_25 / odbc_mssql_mnesia / b7e8518 muc_SUITE:hibernation:hibernated_room_can_be_queried_for_archive{error,{{assertion_failed,assert,is_groupchat_message,
[<<"Restorable message">>],
undefined,"undefined"},
[{escalus_new_assert,assert_true,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
{line,84}]},
{muc_SUITE,wait_for_mam_result,3,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4394}]},
{muc_SUITE,'-hibernated_room_can_be_queried_for_archive/1-fun-0-',3,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4130}]},
{escalus_story,story,4,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{muc_SUITE,hibernated_room_can_be_queried_for_archive,1,
[{file,"/home/circleci/project/big_tests/tests/muc_SUITE.erl"},
{line,4126}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}} |
|
small_tests_24 / small_tests / ea4028c small_tests_25 / small_tests / ea4028c dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / ea4028c ldap_mnesia_24 / ldap_mnesia / ea4028c ldap_mnesia_25 / ldap_mnesia / ea4028c dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / ea4028c dynamic_domains_mysql_redis_25 / mysql_redis / ea4028c internal_mnesia_25 / internal_mnesia / ea4028c elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / ea4028c dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / ea4028c pgsql_mnesia_24 / pgsql_mnesia / ea4028c pgsql_mnesia_25 / pgsql_mnesia / ea4028c pep_SUITE:pep_tests:unsubscribe_after_presence_unsubscription{error,
{{badmatch,
[{xmlel,<<"message">>,
[{<<"from">>,
<<"alice_unsubscribe_after_presence_unsubscription_2514@localhost">>},
{<<"to">>,
<<"bob_unsubscribe_after_presence_unsubscription_2514@localhost/res1">>},
{<<"type">>,<<"headline">>}],
[{xmlel,<<"event">>,
[{<<"xmlns">>,
<<"http://jabber.org/protocol/pubsub#event">>}],
[{xmlel,<<"items">>,
[{<<"node">>,<<"ULEGwFWPB8kjUusGbIJjFw==">>}],
[{xmlel,<<"item">>,
[{<<"id">>,<<"salmon">>}],
[{xmlel,<<"entry">>,
[{<<"xmlns">>,
<<"http://www.w3.org/2005/Atom">>}],
[]}]}]}]},
{xmlel,<<"headers">>,
[{<<"xmlns">>,<<"http://jabber.org/protocol/shim">>}],
[]}]}]},
[{pep_SUITE,'-unsubscribe_after_presence_unsubscription/1-fun-0-',2,
[{file,"/home/circleci/project/big_tests/tests/pep_SUITE.erl"},
{line,384}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}}riak_mnesia_24 / riak_mnesia / ea4028c mysql_redis_25 / mysql_redis / ea4028c mssql_mnesia_25 / odbc_mssql_mnesia / ea4028c pep_SUITE:pep_tests:unsubscribe_after_presence_unsubscription{error,
{{badmatch,
[{xmlel,<<"message">>,
[{<<"from">>,
<<"alice_unsubscribe_after_presence_unsubscription_2526@localhost">>},
{<<"to">>,
<<"bob_unsubscribe_after_presence_unsubscription_2526@localhost/res1">>},
{<<"type">>,<<"headline">>}],
[{xmlel,<<"event">>,
[{<<"xmlns">>,
<<"http://jabber.org/protocol/pubsub#event">>}],
[{xmlel,<<"items">>,
[{<<"node">>,<<"L358OvAdssX403I6AAeG8A==">>}],
[{xmlel,<<"item">>,
[{<<"id">>,<<"salmon">>}],
[{xmlel,<<"entry">>,
[{<<"xmlns">>,
<<"http://www.w3.org/2005/Atom">>}],
[]}]}]}]},
{xmlel,<<"headers">>,
[{<<"xmlns">>,<<"http://jabber.org/protocol/shim">>}],
[]}]}]},
[{pep_SUITE,'-unsubscribe_after_presence_unsubscription/1-fun-0-',2,
[{file,"/home/circleci/project/big_tests/tests/pep_SUITE.erl"},
{line,384}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}} |
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
from
ea4028c
to
a46938b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
2 times, most recently
from
50c32ed
to
4d08062
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
small_tests_24 / small_tests / 4d08062 small_tests_25 / small_tests / 4d08062 ldap_mnesia_24 / ldap_mnesia / 4d08062 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 4d08062 ldap_mnesia_25 / ldap_mnesia / 4d08062 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 4d08062 dynamic_domains_mysql_redis_25 / mysql_redis / 4d08062 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 4d08062 internal_mnesia_25 / internal_mnesia / 4d08062 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 4d08062 pgsql_mnesia_24 / pgsql_mnesia / 4d08062 pep_SUITE:pep_tests:unsubscribe_after_presence_unsubscription{error,
{{badmatch,
[{xmlel,<<"message">>,
[{<<"from">>,
<<"alice_unsubscribe_after_presence_unsubscription_2521@localhost">>},
{<<"to">>,
<<"bob_unsubscribe_after_presence_unsubscription_2521@localhost/res1">>},
{<<"type">>,<<"headline">>}],
[{xmlel,<<"event">>,
[{<<"xmlns">>,
<<"http://jabber.org/protocol/pubsub#event">>}],
[{xmlel,<<"items">>,
[{<<"node">>,<<"Iu9cXoI3byj4j1i3/wJVgQ==">>}],
[{xmlel,<<"item">>,
[{<<"id">>,<<"salmon">>}],
[{xmlel,<<"entry">>,
[{<<"xmlns">>,
<<"http://www.w3.org/2005/Atom">>}],
[]}]}]}]},
{xmlel,<<"headers">>,
[{<<"xmlns">>,<<"http://jabber.org/protocol/shim">>}],
[]}]}]},
[{pep_SUITE,'-unsubscribe_after_presence_unsubscription/1-fun-0-',2,
[{file,"/home/circleci/project/big_tests/tests/pep_SUITE.erl"},
{line,384}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1292}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1224}]}]}}pgsql_mnesia_25 / pgsql_mnesia / 4d08062 mysql_redis_25 / mysql_redis / 4d08062 riak_mnesia_24 / riak_mnesia / 4d08062 mssql_mnesia_25 / odbc_mssql_mnesia / 4d08062 |
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
2 times, most recently
from
d5f73c6
to
3ea5a14
Compare
|
small_tests_24 / small_tests / d5f73c6 small_tests_25 / small_tests / d5f73c6 ldap_mnesia_24 / ldap_mnesia / d5f73c6 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / d5f73c6 dynamic_domains_mysql_redis_25 / mysql_redis / d5f73c6 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / d5f73c6 ldap_mnesia_25 / ldap_mnesia / d5f73c6 internal_mnesia_25 / internal_mnesia / d5f73c6 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / d5f73c6 pgsql_mnesia_24 / pgsql_mnesia / d5f73c6 pgsql_mnesia_25 / pgsql_mnesia / d5f73c6 mysql_redis_25 / mysql_redis / d5f73c6 riak_mnesia_24 / riak_mnesia / d5f73c6 mssql_mnesia_25 / odbc_mssql_mnesia / d5f73c6 |
|
small_tests_24 / small_tests / 3ea5a14 small_tests_25 / small_tests / 3ea5a14 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 3ea5a14 ldap_mnesia_24 / ldap_mnesia / 3ea5a14 ldap_mnesia_25 / ldap_mnesia / 3ea5a14 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 3ea5a14 dynamic_domains_mysql_redis_25 / mysql_redis / 3ea5a14 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 3ea5a14 internal_mnesia_25 / internal_mnesia / 3ea5a14 pgsql_mnesia_24 / pgsql_mnesia / 3ea5a14 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 3ea5a14 pgsql_mnesia_25 / pgsql_mnesia / 3ea5a14 mysql_redis_25 / mysql_redis / 3ea5a14 riak_mnesia_24 / riak_mnesia / 3ea5a14 mssql_mnesia_25 / odbc_mssql_mnesia / 3ea5a14 pep_SUITE:pep_tests:unsubscribe_after_presence_unsubscription{error,
{{badmatch,
[{xmlel,<<"message">>,
[{<<"from">>,
<<"alice_unsubscribe_after_presence_unsubscription_2529@localhost">>},
{<<"to">>,
<<"bob_unsubscribe_after_presence_unsubscription_2529@localhost/res1">>},
{<<"type">>,<<"headline">>}],
[{xmlel,<<"event">>,
[{<<"xmlns">>,
<<"http://jabber.org/protocol/pubsub#event">>}],
[{xmlel,<<"items">>,
[{<<"node">>,<<"BS4p2VPXzzRfPgmzfVR3Ng==">>}],
[{xmlel,<<"item">>,
[{<<"id">>,<<"salmon">>}],
[{xmlel,<<"entry">>,
[{<<"xmlns">>,
<<"http://www.w3.org/2005/Atom">>}],
[]}]}]}]},
{xmlel,<<"headers">>,
[{<<"xmlns">>,<<"http://jabber.org/protocol/shim">>}],
[]}]}]},
[{pep_SUITE,'-unsubscribe_after_presence_unsubscription/1-fun-0-',2,
[{file,"/home/circleci/project/big_tests/tests/pep_SUITE.erl"},
{line,384}]},
{escalus_story,story,4,
[{file,
"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,72}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1782}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1291}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1223}]}]}} |
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
from
3ea5a14
to
b009863
Compare
|
small_tests_24 / small_tests / b009863 small_tests_25 / small_tests / b009863 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / b009863 dynamic_domains_mysql_redis_25 / mysql_redis / b009863 ldap_mnesia_25 / ldap_mnesia / b009863 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / b009863 internal_mnesia_25 / internal_mnesia / b009863 pgsql_mnesia_24 / pgsql_mnesia / b009863 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / b009863 ldap_mnesia_24 / ldap_mnesia / b009863 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / b009863 pgsql_mnesia_25 / pgsql_mnesia / b009863 riak_mnesia_24 / riak_mnesia / b009863 mssql_mnesia_25 / odbc_mssql_mnesia / b009863 |
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
from
b009863
to
68d7c60
Compare
Merge the docs with the backend ones, just as the HTTP handlers are merged.
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
from
68d7c60
to
6526b59
Compare
|
small_tests_24 / small_tests / 68d7c60 small_tests_25 / small_tests / 68d7c60 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 68d7c60 ldap_mnesia_24 / ldap_mnesia / 68d7c60 ldap_mnesia_25 / ldap_mnesia / 68d7c60 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 68d7c60 dynamic_domains_mysql_redis_25 / mysql_redis / 68d7c60 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 68d7c60 pgsql_mnesia_24 / pgsql_mnesia / 68d7c60 internal_mnesia_25 / internal_mnesia / 68d7c60 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 68d7c60 pgsql_mnesia_25 / pgsql_mnesia / 68d7c60 mssql_mnesia_25 / odbc_mssql_mnesia / 68d7c60 riak_mnesia_24 / riak_mnesia / 68d7c60 mysql_redis_25 / mysql_redis / 68d7c60 |
|
small_tests_24 / small_tests / 6526b59 small_tests_25 / small_tests / 6526b59 ldap_mnesia_24 / ldap_mnesia / 6526b59 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 6526b59 bosh_SUITE:essential:accept_higher_hold_value{error,
{{assertEqual,
[{module,bosh_SUITE},
{line,251},
{expression,"get_bosh_sessions ( )"},
{expected,[]},
{value,
[{bosh_session,<<"3b2b11e4547a92eb94059d3a380b6f79e9d7c1f9">>,
<8833.5622.0>}]}]},
[{bosh_SUITE,accept_higher_hold_value,1,
[{file,"/home/circleci/project/big_tests/tests/bosh_SUITE.erl"},
{line,251}]},
{test_server,ts_tc,3,[{file,"test_server.erl"},{line,1783}]},
{test_server,run_test_case_eval1,6,
[{file,"test_server.erl"},{line,1292}]},
{test_server,run_test_case_eval,9,
[{file,"test_server.erl"},{line,1224}]}]}}dynamic_domains_mysql_redis_25 / mysql_redis / 6526b59 ldap_mnesia_25 / ldap_mnesia / 6526b59 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 6526b59 internal_mnesia_25 / internal_mnesia / 6526b59 pgsql_mnesia_24 / pgsql_mnesia / 6526b59 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 6526b59 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 6526b59 pgsql_mnesia_25 / pgsql_mnesia / 6526b59 mysql_redis_25 / mysql_redis / 6526b59 riak_mnesia_24 / riak_mnesia / 6526b59 mssql_mnesia_25 / odbc_mssql_mnesia / 6526b59 |
Previously it was plain text, but the Content-Type was application/json This caused issues with the interactive Swagger UI - it displayed "no response from server". Now it displays the errors correctly. Tests don't need changing, because they are decoding JSON automatically, and the result is the same text as before.
They got outdated, and it is difficult to keep the up to date. Moreover, for the remaining operations there are no error examples.
chrzaszcz
force-pushed
the
unified-rest-api-docs
branch
from
6526b59
to
2d4ea88
Compare
|
small_tests_24 / small_tests / 2d4ea88 small_tests_25 / small_tests / 2d4ea88 dynamic_domains_pgsql_mnesia_24 / pgsql_mnesia / 2d4ea88 ldap_mnesia_24 / ldap_mnesia / 2d4ea88 dynamic_domains_mysql_redis_25 / mysql_redis / 2d4ea88 dynamic_domains_pgsql_mnesia_25 / pgsql_mnesia / 2d4ea88 ldap_mnesia_25 / ldap_mnesia / 2d4ea88 internal_mnesia_25 / internal_mnesia / 2d4ea88 pgsql_mnesia_24 / pgsql_mnesia / 2d4ea88 dynamic_domains_mssql_mnesia_25 / odbc_mssql_mnesia / 2d4ea88 elasticsearch_and_cassandra_25 / elasticsearch_and_cassandra_mnesia / 2d4ea88 pgsql_mnesia_25 / pgsql_mnesia / 2d4ea88 riak_mnesia_24 / riak_mnesia / 2d4ea88 mysql_redis_25 / mysql_redis / 2d4ea88 mssql_mnesia_25 / odbc_mssql_mnesia / 2d4ea88 disco_and_caps_SUITE:disco_with_caps:user_can_query_friend_features{error,{{assertion_failed,assert_many,false,[is_roster_set],[],[]},
[{escalus_new_assert,assert_true,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_new_assert.erl"},
{line,84}]},
{escalus_story,'-make_all_clients_friends/1-fun-0-',2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,108}]},
{escalus_utils,'-each_with_index/3-fun-0-',3,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
{line,87}]},
{lists,foldl_1,3,[{file,"lists.erl"},{line,1355}]},
{escalus_utils,'-each_with_index/3-fun-0-',3,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
{line,87}]},
{lists,foldl,3,[{file,"lists.erl"},{line,1350}]},
{escalus_utils,distinct_pairs,2,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_utils.erl"},
{line,60}]},
{escalus_story,make_all_clients_friends,1,
[{file,"/home/circleci/project/big_tests/_build/default/lib/escalus/src/escalus_story.erl"},
{line,106}]}]}} |
Update the docs with new info about the REST API unification.
Key changes:
mod_*commandswas documented.Content-Typewasapplication/json. This was a simple change, and all tests pass as before, because they decode JSON automatically. The client API is not changed similarly, because the code would need some refactoring first, and this would be out of scope. The local Swagger UI started working after the change.