-
Notifications
You must be signed in to change notification settings - Fork 18
Generate reference docs #14
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
sidebar_label: client | ||
title: onepassword.client | ||
--- | ||
|
||
#### SDK\_VERSION | ||
|
||
v0.1.0 | ||
|
||
## Client Objects | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we able to edit the doc generator so these headers are sentence cased? For example: "Client objects" |
||
|
||
```python | ||
class Client() | ||
``` | ||
|
||
A client | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This doesn't look correct. I'm not sure where it's being source from. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's sourced from a comment from There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's strange - I don't see "A client" in that file. Could you point me to it in case I'm missing something? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
#### authenticate | ||
|
||
```python | ||
@classmethod | ||
async def authenticate(cls, auth, integration_name, integration_version) | ||
``` | ||
|
||
authenticate returns an authenticated client or errors if any provided information, including the SA token, is incorrect | ||
libutcher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
`integration_name` represents the name of your application and `integration_version` represents the version of your application. | ||
|
||
#### new\_default\_config | ||
|
||
```python | ||
def new_default_config(auth, integration_name, integration_version) | ||
``` | ||
|
||
Generates a configuration dictionary with the user's parameters | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
sidebar_label: secrets_api | ||
title: onepassword.secrets_api | ||
--- | ||
|
||
## Secrets Objects | ||
|
||
```python | ||
class Secrets() | ||
``` | ||
|
||
Secrets represents all operations the SDK client can perform on 1Password secrets. | ||
|
||
#### resolve | ||
|
||
```python | ||
async def resolve(reference) | ||
``` | ||
|
||
resolve returns the secret the provided reference points to. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"items": [ | ||
{ | ||
"items": [ | ||
{ | ||
"items": [ | ||
{ | ||
"items": [ | ||
"reference/onepassword/lib/aarch64/op_uniffi_core" | ||
], | ||
"label": "onepassword.lib.aarch64", | ||
"type": "category" | ||
}, | ||
{ | ||
"items": [ | ||
"reference/onepassword/lib/x86_64/op_uniffi_core" | ||
], | ||
"label": "onepassword.lib.x86_64", | ||
"type": "category" | ||
} | ||
], | ||
"label": "onepassword.lib", | ||
"type": "category" | ||
}, | ||
"reference/onepassword/client", | ||
"reference/onepassword/secrets_api" | ||
], | ||
"label": "onepassword", | ||
"type": "category" | ||
} | ||
], | ||
"label": "Reference", | ||
"type": "category" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
loaders: | ||
- type: python | ||
processors: | ||
- type: filter | ||
skip_empty_modules: true | ||
- type: smart | ||
- type: crossref | ||
renderer: | ||
type: docusaurus |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
pydoc-markdown | ||
rm -rf ./docs/reference/onepassword/lib |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like this metadata is appearing on the front end as a table. Is there a way to avoid that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will look into it.