Skip to content

Latest commit

 

History

History
245 lines (131 loc) · 5.26 KB

DefaultApi.md

File metadata and controls

245 lines (131 loc) · 5.26 KB
Raw

\DefaultApi

All URIs are relative to http://agentplatform.grs.uh.cu/api/v1

Method HTTP request Description
EditAgent Post /editAgent
GetAgent Get /getAgent/{Name}
GetAgentsByFunction Get /getAgentsForFunction/{Name}
GetAgentsNames Get /getAllAgentsNames
GetPeers Get /getPeers
GetSimilarAgent Get /getSimilarAgents/{Name}
RegisterAgent Post /registerAgent

EditAgent

EditAgent(ctx, body)

Edit a registered Agent in the platform

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Agent Agent to edit

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgent

[]Addr GetAgent(ctx, name)

Get the agent that follow a simple criteria

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the Agent

Return type

[]Addr

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentsByFunction

[][]Addr GetAgentsByFunction(ctx, name)

Get the agents that match with the function name passed as params

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the Function

Return type

[][]Addr

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAgentsNames

[]string GetAgentsNames(ctx, )

Get all agents names registered in the platforms

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPeers

[]Addr GetPeers(ctx, )

Return all peers connected to the platform network

Required Parameters

This endpoint does not need any parameter.

Return type

[]Addr

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSimilarAgent

[]string GetSimilarAgent(ctx, name)

Get the agents that are similars to the agent passed as paramerter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Name of the Agent

Return type

[]string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterAgent

RegisterAgent(ctx, body)

Register a new Agent in the platform

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Agent Agent to register

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]