Plume
/
Plume
8
16
Fork 22
Código Incidencias 174 Pull Requests 8 Lanzamientos 8 Wiki Actividad

Etiquetas Hitos

Some API endpoints for articles #245

Fusionado
elegaanz fusionados 4 commits de rest-api en master hace 6 años
Conversación 1 Commits 4 Archivos modificados 14
elegaanz comentado hace 6 años (Migrado desde github.com)
  • Define the API with canapi
  • Implement canapi::Provider for Post (only get and list actually)
  • Use these functions to serve the API (/api/v1/posts/<id> and /api/v1/posts)
  • Document the API with Swagger (couldn't test it, I hope it will be served correctly 😕)

It is a first step for #5

- Define the API with canapi - Implement `canapi::Provider` for `Post` (only `get` and `list` actually) - Use these functions to serve the API (`/api/v1/posts/<id>` and `/api/v1/posts`) - Document the API with Swagger (couldn't test it, I hope it will be served correctly :confused:) It is a first step for #5
igalic (Migrado desde github.com) revisado hace 6 años
igalic (Migrado desde github.com) dejó un comentario

👀

👀
Cargo.toml
@ -5,6 +5,7 @@ version = "0.2.0"
[dependencies]
activitypub = "0.1.3"
atom_syndication = "0.6"
canapi = "0.1"
igalic (Migrado desde github.com) comentado hace 6 años

exciting Version number

exciting Version number
docs/api.yaml
@ -0,0 +1,45 @@
openapi: "3.0"
igalic (Migrado desde github.com) comentado hace 6 años

is this autogenerated?

is this autogenerated?
plume-api/src/lib.rs
@ -0,0 +13,4 @@
}
}
};
}
igalic (Migrado desde github.com) comentado hace 6 años

sometimes i dream of lisp indentation style in Javascript. soon, I'll start dreaming of lisp indentation style in rust

sometimes i dream of lisp indentation style in Javascript. soon, I'll start dreaming of lisp indentation style in rust
plume-models/src/posts.rs
@ -58,0 +93,4 @@
}
fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
unimplemented!()
igalic (Migrado desde github.com) comentado hace 6 años

what's the point of these queries and the override of the query variable?

what's the point of these queries and the override of the query variable?
igalic (Migrado desde github.com) comentado hace 6 años

aahh, you're fetching different parts of the same article, and stuffing them into different boxes of the query variable!

aahh, you're fetching different parts of the same article, and stuffing them into different boxes of the query variable!
po/gl.po
igalic (Migrado desde github.com) comentado hace 6 años

why does this file keep changing with every new build?

why does this file keep changing with every new build?
src/api/posts.rs
igalic (Migrado desde github.com) comentado hace 6 años

such as?

such as?
elegaanz (Migrado desde github.com) revisado hace 6 años
docs/api.yaml
@ -0,0 +1,45 @@
openapi: "3.0"
elegaanz (Migrado desde github.com) comentado hace 6 años

not yet, but it may be possible thanks to canapi…

not yet, but it may be possible thanks to canapi…
elegaanz (Migrado desde github.com) revisado hace 6 años
po/gl.po
elegaanz (Migrado desde github.com) comentado hace 6 años

it is updated every time you run Plume. However, extracting i18n related task to an external tool may be better… 🤔

it is updated every time you run Plume. However, extracting i18n related task to an external tool may be better… :thinking:
elegaanz (Migrado desde github.com) revisado hace 6 años
src/api/posts.rs
elegaanz (Migrado desde github.com) comentado hace 6 años

For instance, if you GET /api/v1/posts?title=Hello%20world, only posts with the Hello world title should be shown (title is not the best example, but author_id could be interesting for instance)

For instance, if you `GET /api/v1/posts?title=Hello%20world`, only posts with the `Hello world` title should be shown (`title` is not the best example, but `author_id` could be interesting for instance)
elegaanz (Migrado desde github.com) revisado hace 6 años
plume-models/src/posts.rs
@ -58,0 +93,4 @@
}
fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
unimplemented!()
elegaanz (Migrado desde github.com) comentado hace 6 años

actually, the PostEndpoint type is here to represent both the client's query and the result sent by the API. filter is what is requested by the client, so if any filter have been specified I update the SQL query to only return the requested posts.

actually, the `PostEndpoint` type is here to represent both the client's query and the result sent by the API. `filter` is what is requested by the client, so if any filter have been specified I update the SQL `query` to only return the requested posts.
elegaanz (Migrado desde github.com) revisado hace 6 años
plume-models/src/posts.rs
@ -58,0 +93,4 @@
}
fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
unimplemented!()
elegaanz (Migrado desde github.com) comentado hace 6 años

not sure if I'm clear, tell me if not 😁

not sure if I'm clear, tell me if not :grin:
igalic comentado hace 6 años (Migrado desde github.com)

i just realized how easy CLI mappings would be to implement, once the API is in place.

i just realized how easy CLI mappings would be to implement, once the API is in place.
trinity-1686a revisado hace 6 años
src/api/posts.rs
trinity-1686a comentado hace 6 años
Propietario

So is this (at least partially) blocked by #149, or not related?

So is this (at least partially) blocked by #149, or not related?
elegaanz (Migrado desde github.com) revisado hace 6 años
src/api/posts.rs
elegaanz (Migrado desde github.com) comentado hace 6 años

No, actually we just need to get the raw query params, and deserialize them to PostEndpoint with something like serde_qs.

No, actually we just need to get the raw query params, and deserialize them to `PostEndpoint` with something like `serde_qs`.
El Pull Request se ha fusionado como 236cf14406.
También puede ver instrucciones de línea de comandos.

Paso 1:

Desde el repositorio de su proyecto, revisa una nueva rama y prueba los cambios.
git checkout -b rest-api master
git pull origin rest-api

Paso 2:

Combine los cambios y actualice en Forgejo.
git checkout master
git merge --no-ff rest-api
git push origin master
Inicie sesión para unirse a esta conversación.
Revisores
Solicitar revisión
No hay revisores
Etiquetas
Aplicar etiquetas
Limpiar etiquetas   
A: API

Related to the REST API   
A: Backend

Code running on the server   
A: Federation

Stuff related to Federation   
A: Front-End

Related to the front-end   
A: I18N

Translations, and related code   
A: Meta

More about project management or code than the project itself   
A: Security
   
Build

The building, or installation process of Plume   
C: Bug

Something isn't working   
C: Discussion

We need to talk   
C: Enhancement

New feature or request   
C: Feature

This is a new feature   
Compatibility

Compatibility with different browsers, readers and OS   
Dependency

Related to an external package that Plume uses   
Design

UI/UX related issues and PRs   
Documentation
   
Good first issue

Good for newcomers   
Help welcome

Extra attention is needed   
Mobile

Issues affecting only mobile UX   
Rendering

How elements're rendered out for the end user   
S: Blocked

Something else needs to be fixed first   
S: Duplicate

This issue or pull request already exists   
S: Incomplete

This PR is not complete yet   
S: Instance specific

Issues concern a limited number of instances   
S: Invalid

This doesn't seem right   
S: Needs Voting/Discussion

Need to be discussed by the community (on Loomio)   
S: Ready for review

This PR is ready to be reviewed   
Suggestion

Proposed ideas worth considering   
S: Voted on Loomio

This is issue has been created after a vote on Loomio   
S: Wontfix

This will not be worked on
Sin etiquetas
A: API
A: Backend
A: Federation
A: Front-End
A: I18N
A: Meta
A: Security
Build
C: Bug
C: Discussion
C: Enhancement
C: Feature
Compatibility
Dependency
Design
Documentation
Good first issue
Help welcome
Mobile
Rendering
S: Blocked
S: Duplicate
S: Incomplete
S: Instance specific
S: Invalid
S: Needs Voting/Discussion
S: Ready for review
Suggestion
S: Voted on Loomio
S: Wontfix
Milestone
Fijar hito
Limpiar Milestone
No hay elementos
Sin Milestone
Asignados
Asignar usuarios
Limpiar asignados
No asignados
2 participantes
Notificaciones
Fecha de vencimiento
La fecha de vencimiento es inválida o está fuera de rango. Por favor utilice el formato 'aaaa-mm-dd'.

Sin fecha de vencimiento.

Dependencias

No se han establecido dependencias.

Referencia: Plume/Plume#245
Escribir Vista previa
Cargando…
Cancelar
Guardar
Aún no existe contenido.
Eliminar la rama con el nombre 'rest-api'

Eliminar una rama es permanente. NO PUEDE deshacerse. ¿Continuar?

No
Sí