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

Rework and document configuration #56

Merged
merged 8 commits into from
Oct 1, 2023
Merged

Rework and document configuration #56

merged 8 commits into from
Oct 1, 2023

Conversation

Siegrift
Copy link
Collaborator

@Siegrift Siegrift commented Sep 27, 2023

Closes #49
Closes #54
Closes #14

My initial goal was to document the pusher package, but I realized there is no point in doing so before finishing the config changes (and I would need to redo the docs immediately). So I implemented the agreed config changes and made the documentation consistent with it.

@Siegrift Siegrift self-assigned this Sep 27, 2023
@@ -38,7 +34,7 @@ defines two endpoints. The `/real-time` serves the non-delayed data, the latter
that has bee pushed in the last 15 seconds (configured by `delaySeconds` parameter). You can define multiple endpoints
as long as the `urlPath` is unique.

## Usage
## API
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've (subjectively) reordered based on importance, similarly in the pusher.

@@ -1,6 +1,17 @@
<!-- TODO: Rename data-pusher workspace to pusher -->
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could do this now, but I am afraid of the conflicts so ideally will do this after other PRs are merged.

import { go } from '@api3/promise-utils';
import * as node from '@api3/airnode-node';
import { unsafeEvaluate, unsafeEvaluateAsync } from './unsafe-evaluate';

export const postProcessApiSpecifications = async (input: unknown, endpoint: Endpoint) => {
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually not needed.

@Siegrift Siegrift force-pushed the rewamp-configuration branch from bcea612 to 2e54cbe Compare October 1, 2023 10:00
@Siegrift Siegrift changed the title Improve and document configuration Rework and document configuration Oct 1, 2023
@Siegrift Siegrift merged commit de46069 into main Oct 1, 2023
3 checks passed
@Siegrift Siegrift deleted the rewamp-configuration branch October 1, 2023 11:05
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.

Minor pusher config changes Avoid specifying Airnode address in pusher config Document pusher package
1 participant