OpenAPI: first pass on Plugins API - Shared Links #3378
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aerosol
changed the title
BundleMonUnchanged files (7)
No change in files bundle size Final result: ✅ View report in BundleMon website ➡️ |
aerosol
force-pushed
the
openapi-plugins
branch
from
74a3b4b
to
6139dfd
Compare
aerosol
changed the title
aerosol
added
the
deploy-to-staging
aerosol
force-pushed
the
openapi-plugins
branch
from
a895c64
to
1c09e02
Compare
aerosol
commented
Sep 28, 2023
| WHEN g2.page_path IS NOT NULL THEN g2.page_path | ||
| WHEN g2.event_name IS NOT NULL THEN g2.event_name | ||
| WHEN g2.page_path IS NOT NULL THEN 'Page: ' || g2.page_path | ||
| WHEN g2.event_name IS NOT NULL THEN 'Event: ' || g2.event_name |
There was a problem hiding this comment.
On staging we've had goals equally named but of different types, so that's another edge case to be addressed. Ref #3343
zoldar
reviewed
Sep 28, 2023
aerosol
force-pushed
the
openapi-plugins
branch
from
3344a96
to
cd75183
Compare
aerosol
commented
Sep 28, 2023
There was a problem hiding this comment.
We ran this on prod in correct order, but merging was a bit careless and reversed it
ukutaht
approved these changes
Sep 28, 2023
test/plausible_web/plugins/api/controllers/shared_links_test.exs
Outdated
Show resolved
Hide resolved
(to be used with path helpers once called from within forwarded router's scope)
aerosol
force-pushed
the
openapi-plugins
branch
from
5cce42b
to
ec9637e
Compare
Co-authored-by: Uku Taht <Uku.taht@gmail.com>
zoldar
reviewed
Oct 2, 2023
lib/plausible/plugins/api/tokens.ex
Outdated
Comment on lines
14
to
15
| def create(%Site{} = site, description, generate \\ Token.generate()) do | ||
| with generated_token <- generate, |
There was a problem hiding this comment.
hmm maybe just name the argument generated_token?
8 tasks
zoldar
added a commit
that referenced
this pull request
Oct 10, 2023
The migration in question was renamed in order to fix order of executing migrations when run from the ground up (via #3378). As a side effect, it's executed again on databases that had it applied earlier, with a different timestamp prefix. As this migration is safe to run multiple times, it was modified to make forward migration work gracefully when constraint already exists.
8 tasks
zoldar
added a commit
that referenced
this pull request
Oct 10, 2023
* Make FixBrokenGoals migration idempotent The migration in question was renamed in order to fix order of executing migrations when run from the ground up (via #3378). As a side effect, it's executed again on databases that had it applied earlier, with a different timestamp prefix. As this migration is safe to run multiple times, it was modified to make forward migration work gracefully when constraint already exists. * Add `pending-migrations.sh` release script
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR implements Shared Links resource exposed via the new Plugins API (work in progress, initially aiming at new Wordpress plugin integration).
The API implements OpenAPI Specification 3 (via https://hexdocs.pm/open_api_spex/readme.html) for the benefit of easier 3rd party client integration with stronger contract enforcement.
The Plugins API is served off a new router (
PlausibleWeb.Plugins.API.Router) that requests coming to/api/pluginsare forwarded to. This is only for the sake of readability, the TCP endpoint remains the same for now.The schema is served from
/api/plugins/spec/openapi, read by the swagger UI at/api/plugins/spec/swagger-ui. Based on the schema, clients should be able to generate their implementations and keep them verified against the contract definition. At later stage, we'll look into generating and publishing documentation from it, for now the swagger UI should be good enough.At later stage, incorporating schema generation into our CI flow will help us detect any breaking changes (we'll be able to compare the base schema to the PR submitted for example).
API authentication is done via tokens, carried over in the
authorizationheader, implemented via #3373 and #3370.The UI for provisioning authentication tokens will be done in a separate PR. Currently the
Plausible.Plugins.API.Tokens.create/2function can be used to play with the API locally.Tests
Changelog
Documentation
Dark mode