HTTP-APIs/hydra-python-agent

Automate the process of discovering the apiDocumentation

Closed this issue · 11 comments

At present, the agent has been hard coded to fetch the API Doc by appending /vocab to the URL provided. This not aligned with Hydra Spec. The agent should be able to extract the link to API documentation from the homepage of API publisher by looking for Link header in HTTP response with relationship type http://www.w3.org/ns/hydra/core#apiDocumentation

I am really new to hydra ecosystem but I would like to work on this, it might take me some time though (since I am new).

I'd recommend you go through the core vocab and get acquainted with the issue. Here's the link -> Hydra Core Vocabulary

Thank you, I will

Guttz commented

Welcome @Abhimanyu121, first take some time to get familiar with the concepts at http://www.hydraecosystem.org/ and other doubts you might have. We are available at Gitter.

When you feel a bit more comfortable, I have a tip for the issue. Currently, the Agent simply uses vocab(line 29, graphutils_operations.py):

image

However, the agent has already the ApiDoc available and you can go to self.api_doc['context']['context']['vocab'] and get the full address for the vocab :)

image

Thank you @Guttz , I will get familiar with all the concepts and make a pr soon :D

Can I work on this?

You don't need to ask for permission, feel free to work on anything you want.

I'd recommend you go through the core vocab and get acquainted with the issue. Here's the link -> Hydra Core Vocabulary

@vcode11 kindly take a look at this. You'll find it helpful

Can I work on this issue , I am new to hydra . I have set up the env and went through the docs.

Can I work on this issue , I am new to hydra . I have set up the env and went through the docs.

No need to ask @kss682.

Is this issue resolved? @xadahiya @Guttz