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

Add Documentation for Federated operations #187

Open
d47853 opened this issue Dec 11, 2019 · 3 comments
Open

Add Documentation for Federated operations #187

d47853 opened this issue Dec 11, 2019 · 3 comments
Labels
feature A new feature/component for the documentation
Milestone

Comments

@d47853
Copy link
Member

d47853 commented Dec 11, 2019

Add a section for FederatedStore operations such as:

  • AddGraph
  • AddGraphWithHooks
  • RemoveGraph
  • GetAllGraphIds
  • ChangeGraphAccess
  • GetAllGraphInfo
@n3101 n3101 added this to the v2.0.0 milestone Aug 25, 2021
@GCHQDeveloper314
Copy link
Member

Now consists of these operations to be added to the reference section:

  • federatedstore.operation.AddGraph
  • federatedstore.operation.AddGraphWithHooks
  • federatedstore.operation.ChangeGraphAccess
  • federatedstore.operation.ChangeGraphId
  • federatedstore.operation.FederatedOperation
  • federatedstore.operation.GetAllGraphIds
  • federatedstore.operation.GetAllGraphInfo
  • federatedstore.operation.RemoveGraph
  • federatedstore.operation.RemoveGraphAndDeleteAllData

@GCHQDeveloper314 GCHQDeveloper314 added the feature A new feature/component for the documentation label Jul 12, 2023
@GCHQDeveloper314
Copy link
Member

Most of these operations are covered by the Federated Store guide. In #416 it's been mentioned that a guide is not the best place for them. As part of this issue, operation specific documentation from that guide can be moved to the reference section.

@GCHQDeveloper314
Copy link
Member

Also ensure that the operation examples use the same format (examples in JSON, Java, Python) as found elsewhere in the reference guides. The examples currently in the Federated Store guide don't include Python or use the compact code tabs formatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature/component for the documentation
Projects
None yet
Development

No branches or pull requests

3 participants