Review and fill out embedded API documentation.

[anjackson]

The FastAPI annotations are used to add basic API documentation. This should be review to see if it makes sense, and in particular, any existing parameters that do not have much or any documentation should be updates to include brief descriptions.

As an example. Is the CDX API documentation clear? Does the current setup make it sufficiently clear that only limited values are allowed for particular parameters?

ukwa-access-api/ukwa_api/mementos/router.py

Lines 65 to 90 in aba8ead

	async def lookup_url(
	url: AnyHttpUrl = Query(
	...,
	title="URL to find.",
	description="URL to look for (will canonicalize the URL before running the query).",
	example='http://portico.bl.uk/'
	),
	matchType: Optional[schemas.LookupMatchType] = Query(
	schemas.LookupMatchType.exact,
	title='Type of match to look for.'
	),
	sort: Optional[schemas.LookupSort] = Query(
	schemas.LookupSort.default,
	title='Order to return results.'
	),
	limit: Union[int, None] = Query(
	None,
	title='Number of matching records to return.'
	),
	):
	# Only put through allowed parameters:
	params = {
	'url': url,
	'matchType': matchType.value,
	'sort': sort.value,
	'limit': limit,