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

Unify OpenAPI spec and API documentation #102

Open
nbbaier opened this issue Jan 13, 2024 · 1 comment
Open

Unify OpenAPI spec and API documentation #102

nbbaier opened this issue Jan 13, 2024 · 1 comment

Comments

@nbbaier
Copy link
Contributor

nbbaier commented Jan 13, 2024

While working on #101, I noticed that there are discrepancies between the OpenAPI specification and the API documentation. The table below summarizes the differences. (See also #100)

Endpoint OpenAPI Docs website Notes
GET /v1/me
GET /v1/me/likes
GET /v1/me/runs
GET/v1/me/comments
GET /v1/me/references resolved by #101
POST /v1/vals
PUT /v1/vals resolved by #101
GET /v1/vals/{val_id}
PUT /v1/vals/{val_id}
DELETE /v1/vals/{val_id}
GET /v1/vals/{val_id}/versions
POST /v1/vals/{val_id}/versions
GET /v1/vals/{val_id}/versions/{version}
DELETE /v1/vals/{val_id}/versions/{version}
GET /v1/vals/{val_id}/runs
GET /v1/users/{user_id}
GET /v1/users/{user_id}/vals
GET /v1/alias/{username}
GET /v1/alias/{username}/{val_name}
GET /v1/search/vals
GET /v1/eval/{expression}
POST /v1/eval
GET /v1/run/{username}.{val_name}
POST /v1/run/{username}.{val_name}
GET /
POST /
@Xkonti
Copy link
Contributor

Xkonti commented Jan 16, 2024

That's some useful table @nbbaier. I'll take a look at fixing those discrepancies shortly.

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