Skip to content

Commit

Permalink
Merge pull request #2115 from openedx/asheehan-edx/updating-enterpris…
Browse files Browse the repository at this point in the history
…e-catalog-api-docs

fix: updating enterprise api catalog list view endpoint from v1 to v2
  • Loading branch information
alex-sheehan-edx committed Mar 9, 2023
2 parents bdb064d + 41d6bdd commit a2182b1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
}
],
"url": {
"raw": "https://api.edx.org/enterprise/v1/enterprise-catalogs/",
"raw": "https://api.edx.org/enterprise/v2/enterprise-catalogs/",
"protocol": "https",
"host": [
"api",
Expand All @@ -67,7 +67,7 @@
],
"path": [
"enterprise",
"v1",
"v2",
"enterprise-catalogs",
""
]
Expand Down
23 changes: 19 additions & 4 deletions en_us/enterprise_api/source/api_reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Endpoints
The following endpoints are available in the Enterprise API.

- **/enterprise-catalogs** - You can make GET calls to the
``/enterprise/v1/enterprise-catalogs`` endpoint to get a list of all the course catalogs
``/enterprise/v2/enterprise-catalogs`` endpoint to get a list of all the course catalogs
that are available to your organization.
For details, see :ref:`enterprise_catalogs Endpoint`.

Expand Down Expand Up @@ -86,23 +86,23 @@ Method and Endpoint
* - Method
- Endpoint
* - GET
- ``/enterprise/v1/enterprise-catalogs``
- ``/enterprise/v2/enterprise-catalogs``

=====================
Example Request
=====================
::

curl -X GET
https://api.edx.org/enterprise/v1/enterprise-catalogs \
https://api.edx.org/enterprise/v2/enterprise-catalogs \
-H "Authorization: JWT {access token}"
-H "Content-Type: application/json" \
}]"

=====================
Response Values
=====================
The ``GET /enterprise/v1/enterprise-catalogs`` request returns the values: ``count``, ``next``, ``previous``, ``results`` described here: :ref:`response_Values`.
The ``GET /enterprise/v2/enterprise-catalogs`` request returns the values: ``count``, ``next``, ``previous``, ``results`` described here: :ref:`response_Values`.
The ``results`` response value include these fields:

.. list-table::
Expand All @@ -121,6 +121,21 @@ The ``results`` response value include these fields:
* - ``enterprise_customer``
- string
- The customer's unique identifier links to a catalog.
* - ``catalog_query_uuid``
- string
- A unique identifier for the catalog query.
* - ``content_last_modified``
- string
- Datetime string of the last time the content in the catalog was updated.
* - ``catalog_modified``
- string
- Datetime string of the last time the catalog was modified.
* - ``query_title``
- string
- The string title of the query used by the catalog.
* - ``include_exec_ed_2u_courses``
- bool (Nullable)
- Whether or not the catalog allows the linking of Executive Education content.

.. _enterprise_catalogs_catalogID Endpoint:

Expand Down

0 comments on commit a2182b1

Please sign in to comment.