Updated developer docs #269
Merged
Conversation
This file contains hidden or 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
| - task npm-install | ||
| - task compose-up | ||
| - task composer-install | ||
| - task db:migrate --yes |
There was a problem hiding this comment.
Can we do an "if fixtures apply fixtures"?
There was a problem hiding this comment.
Added extra task for this
UPGRADE.md
Outdated
|
|
||
| ## 2.x -> 3.0.0 | ||
|
|
||
| When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project. |
There was a problem hiding this comment.
Upgrading OS2Display from version 2.x to 3.0.0 introduces a major change to the project.
UPGRADE.md
Outdated
|
|
||
| ## 2.x -> 3.0.0 | ||
|
|
||
| When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project. |
There was a problem hiding this comment.
Suggested change
| When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project. | |
| When upgrading from 2.x to 3.0.0 of OS2Display, a mayor change has been introduced to the project. |
|
|
||
| const oidcLogins = loginMethods.filter( | ||
| (loginMethod) => loginMethod.enabled && loginMethod.type === "oidc", | ||
| (loginMethod) => loginMethod.type === "oidc", |
There was a problem hiding this comment.
Suggested change
| (loginMethod) => loginMethod.type === "oidc", | |
| ({ type }) =>type === "oidc", |
| const usernamePasswordLogins = loginMethods.filter( | ||
| (loginMethod) => | ||
| loginMethod.enabled && loginMethod.type === "username-password", | ||
| (loginMethod) => loginMethod.type === "username-password", |
There was a problem hiding this comment.
Suggested change
| (loginMethod) => loginMethod.type === "username-password", | |
| ({ type }) => type === "username-password", |
sinejespersen
approved these changes
Sep 1, 2025
…y-api-service into feature/developer-docs
turegjorup
approved these changes
Sep 1, 2025
README.md
Outdated
| ## Stateless | ||
|
|
||
| The API is stateless except `/v2/authentication` routes. | ||
| Make sure to set the `CORS_ALLOW_ORIGIN` correctly in `.env.local`. |
There was a problem hiding this comment.
What is the correct setting for a given domain?
Is this even relevant with mono repo setup given that the clients will always be hosted on the same domain?
There was a problem hiding this comment.
Good point. I will investigate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Link to issue
#249
Description
Checklist