Commit Graph

240 Commits

Author SHA1 Message Date
Connor
f667fe7658 Contributor Docs Improvements Round 2 (#18667)
* add delete by query information and examples

* add that changelogs should be past tense

* add examples of unit and blackbox tests

* add information on where upload/extension folder should go locally

* add new packages and remove redundant column

* fix spelling

* Create hot-pillows-tan.md

* Fix tip box and links

* Update docs/contributing/codebase-overview.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update docs/contributing/running-locally.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-30 12:30:58 -04:00
Brainslug
f96dcc361f Translation string performance (#18097)
* broken migration

* fixed migration

* created new endpoints for translation strings

* updated to use core endpoint

* bad attempts at making the endpoints sensible

* merge changes

* implemented translation strings service

* re-integrating app logic part 1

* re-integrating app logic part 2

* fixed bad lodash import

* re-integrating app logic part 3

* removed obsolete tests

* make the linter happy

* Create tender-trees-buy.md

* added option to search-input

* implementing search

* fixed resizing and sidebar

* Fix linting

* Remove unused translations update into project settings

* Fix missing translations

* Require read permissions for app access

* Fetch translation strings only when authenticated

* Fix project default language not used when user has default language

* Remove commented line

* Rename variable as content has been changed

* Make the current user check more specific

* Remove translation_string from Settings type

* Remove settings reference in docs

* Update changeset

* Rename migration file to ensure date order

* Rename collection, route, service, controller

* Rename migration

* Adjust collection in settings route

* Fix translations service

* Use new `shouldClearCache` util

* Drop translation_strings column in migration

Co-authored-by: ian <licitdev@gmail.com>

* Added basic api docs

* updated dictionary

* updated dictionary

* Update app/src/interfaces/_system/system-input-translated-string/input-translated-string.vue

Co-authored-by: Nicola Krumschmidt <nicola.krumschmidt@freenet.de>

* Update app/src/modules/settings/routes/translation-strings/collection.vue

Co-authored-by: Nicola Krumschmidt <nicola.krumschmidt@freenet.de>

* extracted getCurrentLanguage utility

* Use regular collections/items

* Use regular controller

* Fix item view

* Set correct system field config for translations

* Tweaks

* Use UUID

* Finish placeholders

* Use drawer-item

* Add create to the store

* Remove composables

* Add new placeholder

* Fix saving behavior

* Remove previous take

* Rename migration after merge of live preview

* Generate uuid when migrating

* Remove unused showFilter

* Fix linting

* Fix type warnings

* Not needed as settings no longer contain translation_strings

* Remove leftover blank line

* Update getCurrentLanguage with server default and use in hydrate

* Shift getCurrentLanguage to lang folder to be alongside setLanguage

* add elipsis to placeholder

* Remove slug from key, so you can use dots etc in the key

* updated translation value to be type text again

* Rehydrate fields for updated translation values

* Add tooltip

* updated documentation

* enforce key/language uniqueness in the TranslationService

* updated error message

* updated docs menu item to "custom translations"

* Dynamically fetch translation keys for input-translated-string interface

* use get current language in refresh

* Update docs/reference/system/translations.md

* Update docs/reference/system/translations.md

* Update .changeset/tender-trees-buy.md

* Fetch translation keys when new key is created

* Update api/src/services/translations.ts

* Remove translation_strings remnant

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* mark key, language and value as required

* correctly mark fields as required

* Catch duplicate key error when creating from input

* Translate translations :-)

* Update tender-trees-buy.md

---------

Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Nicola Krumschmidt <nicola.krumschmidt@freenet.de>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2023-05-26 12:35:44 -04:00
ian
cf1d6a640d Remove server info (#18648)
* Remove OS info

* Add changeset

* Update unit test

* Remove Directus version

* Remove unused dependency

* Update changeset

* Update example in docs

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Update changeset

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-18 19:28:48 +00:00
Brainslug
af55402680 Adding a maximum for query limit (#17309)
* Adding a maximum for query limit

* fixed bad env check

* using the getEnv function to make it better testable

* updated sanitize-query tests

* added tests for the validate query function

* Added DEFAULT_QUERY_LIMIT as fallback instead

* make the linter happy

* accept infinity as max_query_limit

* fixed merge conflicts

* added missing import

* moved docs PR into main repo

* added missing import

* renamed vars

* basic page size limiting

* Update app/src/layouts/cards/cards.vue

* Update app/src/layouts/map/map.vue

* Update app/src/layouts/tabular/tabular.vue

* Update app/src/layouts/tabular/tabular.vue

* Create paginate util

* extracted page size logic to composable and implemented default usage in app

* updated paginate utility

* using the new fetch-all utility

* removed limit: -1 for api calls that do not support it

* fix linter

* removed console log

* making the linter happy

* Create loud-flowers-yawn.md

* Add tests for no / unlimited limit

* Cover all cases for max limit in sanitizeQuery

* Get rid of non-null assertion

* added test for composable

* Update var names in documentation

* replace hardcoded limit default with env var

* update default page size behavior

* fixed test

* update server info api reference

* include queryLimit in graphql server info

* use configured max limit in calendar layout

* use configured max limit in kanban layout

* account for max query limit in use-revisions

---------

Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
2023-05-12 21:59:03 +08:00
Jan Arends
8b8858da9a Support multipart/form-data to apply schema diffs (#18321)
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-02 10:24:46 +00:00
Matthew Rumery
bf10c943c8 Fix broken links in the documentation (#18377)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
2023-05-02 10:03:32 +02:00
Rijk van Zanten
2bc226d16f Change license to BSL-1.1 (#18330)
* Change license to BSL1.1

* Mark major version

* Fix formatting

* Remove duplicate heading

* Update formatting

* Copy paste error

* Update license

* Update license

* Format covenants

* Update readme.md

* Update licenses for packages

* Update readme.md

* Update contributors.yml

OG... but to be clear, rijkvanzanten is the one who really built all of this ❤️

* Tweak license in openapi

* Update packages/specs/src/openapi.yaml

* Add MIT license headers

* Use v10 in examples

* Update additional examples

* Update generate-extensions-entrypoint.test.ts

* Update tests to use latest v9 and v10 versions

* use lowercase for naming consistency

* change casing for api license

* Update migrations doc

* Update dictionary

* Consistent ordering of license field in app/package.json

* Use major version in specs again (but as string)

So it's valid for all v10 versions

* Consolidate readme's

---------

Co-authored-by: Ben Haynes <ben@directus.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: ian <licitdev@gmail.com>
Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
2023-04-26 14:10:42 -04:00
Akshay Sood
5e52d94769 Renamed variable for brevity (#18195)
* Renamed variable for better clarity

* Signed contributors.yml
2023-04-14 16:10:15 -04:00
Nitwel
898b580707 Autoconvert assets if browser supports it (#18012)
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2023-04-12 15:08:51 +00:00
Rijk van Zanten
c723085902 Move docs to monorepo (#18052)
* Move docs to monorepo

* Tweaks
2023-04-04 18:23:58 -04:00
Rijk van Zanten
288e7d62b9 Move docs folder to dedicated repo (#14192)
* Move docs to https://github.com/directus/docs

* Update included docs
2022-06-29 13:47:45 -04:00
Brainslug
58f37fa4d3 fixes 404 links in docs (#13995) 2022-06-20 10:19:21 -04:00
Eron Donevan Powell
3fa81b6b9c Docs config refactor (#13945)
* moved config-options.md to self-hosted

* added non-docs files that link to config-options

* moved SSO and fixed links

* moved upgrades-migrations into self-hosted

* moved filter-rules into reference docs and fixed broken links
2022-06-17 11:51:38 -04:00
Rijk van Zanten
3b2245918d Allow setting a custom filename in the /assets endpoint for SEO (#13907)
* Allow an optional custom filename in the assets route

* Document optional assets endpoint route

* Update docs/reference/files.md
2022-06-15 12:32:36 -04:00
Azri Kahar
c4ee1c1747 Docs & Specs update for Data Flows (#13358)
* Add flows & operations API reference

* remove webhooks from docs

* remove webhooks from spec

* add flows specs

* add operations specs

* fix path

* actual complete fix

* Revert "remove webhooks from docs"

This reverts commit fae1103d61.

* Revert "remove webhooks from spec"

This reverts commit ec7a836cd3.

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-06-07 16:25:38 -04:00
Eron Donevan Powell
4ee582405b updated docs links (#13670) 2022-06-01 14:55:55 -05:00
Rijk van Zanten
f9a3413586 Update items.md 2022-05-27 11:28:59 -04:00
Louis
447de05051 last_page type was date instead of str (#13577)
* `last_page` type was `date` instead of `str`

* Update docs/reference/system/users.md

Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
2022-05-26 12:06:48 -04:00
Eron Donevan Powell
d46886d5ac Docs: re-edited user-directory + users-roles-permissions (#13424)
* re-edited user-directory and users-roles-permissions

* added Overview
2022-05-24 14:14:46 -04:00
Eron Donevan Powell
bf752856d0 how to work with nested data (#13489) 2022-05-23 14:17:51 -04:00
Jesper
b2d8b2319a GraphQL count aggregation for all fields and * (#11871)
* GraphQL count aggregation for all fields

Fixes #11792

* Rename countRows to countAll

* moved function to new apply-query folder

Co-authored-by: jaycammarano <jay.cammarano@gmail.com>
2022-05-18 15:34:12 +00:00
Josh Soref
0b01923b0d Spelling (#13072) 2022-05-02 13:16:03 -04:00
Azri Kahar
7f8eb2d926 fix naming & typo in CLI docs (#13037) 2022-04-28 05:51:23 +00:00
rijkvanzanten
5cce44fa05 Remove deadlink 2022-04-18 19:12:07 -04:00
Lukas Breitstadt
09d9b4b323 Await when token is refreshing & reinstate msRefreshBeforeExpires flag (#12649) 2022-04-12 07:52:33 -04:00
rijkvanzanten
029a66ef31 Add note on SDK requestOptions usage
Fixes #12628
2022-04-11 12:31:34 -04:00
rijkvanzanten
7c36fa42a6 Add missing reference for user object
Fixes #12669
2022-04-11 09:36:52 -04:00
Azri Kahar
d023b36838 Add import file method to SDK (#12575) 2022-04-05 10:39:29 -04:00
Azri Kahar
67c37ae11c Add count function in docs (#12576)
* Add `count` function in docs

* Rename relational to array functions

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-04-05 09:43:51 -04:00
Azri Kahar
d0b0818cca Return 401 status code for expired tokens (#12281)
* Refresh token when it's expired & retry request

* move refresh token interceptor in autoRefresh flag

* add TOKEN_EXPIRED exception

* update interceptor condition & fix autoRefreshJob

* update docs

* revert auth drivers changes

* remove unused imports

* undo sdk auth refresh changes
2022-04-04 09:23:28 -04:00
Jake Cattrall
d24dacd075 Use date (epoch) compare workflow instead of timer to refresh token in SDK (#12399)
* use date compare workflow instead of timer

* convert milliseconds to seconds

* add missing references to auth_expired_at key

* correct calculation and presume getTime returns milliseconds

* resolve issue with static tokens

* prevents token refresh before everything else is initialized

* remove timer based authentication tests

Co-authored-by: Azri Kahar <42867097+azrikahar@users.noreply.github.com>
2022-04-01 09:31:11 -04:00
Rijk van Zanten
1c3e94d830 Add new export experience (#12201)
* Use script setup

* Start on export dialog

* Use new system field interface, replace limit with numeric input

* Set placeholder

* Add sort config

* Use folder picker, correct layoutQuery use

* Add local download button

* Allow writing exports to file

* Add notification after export

* Fix sort config, use new export endpoint

* Setup notification hints

* Add information notice

* Fix local limit, cancel button

* Add (basic) docs for export functionality

* Fix json export file format

* Implement xml batch stitching

* Resolve review points
2022-03-17 15:43:45 -04:00
Spencer Jones
469f6400b7 add --dry-run flag to schema apply CLI command (#12006)
Co-authored-by: Spencer Jones <sjones@morningconsult.com>
2022-03-07 17:52:02 +00:00
Eron Donevan Powell
1bc7da6967 Docs: update CSS and pics (#11634)
* .gitignored package-lock.json that was created in the docs subfolder

* tweaked color names, except the ones in in vue files

* converted terminal screencaps into markdown

* updated images in 'Content'

* updated user-directory images

* updated media in file-library

* moved picsto cloud in reference>files

* updated images in config > datamodels > relationships

* updated primary colors in app-overview.svg

* updated insights images

* swapped quickstart-guide media and touched up copy

* Update last colors, remove linting from docs temporarily

* Fix theme color

* Update homepage header image

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-02-21 15:32:09 -05:00
Abdón Rodríguez Davila
3de9bc1ada Update rollup-plugin-styles to v4 (#11689)
* Update rollup-plugin-styles to v4

* Update Rollup packages
2022-02-18 11:25:50 -05:00
Dominic Marcelino
c148e1d441 CLI docs Tip: Create date based snapshots (#11698)
A small custom script to create multiple snapshots organized by date. Can be used e.g on a server where git is not available for snapshot versionizing.
2022-02-18 10:28:31 -05:00
José Varela
de5b34d87b SDK: split readMany into itself and readByQuery (#11204)
* split readMany into self and readByQuery

* add tests

* run tests only on `test` folder

* fix docs

* fix in `cli`
2022-02-16 09:52:42 -05:00
Stephan Schmitz
64dfc04a86 Fix snapshot options documentation error (#11540)
Closes #11537
2022-02-09 18:30:10 +08:00
Stephan Schmitz
f7507dc906 Document --yes option for creating schema snapshots (#11366) 2022-01-31 14:30:28 -05:00
Stephan Schmitz
fab37abb60 Document --yes option to skip manual confirmation when applying a schema snapshot (#11356)
There's an undocumented `--yes` option, which is a rather valuable information and should be documented. For example, when you run the migration step in a CI/CD workflow, you don't want the manual prompt.
2022-01-31 11:10:04 -05:00
Eron Donevan Powell
8daed9c41b Docs: The Insights Module (#11175)
* Added insights docs draft and images

* updated insights draft doc images, grammar, links and beyond

* adjusted text and formatting in several areas

* minor language tweak

* removed local images. refromatted ::: on tips

* spaced ::: before and after

* Minor editing tweaks to headers and copy

* added link to explain panels in 'how it works'

* Added link on time sseries 'group aggregation' to the 'more on aggregate functions' section.

* Add standardized style for images/videos

* fixed naming on mp4 videos

* Tweak styles a bit

* Remove old nav link

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2022-01-29 17:41:57 +00:00
Josh Dean
7497676794 Documentation Polishing (#11267)
* glossary.md small typo

Documentation

* update docs glossary.md type

Documentation

* docs config-options.md typo

Documentation

* Update relationships.md

Documentation small typo

* Update relationships.md

documentation, small typo

* Update relationships.md

Documentation typo. I believe line 261 is an alias for the junction table.

* Update relationships.md

Docs Typo

* Update relationships.md

Docs Typos

* Update data-model.md

Docs Typo.

* Update sso.md

docs typo

* Update introduction.md

docs typo

* Update query.md

example isn't "on right" when read on mobile.

* Update introduction.md

Docs - confusing phrasing. Hope this helps.

* Update sdk.md

Unfinished sentence removed. Likely a copy paste from a discussion of instance prefixes.

* Update activity.md

Docs extra word
2022-01-25 13:06:10 -05:00
Brainslug
595eb696ea Remove reference to readByQuery (#11188)
Updated order of examples and aligned titles to match
Added missing updateOne example
2022-01-20 15:24:40 -05:00
José Varela
f32f8eb19f add alert about nested alias (#11108) 2022-01-17 13:52:15 -05:00
Azri Kahar
74bb4a7c9a Add Unsupported Media Type Exception (#11096)
* add unsuported media type exception

* throw error when not multipart/form-data

* use unsupportedMediaType when checking import file

* add `UNSUPPORTED_MEDIA_TYPE` to Error Codes docs
2022-01-17 10:09:26 -05:00
keesvanbemmel
b13afc7445 Installation guide for Google Cloud Platform (#10936)
* Added missing data field to sessions yaml

* rebased sessions.yaml

* Initial commit

* Initial complete guide

* Added LOGGER_LEVELS addition

* Removed redundant VPC cost aspect

* Added login details after deployment

* Minor textual changes

* Made requested changes by @azrikahar

* Changed github repo link from keesvanbemmel to gcp-example in community

* Added Run on Google Cloud button to readme.
2022-01-12 10:35:57 -05:00
Azri Kahar
ed70219ecb fix Read By Query example code (#10943) 2022-01-10 04:15:26 +00:00
José Varela
fd885b14ea Docs(SDK): use top level await upload (#10827) 2022-01-03 15:04:07 +00:00
Azri Kahar
e9445df387 update docs on descriptor in project settings (#10813) 2022-01-03 09:56:50 -05:00
Azri Kahar
f4720f6ed2 minor fix for closing tag in file upload example (#10816) 2022-01-03 06:42:41 +00:00