Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: README.md ocmproviders.json example #8931

Merged
merged 1 commit into from Apr 29, 2024

Conversation

jnweiger
Copy link
Contributor

@jnweiger jnweiger commented Apr 23, 2024

  • The correct name is not providers.json, but ocmproviders.json
  • The trailing comma causes a syntax error during ocis startup: "error":"unable to register services: rgrpc: grpc service ocmproviderauthorizer could not be started,: invalid character ']' looking for beginning of value"

(The table in https://doc.owncloud.com/ocis/5.0/deployment/services/s-list/ocm.html#environment-variables has the name spelled with a hyphen (looks like ocm-providers.json) which is misleading, as it is just a soft-hyphen due to the narrow column, and the hyphen disappears during copy/paste. )

Description

Related Issue

  • Fixes <issue_link>

Motivation and Context

How Has This Been Tested?

  • test environment:
  • test case 1:
  • test case 2:
  • ...

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation ticket raised:

The trailing comma is a syntax error,
the correct name is not providers.json, but ocmproviders.json

(The table in https://doc.owncloud.com/ocis/5.0/deployment/services/s-list/ocm.html#environment-variables
has the name spelled with a hyphen, this is misleading, as it is just a soft-hyphen due to the narrow column, and the hyphen disappears during copy/paste. )
Copy link

update-docs bot commented Apr 23, 2024

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

Copy link

sonarcloud bot commented Apr 23, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@mmattel
Copy link
Contributor

mmattel commented Apr 23, 2024

Needs also fixed into the admin docs.

jnweiger added a commit to owncloud/docs-ocis that referenced this pull request Apr 23, 2024
@jnweiger
Copy link
Contributor Author

Needs also fixed into the admin docs.

-> owncloud/docs-ocis#806

@micbar micbar merged commit 079ad3e into master Apr 29, 2024
2 checks passed
@delete-merged-branch delete-merged-branch bot deleted the jnweiger-ocmproviders-json-syntax branch April 29, 2024 15:14
ownclouders pushed a commit that referenced this pull request Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants