CGM_Public/pretix_original
3
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-08-17 11:56:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

API: Expose organizer and event URL (Z#23116269) (#3121)

Browse Source
This commit is contained in:
Martin Gross
2023-02-14 14:47:18 +01:00
committed by GitHub
parent e33fbaf9c0
commit 20581cd31c
7 changed files with 47 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/resources/events.rst
+15 -5
View File
@@ -49,6 +49,7 @@ valid_keys object Cryptographic k
only contained in detail views. Value can be cached.
sales_channels list A list of sales channels this event is available for
sale on.
public_url string The public, customer-facing URL of the event (read-only).
===================================== ========================== =======================================================
@@ -65,6 +66,10 @@ Endpoints
The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
.. versionchanged:: 4.17
The ``public_url`` field has been added.
.. http:get:: /api/v1/organizers/(organizer)/events/
Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -123,7 +128,8 @@ Endpoints
"web",
"pretixpos",
"resellers"
]
],
"public_url": "https://pretix.eu/bigevents/sampleconf/"
}
]
}
@@ -211,7 +217,8 @@ Endpoints
"web",
"pretixpos",
"resellers"
]
],
"public_url": "https://pretix.eu/bigevents/sampleconf/"
}
:param organizer: The ``slug`` field of the organizer to fetch
@@ -307,7 +314,8 @@ Endpoints
"web",
"pretixpos",
"resellers"
]
],
"public_url": "https://pretix.eu/bigevents/sampleconf/"
}
:param organizer: The ``slug`` field of the organizer of the event to create.
@@ -411,7 +419,8 @@ Endpoints
"web",
"pretixpos",
"resellers"
]
],
"public_url": "https://pretix.eu/bigevents/sampleconf/"
}
:param organizer: The ``slug`` field of the organizer of the event to create.
@@ -485,7 +494,8 @@ Endpoints
"web",
"pretixpos",
"resellers"
]
],
"public_url": "https://pretix.eu/bigevents/sampleconf/"
}
:param organizer: The ``slug`` field of the organizer of the event to update
doc/api/resources/organizers.rst
+8
View File
@@ -17,12 +17,18 @@ Field Type Description
name string The organizer's full name, i.e. the name of an
organization or company.
slug string A short form of the name, used e.g. in URLs.
public_url string The public, customer-facing URL of the organizer, where
the list of all events can be found (read-only).
===================================== ========================== =======================================================
Endpoints
---------
.. versionchanged:: 4.17
The ``public_url`` field has been added.
.. http:get:: /api/v1/organizers/
Returns a list of all organizers the authenticated user/token has access to.
@@ -51,6 +57,7 @@ Endpoints
{
"name": "Big Events LLC",
"slug": "Big Events",
"public_url": "https://pretix.eu/bigevents/"
}
]
}
@@ -84,6 +91,7 @@ Endpoints
{
"name": "Big Events LLC",
"slug": "Big Events",
"public_url": "https://pretix.eu/bigevents/"
}
:param organizer: The ``slug`` field of the organizer to fetch