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

Define ScienceBase metadata publishing endpoint in user settings #708

Open
3 tasks
hmaier-fws opened this issue Jan 15, 2025 · 1 comment · May be fixed by #709
Open
3 tasks

Define ScienceBase metadata publishing endpoint in user settings #708

hmaier-fws opened this issue Jan 15, 2025 · 1 comment · May be fixed by #709
Assignees
Labels
documentation Improvements or additions to documentation enhancement Improve or modify an existing feature

Comments

@hmaier-fws
Copy link
Contributor

Currently, the mdEditor only supports publishing to the ScienceBase publishing service, with the url to the publishing API embedded within the code. However, users should have the ability to publish to any custom endpoint. An initial step toward providing a generic mdJSON packet to any API, is to allow users to specify the desired end point.

Initial support for a generic publishing feature can be implemented by:

  • Adding a "Metadata publishing API URL" field below the "mdTranslator API URL" field on the Settings page.
  • Modify the ScienceBase publishing function ("ScienceBase" button on the Publish page) to obtain the publishing API URL from the value entered on the Settings page.
  • The value for the "Metadata publishing API URL" should be read from, and written to the saved settings
@hmaier-fws hmaier-fws added enhancement Improve or modify an existing feature documentation Improvements or additions to documentation labels Jan 15, 2025
@hmaier-fws
Copy link
Contributor Author

hmaier-fws commented Jan 16, 2025

This should probably be under the "Publishing Settings", "ScienceBase" panel.

It looks like the publishing settings are stored as an object. Likely because there was a vision to allow for multiple publishing endpoints. We've been discussing possibly having a generic publish feature that passes mdJSON to any api (which would be defined in the settings). Also, since we now have an option to connect to a CouchDB, we could probably add some defaults for that.

Currently, the publishing options are exported in the settings object as:

{
  "id": "<setting ID>"
  "attributes": {
    "compress-on-save": true,
    "show-splash": false,
    "keep-settings": true,
    "auto-save": false,
    "publish-options": "{\"sb-defaultParent\":\"<sb parent ID>\"}",
    etc....
  }
}

We'll probably need to discuss the best way to structure the publish-options object to support multiple publishers.

@eyeyellow eyeyellow linked a pull request Jan 21, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Improve or modify an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants