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 discrepency in definition of Context type in 1.2 API documentation #405

Closed
kriswest opened this issue Jun 21, 2021 · 0 comments · Fixed by #406
Closed

Fix discrepency in definition of Context type in 1.2 API documentation #405

kriswest opened this issue Jun 21, 2021 · 0 comments · Fixed by #406
Labels
api FDC3 API Working Group bug Something isn't working docs Documentation

Comments

@kriswest
Copy link
Contributor

Minor Issue

The definition of the Context type in the API documentation does not match the spec or source code.

Area of Issue

[ ] App Directory
[x] API
[x] Context Data
[ ] Intents
[ ] Use Cases
[ ] Other

Issue Description:

When defining Context, the API documentation state that:

The API specification allows this to be any object, but typically this is supposed to be a context data object adhering to the [Context Data Specification]

This is not actually true, the API specification doesn't actually define Context, but does make use of typed context throughout (the only actual requirement on the structure of the Context object in the context specification is that it has a string type field). For example, it doesn't make sense to a typed context or intent listener without the type being present.

The source code provided with the specification specifically imports the Context definition from the Context specification, hence, the documentation is at odds with both the specification and source code and should be corrected.

Additional Context:

this comes from the early days of FDC3, where API was disconnected from Context Data, and the idea was that the API is not opinionated about the shape of the data, and it could be ANY object. Hence, you could fdc3.broadcast(object). But you COULD use fdc3 context data envelope and be more specific.

This changed in FDC3 1.1 and the documentation was not updated to reflect this.

@kriswest kriswest added bug Something isn't working docs Documentation api FDC3 API Working Group labels Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group bug Something isn't working docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant