HDFGroup / HDFGroup/hdf-rest-api

OperationId

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
13
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Thanks for providing an `openapi.json` file to describe the REST API. I am trying to auto-generate a client based on the contents of the `openapi.json`. In my previous projects the method names were derived from the operation id but unfortunately there is no operation Id in the `openapi.json` in this repo.

It would be great if you could add it so that I do not need to fall-back to the `summary` which leads to method names like `CreateAnAttributeWithNameAttrAndAssignItToHDF5ObjectObjuudi` for the REST path `PUT /{collection}/{obj_uuid}/attributes/{attr}`. The operation ID for that path could be `CreateAttribute` or `create_attribute`.

Thank you :-)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by opening the repository's openapi.json and inspect the REST path PUT /{collection}/{obj_uuid}/attributes/{attr}, using its suggested CreateAttribute or create_attribute value as a reference. Check the other operations for the same missing field and confirm that each operation has a stable operation ID suitable for generated client method names.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.