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

docs(broker): Describe what Broker does and how to interact with it #571

Merged
merged 23 commits into from
Sep 20, 2023

Conversation

lukehesluke
Copy link
Contributor

Closes #570


* Broker Microservice config
* Derived Broker Microservice config e.g. `bookingApiBaseUrl` is parsed from the [Dataset Site JSON](https://openactive.io/dataset-api-discovery/EditorsDraft/#embedded-json) that was loaded from the Dataset Site defined by the [`datasetSiteUrl` configuration property](#datasetsiteurl).
* Config from the `OpenActiveTestAuthKeyManager` that Broker Microservice sets up. See [openactive-openid-test-client](../openactive-openid-test-client/) for more info.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are a few references to docs that do not yet exist in openactive-openid-test-client. The plan is to resolve them in this issue (as has been put into the description): https://github.com/orgs/openactive/projects/17/views/8?pane=issue&itemId=37982448

@lukehesluke lukehesluke marked this pull request as ready for review September 13, 2023 18:11
@lukehesluke lukehesluke changed the title [DRAFT] docs(broker): Describe what Broker does and how to interact with it docs(broker): Describe what Broker does and how to interact with it Sep 13, 2023
Copy link
Collaborator

@nickevansuk nickevansuk left a comment

Choose a reason for hiding this comment

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

Approved with some suggestions

packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-broker-microservice/README.md Outdated Show resolved Hide resolved
packages/openactive-integration-tests/README.md Outdated Show resolved Hide resolved
@lukehesluke lukehesluke merged commit 8fb5565 into master Sep 20, 2023
32 checks passed
@lukehesluke lukehesluke deleted the feature/broker-functionality-docs branch September 20, 2023 09:41
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.

Broker Microservice: Document its current functionality
2 participants