Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Archento committed Nov 19, 2024
1 parent aa95981 commit 089167e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
15 changes: 15 additions & 0 deletions python/docs/api/uagents/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,21 @@ Property to access the digest of the protocol's manifest.

- `str` - The digest of the protocol's manifest.

<a id="src.uagents.protocol.Protocol.info"></a>

#### info

```python
@property
def info()
```

Property to access the protocol details.

**Returns**:

- `ProtocolDetails` - The protocol details.

<a id="src.uagents.protocol.Protocol.on_interval"></a>

#### on`_`interval
Expand Down
19 changes: 15 additions & 4 deletions python/docs/api/uagents/registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

# src.uagents.registration

<a id="src.uagents.registration.AgentRegistrationAttestation"></a>

## AgentRegistrationAttestation Objects

```python
class AgentRegistrationAttestation(VerifiableModel)
```

<a id="src.uagents.registration.AgentRegistrationAttestation.protocols"></a>

#### protocols

str for backwards compatibility

<a id="src.uagents.registration.generate_backoff_time"></a>

#### generate`_`backoff`_`time
Expand Down Expand Up @@ -59,10 +73,7 @@ if it is different from the supported version.
#### register

```python
async def register(agent_address: str,
protocols: List[str],
endpoints: List[AgentEndpoint],
metadata: Optional[Dict[str, Any]] = None)
async def register(agent_info: AgentInfo)
```

Register the agent on the Almanac contract if registration is about to expire or
Expand Down

0 comments on commit 089167e

Please sign in to comment.