From 4244cee8d5e0f760cccd2b45ad587670573ef03c Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 24 Sep 2018 19:20:10 +0900 Subject: Prepare for CS API 0.4.0 This commit consists of two parts: upgrading the API infrastructure and trivial but sweeping update to the generated files. 1. The API infrastructure (converters.h, *.mustache and some other non-generated files) now can deal with top-level JSON arrays and response inlining; better supports property maps; and gets some formatting fixes in generated code. 2. Generated files now use QJsonValue instead of QJsonObject as a default type to (un)marshall Matrix API data structures, to match the change in the infrastructure above This commit is still using the old Matrix API definitions, before CS API 0.4.0. Getting to CS API 0.4.0 will come next. --- lib/csapi/third_party_lookup.h | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'lib/csapi/third_party_lookup.h') diff --git a/lib/csapi/third_party_lookup.h b/lib/csapi/third_party_lookup.h index 03d607a8..5ebe5864 100644 --- a/lib/csapi/third_party_lookup.h +++ b/lib/csapi/third_party_lookup.h @@ -18,7 +18,7 @@ namespace QMatrixClient // Operations /// Retrieve metadata about all protocols that a homeserver supports. - /// + /// /// Fetches the overall metadata about protocols supported by the /// homeserver. Includes both the available protocols and all fields /// required for queries against each protocol. @@ -51,13 +51,13 @@ namespace QMatrixClient }; /// Retrieve metadata about a specific protocol that the homeserver supports. - /// + /// /// Fetches the metadata from the homeserver about a particular third party protocol. class GetProtocolMetadataJob : public BaseJob { public: /*! Retrieve metadata about a specific protocol that the homeserver supports. - * \param protocol + * \param protocol * The name of the protocol. */ explicit GetProtocolMetadataJob(const QString& protocol); @@ -86,7 +86,7 @@ namespace QMatrixClient }; /// Retreive Matrix-side portals rooms leading to a third party location. - /// + /// /// Requesting this endpoint with a valid protocol name results in a list /// of successful mapping results in a JSON array. Each result contains /// objects to represent the Matrix room or rooms that represent a portal @@ -99,9 +99,9 @@ namespace QMatrixClient { public: /*! Retreive Matrix-side portals rooms leading to a third party location. - * \param protocol + * \param protocol * The protocol used to communicate to the third party network. - * \param searchFields + * \param searchFields * One or more custom fields to help identify the third party * location. */ @@ -131,16 +131,16 @@ namespace QMatrixClient }; /// Retrieve the Matrix User ID of a corresponding third party user. - /// + /// /// Retrieve a Matrix User ID linked to a user on the third party service, given /// a set of user parameters. class QueryUserByProtocolJob : public BaseJob { public: /*! Retrieve the Matrix User ID of a corresponding third party user. - * \param protocol + * \param protocol * The name of the protocol. - * \param fields + * \param fields * One or more custom fields that are passed to the AS to help identify the user. */ explicit QueryUserByProtocolJob(const QString& protocol, const QString& fields = {}); @@ -169,14 +169,14 @@ namespace QMatrixClient }; /// Reverse-lookup third party locations given a Matrix room alias. - /// + /// /// Retreive an array of third party network locations from a Matrix room /// alias. class QueryLocationByAliasJob : public BaseJob { public: /*! Reverse-lookup third party locations given a Matrix room alias. - * \param alias + * \param alias * The Matrix room alias to look up. */ explicit QueryLocationByAliasJob(const QString& alias); @@ -205,13 +205,13 @@ namespace QMatrixClient }; /// Reverse-lookup third party users given a Matrix User ID. - /// + /// /// Retreive an array of third party users from a Matrix User ID. class QueryUserByIDJob : public BaseJob { public: /*! Reverse-lookup third party users given a Matrix User ID. - * \param userid + * \param userid * The Matrix User ID to look up. */ explicit QueryUserByIDJob(const QString& userid); -- cgit v1.2.3 From 1e6510790dab6b9141ae52993987b406399668cd Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sun, 2 Sep 2018 16:08:13 +0900 Subject: Support CS API 0.4.0 Numerous changes in CS (and now also AS) API, including compatibility-breaking ones - see the diff for details. --- lib/csapi/third_party_lookup.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'lib/csapi/third_party_lookup.h') diff --git a/lib/csapi/third_party_lookup.h b/lib/csapi/third_party_lookup.h index 5ebe5864..3a60432b 100644 --- a/lib/csapi/third_party_lookup.h +++ b/lib/csapi/third_party_lookup.h @@ -85,7 +85,7 @@ namespace QMatrixClient QScopedPointer d; }; - /// Retreive Matrix-side portals rooms leading to a third party location. + /// Retrieve Matrix-side portals rooms leading to a third party location. /// /// Requesting this endpoint with a valid protocol name results in a list /// of successful mapping results in a JSON array. Each result contains @@ -98,7 +98,7 @@ namespace QMatrixClient class QueryLocationByProtocolJob : public BaseJob { public: - /*! Retreive Matrix-side portals rooms leading to a third party location. + /*! Retrieve Matrix-side portals rooms leading to a third party location. * \param protocol * The protocol used to communicate to the third party network. * \param searchFields @@ -170,7 +170,7 @@ namespace QMatrixClient /// Reverse-lookup third party locations given a Matrix room alias. /// - /// Retreive an array of third party network locations from a Matrix room + /// Retrieve an array of third party network locations from a Matrix room /// alias. class QueryLocationByAliasJob : public BaseJob { @@ -206,7 +206,7 @@ namespace QMatrixClient /// Reverse-lookup third party users given a Matrix User ID. /// - /// Retreive an array of third party users from a Matrix User ID. + /// Retrieve an array of third party users from a Matrix User ID. class QueryUserByIDJob : public BaseJob { public: -- cgit v1.2.3