summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGünther Wagner <info@gunibert.de>2022-01-12 18:26:38 +0000
committerGünther Wagner <info@gunibert.de>2022-01-12 18:26:38 +0000
commit6d65d8862ad7d39e55be0adb868c05f194250e74 (patch)
tree46ffe23af55fb90e3199b184b9c820e0f8af0c9a /docs
parent7766d718735270d1c0850685a3c7655a5726d60f (diff)
downloadlibrest-6d65d8862ad7d39e55be0adb868c05f194250e74.tar.gz
OAuth2 Pkce Workflow
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am1
-rw-r--r--docs/librest.toml.in6
-rw-r--r--docs/meson.build17
-rw-r--r--docs/reference/Makefile.am1
-rw-r--r--docs/reference/rest/Makefile.am92
-rw-r--r--docs/reference/rest/meson.build26
-rw-r--r--docs/reference/rest/rest-docs.xml51
-rw-r--r--docs/reference/rest/rest-overrides.txt0
-rw-r--r--docs/reference/rest/rest-sections.txt303
-rw-r--r--docs/reference/rest/rest.types12
10 files changed, 18 insertions, 491 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
deleted file mode 100644
index f3ddc22..0000000
--- a/docs/Makefile.am
+++ /dev/null
@@ -1 +0,0 @@
-SUBDIRS = reference
diff --git a/docs/librest.toml.in b/docs/librest.toml.in
index 4f4c59d..1f95b0b 100644
--- a/docs/librest.toml.in
+++ b/docs/librest.toml.in
@@ -6,7 +6,7 @@ repository_url = "https://gitlab.gnome.org/GNOME/librest.git"
authors = "Günther Wagner"
license = "LGPL-2.1-or-later"
description = "REST client library"
-dependencies = [ "GObject-2.0", "Gio-2.0", "Soup-2.4" ]
+dependencies = [ "GObject-2.0", "Gio-2.0", "Soup-@SOUP_VERSION@" ]
devhelp = true
search_index = true
@@ -20,10 +20,10 @@ search_index = true
description = "GObject interfaces and objects"
docs_url = "https://developer.gnome.org/gio/stable"
- [dependencies."Soup-2.4"]
+ [dependencies."Soup-@SOUP_VERSION@"]
name = "Soup"
description = "HTTP library"
- docs_url = "https://developer.gnome.org/libsoup/stable"
+ docs_url = "https://libsoup.org/libsoup-@SOUP_VERSION@/index.html"
[theme]
name = "basic"
diff --git a/docs/meson.build b/docs/meson.build
index 2eeb084..f2aeb76 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,5 +1,3 @@
-subdir('reference/rest')
-
if get_option('gtk_doc') and get_option('introspection')
dependency('gi-docgen', version: '>= 2021.6',
fallback: ['gi-docgen', 'dummy_dep'],
@@ -11,6 +9,7 @@ if get_option('gtk_doc') and get_option('introspection')
toml_conf = configuration_data()
toml_conf.set('REST_VERSION', meson.project_version())
+ toml_conf.set('SOUP_VERSION', libsoup_api_version)
rest_toml = configure_file(
input: 'librest.toml.in',
@@ -39,5 +38,19 @@ if get_option('gtk_doc') and get_option('introspection')
install_dir: rest_docdir,
)
+ # if get_option('tests')
+ # test('doc-check',
+ # gidocgen,
+ # args: [
+ # 'check',
+ # '--config', rest_toml,
+ # '--add-include-path=@0@'.format(meson.current_build_dir() / '../rest'),
+ # librest_gir[0],
+ # ],
+ # depends: librest_gir[0],
+ # suite: ['docs'],
+ # )
+ # endif
+
endif
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
deleted file mode 100644
index b7e99c2..0000000
--- a/docs/reference/Makefile.am
+++ /dev/null
@@ -1 +0,0 @@
-SUBDIRS = rest
diff --git a/docs/reference/rest/Makefile.am b/docs/reference/rest/Makefile.am
deleted file mode 100644
index a4c690e..0000000
--- a/docs/reference/rest/Makefile.am
+++ /dev/null
@@ -1,92 +0,0 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=rest
-DOC_MODULE_VERSION=@API_VERSION@
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../../rest ../../../rest-extras
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/rest/*.h $(top_srcdir)/rest-extras/*.h
-CFILE_GLOB=$(top_srcdir)/rest/*.c $(top_srcdir)/rest-extras/*.c
-
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=sha1.h rest-private.h rest-proxy-call-private.h oauth-proxy-private.h oauth2-proxy-private.h flickr-proxy-private.h lastfm-proxy-private.h
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GLIB_CFLAGS) $(SOUP_CFLAGS) $(XML_CFLAGS)
-GTKDOC_LIBS=$(top_builddir)/rest/librest-@API_VERSION@.la $(top_builddir)/rest-extras/librest-extras-@API_VERSION@.la \
- $(GLIB_LIBS) $(SOUP_LIBS) $(XML_LIBS)
-
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Comment this out if you want your docs-status tested during 'make check'
-#TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/rest/meson.build b/docs/reference/rest/meson.build
deleted file mode 100644
index d02adf3..0000000
--- a/docs/reference/rest/meson.build
+++ /dev/null
@@ -1,26 +0,0 @@
-gnome.gtkdoc('rest',
- src_dir: [
- include_directories('../../../rest'),
- include_directories('../../../rest-extras'),
- ],
- main_xml: 'rest-docs.xml',
- module_version: librest_api_version,
- dependencies: [
- librest_deps,
- librest_dep,
- librest_extras_dep,
- librest_extras_deps,
- ],
- scan_args: [
- '--rebuild-types',
- ],
- ignore_headers: [
- 'flickr-proxy-private.h',
- 'lastfm-proxy-private.h',
- 'oauth-proxy-private.h',
- 'oauth2-proxy-private.h',
- 'rest-private.h',
- 'rest-proxy-call-private.h',
- 'sha1.h',
- ],
-)
diff --git a/docs/reference/rest/rest-docs.xml b/docs/reference/rest/rest-docs.xml
deleted file mode 100644
index 16f8d87..0000000
--- a/docs/reference/rest/rest-docs.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <bookinfo>
- <title>librest Reference Manual</title>
- </bookinfo>
-
- <chapter>
- <title>Generic Proxies</title>
- <xi:include href="xml/rest-param.xml"/>
- <xi:include href="xml/rest-params.xml"/>
- <xi:include href="xml/rest-proxy.xml"/>
- <xi:include href="xml/rest-proxy-call.xml"/>
- </chapter>
-
- <chapter>
- <title>OAuth Proxies</title>
- <xi:include href="xml/oauth-proxy.xml"/>
- <xi:include href="xml/oauth-proxy-call.xml"/>
- <xi:include href="xml/oauth2-proxy.xml"/>
- <xi:include href="xml/oauth2-proxy-call.xml"/>
- </chapter>
-
- <chapter>
- <title>Service-specific Proxies</title>
- <xi:include href="xml/flickr-proxy.xml"/>
- <xi:include href="xml/flickr-proxy-call.xml"/>
- <xi:include href="xml/lastfm-proxy.xml"/>
- <xi:include href="xml/lastfm-proxy-call.xml"/>
- </chapter>
- <chapter>
- <title>XML Parsing</title>
- <xi:include href="xml/rest-xml-parser.xml"/>
- </chapter>
-
- <chapter>
- <title>Glossaries</title>
- <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
- </chapter>
-
- <index>
- <title>Index of all symbols</title>
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
- </index>
-
- <index role="deprecated">
- <title>Index of deprecated symbols</title>
- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
- </index>
-</book>
diff --git a/docs/reference/rest/rest-overrides.txt b/docs/reference/rest/rest-overrides.txt
deleted file mode 100644
index e69de29..0000000
--- a/docs/reference/rest/rest-overrides.txt
+++ /dev/null
diff --git a/docs/reference/rest/rest-sections.txt b/docs/reference/rest/rest-sections.txt
deleted file mode 100644
index ef4b3e3..0000000
--- a/docs/reference/rest/rest-sections.txt
+++ /dev/null
@@ -1,303 +0,0 @@
-<SECTION>
-<FILE>rest-xml-parser</FILE>
-<TITLE>RestXmlParser</TITLE>
-RestXmlParser
-RestXmlNode
-rest_xml_parser_new
-rest_xml_parser_parse_from_data
-rest_xml_node_ref
-rest_xml_node_unref
-rest_xml_node_get_attr
-rest_xml_node_find
-<SUBSECTION Standard>
-REST_XML_PARSER
-REST_IS_XML_PARSER
-REST_TYPE_XML_PARSER
-rest_xml_parser_get_type
-REST_XML_PARSER_CLASS
-REST_IS_XML_PARSER_CLASS
-REST_XML_PARSER_GET_CLASS
-REST_TYPE_XML_NODE
-rest_xml_node_get_type
-</SECTION>
-
-<SECTION>
-<FILE>rest-proxy-call</FILE>
-<TITLE>RestProxyCall</TITLE>
-RestProxyCall
-REST_PROXY_CALL_ERROR
-RestProxyCallError
-rest_proxy_call_set_method
-rest_proxy_call_get_method
-rest_proxy_call_set_function
-rest_proxy_call_get_function
-rest_proxy_call_add_header
-rest_proxy_call_add_headers
-rest_proxy_call_add_headers_from_valist
-rest_proxy_call_lookup_header
-rest_proxy_call_remove_header
-rest_proxy_call_add_param
-rest_proxy_call_add_param_full
-rest_proxy_call_add_params
-rest_proxy_call_add_params_from_valist
-rest_proxy_call_lookup_param
-rest_proxy_call_remove_param
-rest_proxy_call_get_params
-rest_proxy_call_run
-RestProxyCallAsyncCallback
-RestProxyCallUploadCallback
-rest_proxy_call_async
-rest_proxy_call_cancel
-rest_proxy_call_sync
-rest_proxy_call_upload
-rest_proxy_call_invoke_async
-rest_proxy_call_lookup_response_header
-rest_proxy_call_get_response_headers
-rest_proxy_call_get_payload_length
-rest_proxy_call_get_payload
-rest_proxy_call_get_status_code
-rest_proxy_call_get_status_message
-<SUBSECTION Standard>
-RestProxyCallPrivate
-REST_PROXY_CALL
-REST_IS_PROXY_CALL
-REST_TYPE_PROXY_CALL
-rest_proxy_call_get_type
-REST_PROXY_CALL_CLASS
-REST_IS_PROXY_CALL_CLASS
-REST_PROXY_CALL_GET_CLASS
-rest_proxy_call_error_quark
-</SECTION>
-
-<SECTION>
-<FILE>oauth2-proxy</FILE>
-<TITLE>OAuth2Proxy</TITLE>
-OAuth2Proxy
-oauth2_proxy_new
-oauth2_proxy_new_with_token
-oauth2_proxy_build_login_url_full
-oauth2_proxy_build_login_url
-oauth2_proxy_get_access_token
-oauth2_proxy_set_access_token
-oauth2_proxy_extract_access_token
-<SUBSECTION Standard>
-OAuth2ProxyClass
-OAuth2ProxyPrivate
-OAUTH2_PROXY
-OAUTH2_IS_PROXY
-OAUTH2_TYPE_PROXY
-oauth2_proxy_get_type
-OAUTH2_PROXY_CLASS
-OAUTH2_IS_PROXY_CLASS
-OAUTH2_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>oauth2-proxy-call</FILE>
-<TITLE>OAuth2ProxyCall</TITLE>
-OAuth2ProxyCall
-<SUBSECTION Standard>
-OAuth2ProxyCallClass
-OAUTH2_PROXY_CALL
-OAUTH2_IS_PROXY_CALL
-OAUTH2_TYPE_PROXY_CALL
-oauth2_proxy_call_get_type
-OAUTH2_PROXY_CALL_CLASS
-OAUTH2_IS_PROXY_CALL_CLASS
-OAUTH2_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>rest-proxy</FILE>
-<TITLE>RestProxy</TITLE>
-RestProxy
-RestProxyClass
-REST_PROXY_ERROR
-RestProxyError
-rest_proxy_new
-rest_proxy_bind
-rest_proxy_bind_valist
-rest_proxy_set_user_agent
-rest_proxy_get_user_agent
-rest_proxy_add_soup_feature
-rest_proxy_new_call
-rest_proxy_simple_run
-rest_proxy_simple_run_valist
-<SUBSECTION Standard>
-REST_PROXY
-REST_IS_PROXY
-REST_TYPE_PROXY
-rest_proxy_get_type
-REST_PROXY_CLASS
-REST_IS_PROXY_CLASS
-REST_PROXY_GET_CLASS
-rest_proxy_error_quark
-</SECTION>
-
-<SECTION>
-<FILE>oauth-proxy-call</FILE>
-<TITLE>OAuthProxyCall</TITLE>
-OAuthProxyCall
-oauth_proxy_call_parse_token_response
-<SUBSECTION Standard>
-OAuthProxyCallClass
-OAUTH_PROXY_CALL
-OAUTH_IS_PROXY_CALL
-OAUTH_TYPE_PROXY_CALL
-oauth_proxy_call_get_type
-OAUTH_PROXY_CALL_CLASS
-OAUTH_IS_PROXY_CALL_CLASS
-OAUTH_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>oauth-proxy</FILE>
-<TITLE>OAuthProxy</TITLE>
-OAuthProxy
-OAuthSignatureMethod
-oauth_proxy_new
-oauth_proxy_new_echo_proxy
-oauth_proxy_new_with_token
-OAuthProxyAuthCallback
-oauth_proxy_auth_step
-oauth_proxy_auth_step_async
-oauth_proxy_request_token
-oauth_proxy_request_token_async
-oauth_proxy_is_oauth10a
-oauth_proxy_access_token
-oauth_proxy_access_token_async
-oauth_proxy_get_token
-oauth_proxy_set_token
-oauth_proxy_get_token_secret
-oauth_proxy_set_token_secret
-oauth_proxy_get_signature_host
-oauth_proxy_set_signature_host
-<SUBSECTION Standard>
-OAuthProxyPrivate
-OAuthProxyClass
-OAUTH_PROXY
-OAUTH_IS_PROXY
-OAUTH_TYPE_PROXY
-oauth_proxy_get_type
-OAUTH_PROXY_CLASS
-OAUTH_IS_PROXY_CLASS
-OAUTH_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>rest-params</FILE>
-<TITLE>RestParams</TITLE>
-RestParams
-RestParamsIter
-rest_params_new
-rest_params_free
-rest_params_add
-rest_params_get
-rest_params_remove
-rest_params_are_strings
-rest_params_as_string_hash_table
-rest_params_iter_init
-rest_params_iter_next
-</SECTION>
-
-<SECTION>
-<FILE>rest-param</FILE>
-<TITLE>RestParam</TITLE>
-RestMemoryUse
-RestParam
-rest_param_new_string
-rest_param_new_full
-rest_param_new_with_owner
-rest_param_is_string
-rest_param_get_name
-rest_param_get_content_type
-rest_param_get_file_name
-rest_param_get_content
-rest_param_get_content_length
-rest_param_ref
-rest_param_unref
-</SECTION>
-
-<SECTION>
-<FILE>flickr-proxy-call</FILE>
-<TITLE>FlickrProxyCall</TITLE>
-FlickrProxyCall
-<SUBSECTION Standard>
-FlickrProxyCallClass
-FLICKR_PROXY_CALL
-FLICKR_IS_PROXY_CALL
-FLICKR_TYPE_PROXY_CALL
-flickr_proxy_call_get_type
-FLICKR_PROXY_CALL_CLASS
-FLICKR_IS_PROXY_CALL_CLASS
-FLICKR_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>flickr-proxy</FILE>
-<TITLE>FlickrProxy</TITLE>
-FlickrProxy
-FLICKR_PROXY_ERROR
-flickr_proxy_new
-flickr_proxy_new_with_token
-flickr_proxy_get_api_key
-flickr_proxy_get_shared_secret
-flickr_proxy_get_token
-flickr_proxy_set_token
-flickr_proxy_sign
-flickr_proxy_build_login_url
-flickr_proxy_is_successful
-flickr_proxy_new_upload
-flickr_proxy_new_upload_for_file
-<SUBSECTION Standard>
-FlickrProxyClass
-FlickrProxyPrivate
-FLICKR_PROXY
-FLICKR_IS_PROXY
-FLICKR_TYPE_PROXY
-flickr_proxy_get_type
-FLICKR_PROXY_CLASS
-FLICKR_IS_PROXY_CLASS
-FLICKR_PROXY_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>lastfm-proxy-call</FILE>
-<TITLE>LastfmProxyCall</TITLE>
-LastfmProxyCall
-<SUBSECTION Standard>
-LastfmProxyCallClass
-LASTFM_PROXY_CALL
-LASTFM_IS_PROXY_CALL
-LASTFM_TYPE_PROXY_CALL
-lastfm_proxy_call_get_type
-LASTFM_PROXY_CALL_CLASS
-LASTFM_IS_PROXY_CALL_CLASS
-LASTFM_PROXY_CALL_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>lastfm-proxy</FILE>
-<TITLE>LastfmProxy</TITLE>
-LastfmProxy
-LASTFM_PROXY_ERROR
-lastfm_proxy_new
-lastfm_proxy_new_with_session
-lastfm_proxy_get_api_key
-lastfm_proxy_get_secret
-lastfm_proxy_get_session_key
-lastfm_proxy_set_session_key
-lastfm_proxy_sign
-lastfm_proxy_build_login_url
-lastfm_proxy_is_successful
-<SUBSECTION Standard>
-LastfmProxyClass
-LastfmProxyPrivate
-LASTFM_PROXY
-LASTFM_IS_PROXY
-LASTFM_TYPE_PROXY
-lastfm_proxy_get_type
-LASTFM_PROXY_CLASS
-LASTFM_IS_PROXY_CLASS
-LASTFM_PROXY_GET_CLASS
-</SECTION>
diff --git a/docs/reference/rest/rest.types b/docs/reference/rest/rest.types
deleted file mode 100644
index 97a392c..0000000
--- a/docs/reference/rest/rest.types
+++ /dev/null
@@ -1,12 +0,0 @@
-flickr_proxy_call_get_type
-flickr_proxy_get_type
-lastfm_proxy_call_get_type
-lastfm_proxy_get_type
-oauth2_proxy_call_get_type
-oauth2_proxy_get_type
-oauth_proxy_call_get_type
-oauth_proxy_get_type
-rest_proxy_call_get_type
-rest_proxy_get_type
-rest_xml_node_get_type
-rest_xml_parser_get_type