All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.armeria.thrift.CentralDogma.json Maven / Gradle / Ivy

Go to download

Highly-available version-controlled service configuration repository based on Git, ZooKeeper and HTTP/2 (centraldogma-common-legacy)

The newest version!
{"name":"CentralDogma","enums":[
{"name":"ErrorCode","members":[{"name":"UNIMPLEMENTED","value":"1"},{"name":"INTERNAL_SERVER_ERROR","value":"2"},{"name":"BAD_REQUEST","value":"3"},{"name":"PROJECT_NOT_FOUND","value":"4"},{"name":"PROJECT_EXISTS","value":"5"},{"name":"REPOSITORY_NOT_FOUND","value":"6"},{"name":"REPOSITORY_EXISTS","value":"7"},{"name":"REVISION_NOT_FOUND","value":"8"},{"name":"REVISION_EXISTS","value":"9","doc":"Unused; use CHANGE_CONFLICT.\n"},{"name":"ENTRY_NOT_FOUND","value":"10"},{"name":"REDUNDANT_CHANGE","value":"11"},{"name":"CHANGE_CONFLICT","value":"12"},{"name":"QUERY_FAILURE","value":"13"},{"name":"SHUTTING_DOWN","value":"14"}]}
,{"name":"EntryType","members":[{"name":"JSON","value":"1"},{"name":"TEXT","value":"2"},{"name":"DIRECTORY","value":"3"}]}
,{"name":"ChangeType","members":[{"name":"UPSERT_JSON","value":"1"},{"name":"UPSERT_TEXT","value":"2"},{"name":"REMOVE","value":"3"},{"name":"RENAME","value":"4"},{"name":"APPLY_JSON_PATCH","value":"5"},{"name":"APPLY_TEXT_PATCH","value":"6"}]}
,{"name":"PropertyType","members":[{"name":"REQUIRED","value":"1"},{"name":"DYNAMIC","value":"2"}]}
,{"name":"Markup","members":[{"name":"UNKNOWN","value":"1"},{"name":"PLAINTEXT","value":"2"},{"name":"MARKDOWN","value":"3"}]}
,{"name":"PluginOperationDataType","members":[{"name":"UNDEFINED","value":"1"},{"name":"BOOLEAN","value":"2"},{"name":"NUMBER","value":"3"},{"name":"STRING","value":"4"},{"name":"OBJECT","value":"5"},{"name":"ARRAY","value":"6"}]}
,{"name":"PropertyFilterType","members":[{"name":"JSON_PATH","value":"1"}]}
,{"name":"QueryType","members":[{"name":"IDENTITY","value":"1"},{"name":"JSON_PATH","value":"2"},{"name":"IDENTITY_TEXT","value":"3"},{"name":"IDENTITY_JSON","value":"4"}]}
]
,"typedefs":[
{"name":"RevisionNumber","type":"i32"}
,{"name":"Timestamp","type":"string"}
,{"name":"EntryPath","type":"string"}
]
,"structs":[
{"name":"CentralDogmaException","isException":"true","fields":[{"index":"1","name":"errorCode","type":"ErrorCode","required":"true"},{"index":"2","name":"message","type":"string","required":"false"}]}
,{"name":"Entry","fields":[{"index":"1","name":"path","type":"EntryPath","required":"true"},{"index":"2","name":"type","type":"EntryType","required":"true"},{"index":"3","name":"content","type":"string","required":"false"}]}
,{"name":"MergedEntry","fields":[{"index":"1","name":"revision","type":"Revision","required":"true"},{"index":"2","name":"type","type":"EntryType","required":"true"},{"index":"3","name":"content","type":"string","required":"true"},{"index":"4","name":"paths","type":"list","required":"true"}]}
,{"name":"MergeSource","fields":[{"index":"1","name":"path","type":"EntryPath","required":"true"},{"index":"2","name":"isOptional","type":"bool","required":"true"}]}
,{"name":"Change","fields":[{"index":"1","name":"path","type":"EntryPath","required":"true"},{"index":"2","name":"type","type":"ChangeType","required":"true"},{"index":"3","name":"content","type":"string","required":"false"}]}
,{"name":"Revision","fields":[{"index":"1","name":"major","type":"RevisionNumber","required":"true"},{"index":"2","name":"minor","type":"RevisionNumber","required":"true"}]}
,{"name":"Author","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"2","name":"email","type":"string","required":"true"}]}
,{"name":"Comment","fields":[{"index":"1","name":"content","type":"string","required":"true"},{"index":"2","name":"markup","type":"Markup","required":"false","default":"PLAINTEXT"}]}
,{"name":"Commit","fields":[{"index":"1","name":"revision","type":"Revision","required":"true"},{"index":"2","name":"author","type":"Author","required":"true"},{"index":"3","name":"timestamp","type":"Timestamp","required":"true"},{"index":"4","name":"summary","type":"string","required":"true"},{"index":"5","name":"detail","type":"Comment","required":"true"},{"index":"6","name":"diffs","type":"list","required":"true","default":"[]"}]}
,{"name":"Repository","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"2","name":"head","type":"Commit","required":"false"}]}
,{"name":"PropertyFilter","fields":[{"index":"1","name":"type","type":"PropertyFilterType","required":"true"},{"index":"2","name":"content","type":"string","required":"true"}]}
,{"name":"SchemaEntry","fields":[{"index":"1","name":"repositoryName","type":"string","required":"true"},{"index":"2","name":"path","type":"EntryPath","required":"true"},{"index":"3","name":"propertyFilter","type":"PropertyFilter","required":"true"},{"index":"4","name":"types","type":"list","required":"true"},{"index":"5","name":"comment","type":"Comment","required":"false"}]}
,{"name":"Schema","fields":[{"index":"1","name":"entries","type":"list","required":"true"}]}
,{"name":"PluginOperationParamDef","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"2","name":"type","type":"PluginOperationDataType","required":"true"},{"index":"3","name":"comment","type":"Comment","required":"false"}]}
,{"name":"PluginOperationReturnDef","fields":[{"index":"1","name":"type","type":"PluginOperationDataType","required":"true"},{"index":"2","name":"comment","type":"Comment","required":"false"}]}
,{"name":"PluginOperation","fields":[{"index":"1","name":"pluginName","type":"string","required":"true"},{"index":"2","name":"operationName","type":"string","required":"true"},{"index":"3","name":"paramDefs","type":"list","required":"true"},{"index":"4","name":"returnDef","type":"PluginOperationReturnDef","required":"true"},{"index":"5","name":"comment","type":"Comment","required":"false"}]}
,{"name":"Plugin","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"2","name":"path","type":"EntryPath","required":"true"}]}
,{"name":"Project","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"3","name":"schema","type":"Schema","required":"false"},{"index":"4","name":"plugins","type":"list","required":"false","default":"[]"}]}
,{"name":"Query","fields":[{"index":"1","name":"path","type":"string","required":"true"},{"index":"2","name":"type","type":"QueryType","required":"true"},{"index":"3","name":"expressions","type":"list","required":"true"}]}
,{"name":"MergeQuery","fields":[{"index":"1","name":"type","type":"QueryType","required":"true"},{"index":"2","name":"mergeSources","type":"list","required":"true"},{"index":"3","name":"expressions","type":"list","required":"true"}]}
,{"name":"NamedQuery","fields":[{"index":"1","name":"name","type":"string","required":"true"},{"index":"2","name":"enabled","type":"bool","required":"true"},{"index":"3","name":"repositoryName","type":"string","required":"true"},{"index":"4","name":"query","type":"Query","required":"true"},{"index":"5","name":"comment","type":"Comment","required":"false"}]}
,{"name":"Subscriber","fields":[{"index":"1","name":"address","type":"string","required":"true"},{"index":"2","name":"port","type":"i32","required":"true"}]}
,{"name":"GetFileResult","fields":[{"index":"1","name":"type","type":"EntryType","required":"true"},{"index":"2","name":"content","type":"string","required":"true"}]}
,{"name":"DiffFileResult","fields":[{"index":"1","name":"type","type":"ChangeType","required":"true"},{"index":"2","name":"content","type":"string","required":"true"}]}
,{"name":"WatchRepositoryResult","fields":[{"index":"1","name":"revision","type":"Revision","required":"false"}]}
,{"name":"WatchFileResult","fields":[{"index":"1","name":"revision","type":"Revision","required":"false"},{"index":"2","name":"type","type":"EntryType","required":"false"},{"index":"3","name":"content","type":"string","required":"false"}]}
]
,"constants":[
{"name":"HEAD","type":"RevisionNumber","value":""}
,{"name":"DOGMA","type":"string","value":"dogma"}
,{"name":"META","type":"string","value":"meta"}
,{"name":"EMPTY_WATCH_REPOSITORY_RESULT","type":"WatchRepositoryResult","value":"[]"}
,{"name":"EMPTY_WATCH_FILE_RESULT","type":"WatchFileResult","value":"[]"}
]
,"services":[
{"name":"CentralDogmaService","doc":"Central Dogma Service\n","functions":[{"name":"createProject","returnType":"void","doc":"Creates a project.\n","arguments":[{"index":"1","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"removeProject","returnType":"void","doc":"Removes a project.\n","arguments":[{"index":"1","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"purgeProject","returnType":"void","doc":"Purges a project.\n","arguments":[{"index":"1","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"unremoveProject","returnType":"void","doc":"Unremoves a project.\n","arguments":[{"index":"1","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listProjects","returnType":"list","doc":"Retrieves the list of the projects.\n","arguments":[],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listRemovedProjects","returnType":"set","doc":"Retrieves the list of the removed projects.\n","arguments":[],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"createRepository","returnType":"void","doc":"Creates a repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"removeRepository","returnType":"void","doc":"Removes a repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"purgeRepository","returnType":"void","doc":"Purges a repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"unremoveRepository","returnType":"void","doc":"Unremoves a repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listRepositories","returnType":"list","doc":"Retrieves the list of the repositories.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listRemovedRepositories","returnType":"set","doc":"Retrieves the list of the removed repositories.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"normalizeRevision","returnType":"Revision","doc":"Converts the relative revision number to the absolute revision number. (e.g. -1 -> 3, -1.-1 -> 3.4)\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listFiles","returnType":"list","doc":"Retrieves the list of the files in the path.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"},{"index":"4","name":"pathPattern","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getFiles","returnType":"list","doc":"Retrieves the files that match the path pattern.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"},{"index":"4","name":"pathPattern","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getHistory","returnType":"list","doc":"Retrieves the history of the repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"fromRevision","type":"Revision","required":"false"},{"index":"4","name":"toRevision","type":"Revision","required":"false"},{"index":"5","name":"pathPattern","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getDiffs","returnType":"list","doc":"Retrieves the diffs matched by the path pattern from {@code from} to {@code to}.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"fromRevision","type":"Revision","required":"false"},{"index":"4","name":"toRevision","type":"Revision","required":"false"},{"index":"5","name":"pathPattern","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getPreviewDiffs","returnType":"list","doc":"Retrieves preview diffs on {@code baseRevsion} for {@code changes}.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"baseRevision","type":"Revision","required":"false"},{"index":"4","name":"changes","type":"list","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"push","returnType":"Commit","doc":"Pushes the changes to the repository.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"baseRevision","type":"Revision","required":"false"},{"index":"4","name":"author","type":"Author","required":"false"},{"index":"5","name":"summary","type":"string","required":"false"},{"index":"6","name":"detail","type":"Comment","required":"false"},{"index":"7","name":"changes","type":"list","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getFile","returnType":"GetFileResult","doc":"Queries a file at the specified revision.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"},{"index":"4","name":"query","type":"Query","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"diffFile","returnType":"DiffFileResult","doc":"Queries a file at two different revisions and return the diff of the two query results.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"fromRevision","type":"Revision","required":"false"},{"index":"4","name":"toRevision","type":"Revision","required":"false"},{"index":"5","name":"query","type":"Query","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"mergeFiles","returnType":"MergedEntry","doc":"Retrieves the merged entry of the specified query at the specified revision. Only JSON entry\nmerge is currently supported. The JSON files are merged sequentially as specified in the mergeQuery.\nNote that only object is recursively merged traversing the children. Others are simply replaced.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"},{"index":"4","name":"mergeQuery","type":"MergeQuery","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"watchRepository","returnType":"WatchRepositoryResult","doc":"Awaits and returns the latest known revision since the specified revision.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"lastKnownRevision","type":"Revision","required":"false"},{"index":"4","name":"pathPattern","type":"string","required":"false"},{"index":"5","name":"timeoutMillis","type":"i64","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"watchFile","returnType":"WatchFileResult","doc":"Awaits and returns the query result of the specified file since the specified last known revision.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"lastKnownRevision","type":"Revision","required":"false"},{"index":"4","name":"query","type":"Query","required":"false"},{"index":"5","name":"timeoutMillis","type":"i64","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getSchema","returnType":"Schema","doc":"Gets the schema.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"saveSchema","returnType":"void","doc":"Saves the schema.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"schema","type":"Schema","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getNamedQuery","returnType":"NamedQuery","doc":"Gets the named query.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"saveNamedQuery","returnType":"void","doc":"Saves the named query.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"namedQuery","type":"NamedQuery","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"removeNamedQuery","returnType":"void","doc":"Removes the named query.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"name","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listNamedQueries","returnType":"list","doc":"Retrieves the list of the named queries.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"getPlugin","returnType":"Plugin","doc":"Gets the plugin.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"pluginName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"savePlugin","returnType":"void","doc":"Saves the plugin.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"plugin","type":"Plugin","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"removePlugin","returnType":"void","doc":"Removes the plugin.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"pluginName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listPlugins","returnType":"list","doc":"Retrieves the list of the plugins.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listPluginOperations","returnType":"list","doc":"Retrieves the list of all operations provided by the plugin.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"performPluginOperation","returnType":"string","doc":"Performs the plugin operation.\n

\n

    \n
  • {@code params} is a JSON dictionary whose keys and values are the names and values\n of the parameters.<\/li>\n
  • The return value is one of the following:\n
      \n
    • a JSON object,<\/li>\n
    • a JSON array,<\/li>\n
    • a number,<\/li>\n
    • a boolean value ({@code true} or {@code false}) or<\/li>\n
    • {@code null}<\/li>\n <\/ul>\n <\/li>\n<\/ul>\n<\/p>\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"pluginName","type":"string","required":"false"},{"index":"3","name":"operationName","type":"string","required":"false"},{"index":"4","name":"params","type":"string","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"queryByNamedQuery","returnType":"string","doc":"Queries by the named query.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"namedQuery","type":"string","required":"false"},{"index":"3","name":"revision","type":"Revision","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]},{"name":"listSubscribers","returnType":"list","doc":"Retrieves the list of the subscribers for the json file.\n","arguments":[{"index":"1","name":"projectName","type":"string","required":"false"},{"index":"2","name":"repositoryName","type":"string","required":"false"},{"index":"3","name":"path","type":"EntryPath","required":"false"}],"exceptions":[{"index":"1","name":"e","type":"CentralDogmaException","required":"false"}]}]} ]}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy