bis-med-it · javihern98 · Dec 12, 2024 · Dec 12, 2024 · Dec 12, 2024 · Dec 12, 2024
diff --git a/docs/api/fmr/async.rst b/docs/api/fmr/async.rst
@@ -12,5 +12,5 @@ SDMX service in an asynchronous (i.e. non-blocking fashion).
 >>>     print(mapping)
 >>> asyncio.run(main())
 
-.. autoclass:: pysdmx.fmr.AsyncRegistryClient
+.. autoclass:: pysdmx.api.fmr.AsyncRegistryClient
     :members:
diff --git a/docs/api/fmr/sync.rst b/docs/api/fmr/sync.rst
@@ -8,5 +8,5 @@ SDMX service in a synchronous (i.e. blocking fashion).
 >>> gr = RegistryClient("https://registry.sdmx.org/sdmx/v2/")
 >>> schema = gr.get_schema("dataflow", "UIS", "EDUCAT_CLASS_A", "1.0")
 
-.. autoclass:: pysdmx.fmr.RegistryClient
+.. autoclass:: pysdmx.api.fmr.RegistryClient
     :members:
diff --git a/docs/api/model.rst b/docs/api/model.rst
@@ -61,10 +61,11 @@ API Reference
 .. toctree::
    :maxdepth: 1
 
-   model/organisation
    model/code
    model/concept
    model/dataflow
    model/category
    model/map
-   model/refmeta
+   model/refmeta
+   model/organisation
+   model/vtl
diff --git a/docs/api/model/category.rst b/docs/api/model/category.rst
@@ -9,4 +9,4 @@ Category schemes
     - :ref:`fs`.
 
 .. automodule:: pysdmx.model.category
-    :members: Category, CategoryScheme
+    :members: Category, CategoryScheme, DataflowRef
diff --git a/docs/api/model/code.rst b/docs/api/model/code.rst
@@ -2,4 +2,4 @@ Codelists, hierarchies and value lists
 ======================================
 
 .. automodule:: pysdmx.model.code
-    :members: Code, Codelist, HierarchicalCode, Hierarchy
+    :members: Code, Codelist, HierarchicalCode, Hierarchy, HierarchyAssociation
diff --git a/docs/api/model/dataflow.rst b/docs/api/model/dataflow.rst
@@ -10,4 +10,4 @@ Dataflows and data structures
     - :ref:`validate`.
 
 .. automodule:: pysdmx.model.dataflow
-    :members: Component, Components, DataflowInfo, Role, Schema
+    :members: Component, Components, Dataflow, DataflowInfo, Role, Schema
diff --git a/docs/api/model/map.rst b/docs/api/model/map.rst
@@ -9,4 +9,4 @@ Mapping definitions
     - :ref:`map`.
 
 .. automodule:: pysdmx.model.map
-    :members: StructureMap, ComponentMap, MultiComponentMap, ValueMap, MultiValueMap, ImplicitComponentMap, FixedValueMap, DatePatternMap
+    :members: StructureMap, ComponentMap, RepresentationMap, MultiComponentMap, MultiRepresentationMap, ValueMap, MultiValueMap, ImplicitComponentMap, FixedValueMap, DatePatternMap
diff --git a/docs/api/model/organisation.rst b/docs/api/model/organisation.rst
@@ -2,4 +2,4 @@ Organisations
 =============
 
 .. automodule:: pysdmx.model.organisation
-    :members: Organisation, Contact, DataflowRef
+    :members: Agency, AgencyScheme, DataConsumer, DataConsumerScheme, DataProvider, DataProviderScheme, MetadataProvider, MetadataProviderScheme
diff --git a/docs/api/model/vtl.rst b/docs/api/model/vtl.rst
@@ -0,0 +1,12 @@
+VTL artefacts
+=============
+
+.. note::
+    Additional information about how VTL artefacts can be used for
+    validating and transforming SDMX data is available in the
+    following tutorial:
+
+    - :ref:`vtl`.
+
+.. automodule:: pysdmx.model.vtl
+    :members: CustomType, CustomTypeScheme, FromVtlMapping, NamePersonalisation, NamePersonalisationScheme, Ruleset, RulesetScheme, ToVtlMapping, Transformation, TransformationScheme, UserDefinedOperator, UserDefinedOperatorScheme, VtlCodelistMapping, VtlConceptMapping, VtlDataflowMapping, VtlMapping, VtlMappingScheme
diff --git a/docs/api/query/availability.rst b/docs/api/query/availability.rst
@@ -0,0 +1,11 @@
+SDMX-REST Availability Queries
+==============================
+
+.. note::
+    Additional information about how to build SDMX-REST queries
+    can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb.availability
+    :members: AvailabilityFormat, AvailabilityMode, AvailabilityQuery
diff --git a/docs/api/query/data.rst b/docs/api/query/data.rst
@@ -0,0 +1,11 @@
+SDMX-REST Data Queries
+======================
+
+.. note::
+    Additional information about how to build SDMX-REST queries
+    can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb.data
+    :members:  DataContext, DataFormat, DataQuery
diff --git a/docs/api/query/refmeta.rst b/docs/api/query/refmeta.rst
@@ -0,0 +1,11 @@
+SDMX-REST Reference Metadata Queries
+====================================
+
+.. note::
+    Additional information about how to build SDMX-REST queries
+    can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb.refmeta
+    :members: RefMetaByMetadataflowQuery, RefMetaByMetadatasetQuery, RefMetaByStructureQuery, RefMetaDetail, RefMetaFormat
diff --git a/docs/api/query/schema.rst b/docs/api/query/schema.rst
@@ -0,0 +1,11 @@
+SDMX-REST Schema Queries
+========================
+
+.. note::
+    Additional information about how to build SDMX-REST queries
+    can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb.schema
+    :members: SchemaContext, SchemaFormat, SchemaQuery
diff --git a/docs/api/query/service.rst b/docs/api/query/service.rst
@@ -0,0 +1,11 @@
+SDMX-REST Service Clients
+=========================
+
+.. note::
+    Additional information about how to execute SDMX-REST queries
+    against a specific service can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb
+    :members: ApiVersion, RestService
diff --git a/docs/api/query/structure.rst b/docs/api/query/structure.rst
@@ -0,0 +1,11 @@
+SDMX-REST Structure Queries
+===========================
+
+.. note::
+    Additional information about how to build SDMX-REST queries
+    can be found in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+.. automodule:: pysdmx.api.qb.structure
+    :members: StructureDetail, StructureFormat, StructureQuery, StructureReference, StructureType
diff --git a/docs/api/rest.rst b/docs/api/rest.rst
@@ -0,0 +1,28 @@
+.. _qb_api:
+
+SDMX-REST services
+==================
+
+Overview
+--------
+
+``pysdmx`` allows **building SDMX-REST queries** and **executing them** 
+against an SDMX-REST compliant service.
+
+.. note::
+    Discover how to execute SDMX-REST queries in the following tutorial:
+
+    - :ref:`sdmx-rest`.
+
+API Reference
+-------------
+
+.. toctree::
+   :maxdepth: 1
+
+   query/service
+   query/availability
+   query/data
+   query/refmeta
+   query/schema
+   query/structure
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,8 +21,8 @@
 # -- Project information -----------------------------------------------------
 
 project = "pysdmx"
-copyright = "2023, BIS"
-author = "BIS"
+copyright = "2025, BIS"
+author = "BIS, MeaningfulData"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/howto/config.rst b/docs/howto/config.rst
@@ -95,8 +95,8 @@ Connecting to a Registry
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``pysdmx`` allows retrieving metadata from an SDMX Registry in either a
-synchronous (via ``pymedal.fmr.RegistryClient``) or asynchronous fashion
-(via ``pymedal.fmr.AsyncRegistryClient``). The choice depends on your use
+synchronous (via ``pysdmx.api.fmr.RegistryClient``) or asynchronous fashion
+(via ``pysdmx.api.fmr.AsyncRegistryClient``). The choice depends on your use
 case. The asynchronous client is often preferred as it is non-blocking.
 
 To connect to your target Registry, instantiate the client by passing the