search

JR-1991 / pyDataverse-generation-analysis

0 stars 0 forks source link

OAI generation examples #1

Open JR-1991 opened 10 months ago

JR-1991 commented 10 months ago

Issue to discuss the examples of this repository. See README on main for details.

JR-1991 commented 10 months ago

The usage of tags within the OAI specifications could be improved. I have added native to all endpoints, but I feel like that this is very broad and less useful due to the amount of endpoints available.

I'd propose adding tags based on the type the endpoint addresses. For instance:

/api/v1/files/{identifier}:
    get:
        tags:
            -  files
 /api/v1/datasets/{identifier}:
    get:
        tags:
            -  datasets

This would result in a better logical structure and help to organize the OAI doc. In addition, both OAI-Gen and Speakeasy use these tags as module names. Hence, these could be used in the following way:

res = s.datasets.export_dataset(...)

# or

res = s.files.get_file_metadata(...)