Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to discover Classes and Collections from the APIDOC? #39

Closed
1 of 2 tasks
priyanshunayan opened this issue Jun 11, 2020 · 0 comments
Closed
1 of 2 tasks

How to discover Classes and Collections from the APIDOC? #39

priyanshunayan opened this issue Jun 11, 2020 · 0 comments

Comments

@priyanshunayan
Copy link
Member

priyanshunayan commented Jun 11, 2020

I'm submitting a

  • bug report.
  • feature request.

Current Behaviour:

The way this module makes or identifies collection by checking if the name consists "Collection" keyword. But Some APIDOC authors might prefer Drones instead of DroneCollection. In order to parse APIDOCs not written using doc_writer, we need to have more general way of identifying classes and collection.

The entrypoint of the APIDOC used in the Hydra-CG uses the hydra:collection to identify the collections: https://github.com/HydraCG/cookbook/blob/master/api-documentation/1.entry-point.md

Also related discussion on the spec repo related to this:
HydraCG/Specifications#126

Related Issues on Agent:
HTTP-APIs/hydra-python-agent-gui#7
HTTP-APIs/hydra-python-agent-gui#43

Expected Behaviour:

The module would be able to parse classes and collections in more general way.

Do you want to work on this issue?

yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants