Plume
/
Plume
8
16
Forkuj 22
Kod Zgłoszenia 174 Oczekujące zmiany 8 Wydania 8 Wiki Aktywność

Etykiety Kamienie milowe

Some API endpoints for articles #245

Scalone
elegaanz scala 4 commity/ów z rest-api do master 6 lat temu
Dyskusja 1 Commity 4 Zmodyfikowane pliki 14
elegaanz skomentował(-a) 6 lat temu (Zmigrowane z 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 (Zmigrowane z github.com) zrecenzowano 6 lat temu
igalic (Zmigrowane z github.com) zostawił komentarz

👀

👀
Cargo.toml
@ -5,6 +5,7 @@ version = "0.2.0"
[dependencies]
activitypub = "0.1.3"
atom_syndication = "0.6"
canapi = "0.1"
igalic (Zmigrowane z github.com) skomentował(-a) 6 lat temu

exciting Version number

exciting Version number
docs/api.yaml
@ -0,0 +1,45 @@
openapi: "3.0"
igalic (Zmigrowane z github.com) skomentował(-a) 6 lat temu

is this autogenerated?

is this autogenerated?
plume-api/src/lib.rs
@ -0,0 +13,4 @@
}
}
};
}
igalic (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) skomentował(-a) 6 lat temu

such as?

such as?
elegaanz (Zmigrowane z github.com) zrecenzowano 6 lat temu
docs/api.yaml
@ -0,0 +1,45 @@
openapi: "3.0"
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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

not yet, but it may be possible thanks to canapi…
elegaanz (Zmigrowane z github.com) zrecenzowano 6 lat temu
po/gl.po
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) zrecenzowano 6 lat temu
src/api/posts.rs
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) zrecenzowano 6 lat temu
plume-models/src/posts.rs
@ -58,0 +93,4 @@
}
fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
unimplemented!()
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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 (Zmigrowane z github.com) zrecenzowano 6 lat temu
plume-models/src/posts.rs
@ -58,0 +93,4 @@
}
fn create(_conn: &PgConnection, _query: PostEndpoint) -> Result<PostEndpoint, Error> {
unimplemented!()
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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

not sure if I'm clear, tell me if not :grin:
igalic skomentował(-a) 6 lat temu (Zmigrowane z 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 zrecenzowano 6 lat temu
src/api/posts.rs
trinity-1686a skomentował(-a) 6 lat temu
Właściciel

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 (Zmigrowane z github.com) zrecenzowano 6 lat temu
src/api/posts.rs
elegaanz (Zmigrowane z github.com) skomentował(-a) 6 lat temu

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`.
Pull Request został scalony jako 236cf14406.
Możesz także zobaczyć instrukcje wiersza poleceń.

Krok 1:

Z repozytorium twojego projektu, sprawdź nową gałąź i przetestuj zmiany.
git checkout -b rest-api master
git pull origin rest-api

Krok 2:

Połącz zmiany i zaktualizuj na Forgejo.
git checkout master
git merge --no-ff rest-api
git push origin master
Zaloguj się, aby dołączyć do tej rozmowy.
Recenzenci
Poproś o recenzję
Brak recenzentów
Etykiety
Zastosuj etykiety
Wyczyść etykiety   
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
Brak etykiety
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
Kamień milowy
Ustaw kamień milowy
Wyczyść kamień milowy
Brak elementów
Brak kamienia milowego
Przypisani
Przypisz użytkowników
Usuń przypisanych
Brak przypisanych
Uczestnicy 2
Powiadomienia
Termin realizacji
Data realizacji jest niewłaściwa lub spoza zakresu. Użyj formatu 'yyyy-mm-dd'.

Brak ustawionego terminu realizacji.

Zależności

No dependencies set.

Reference: Plume/Plume#245
Napisz Podgląd
Ładowanie…
Anuluj
Zapisz
Nie ma jeszcze treści.
Usuń gałąź 'rest-api'

Usunięcie gałęzi jest trwałe i NIE MOŻE zostać cofnięte. Kontynuować?

Nie
Tak