github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/api/open_api_3.yaml

github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/api/open_api_3.yaml (about)

     1  openapi: 3.0.0
     2  info:
     3    title: Qri API
     4    description: Qri API used to communicate with a Qri node.
     5    version: n/a
     6  tags:
     7  - name: access
     8    description: "AccessMethods is a group of methods for access control & user authentication "
     9  - name: collection
    10    description: "CollectionMethods lists a user's datasets. Datasets in a collection consist of datasets the user has created and other datasets the user has pulled.  Collections are local. The same user's collection on one qri node will often be different from another node, depending on what datasets have been created, pushed, or pulled to that node "
    11  - name: dataset
    12    description: "DatasetMethods work with datasets, creating new versions (save), reading dataset data (get), deleting versions (remove), and moving datasets over network connections (push & pull) "
    13  - name: diff
    14    description: "DiffMethods encapsulates logic for diffing Datasets on Qri "
    15  - name: peer
    16    description: "PeerMethods extends a lib.Instance with business logic for peer-to-peer interaction "
    17  - name: profile
    18    description: "ProfileMethods encapsulates business logic for this node's user profile TODO (b5) - alterations to user profile are a subset of configuration changes. all of this code should be refactored into subroutines of general configuration getters & setters "
    19  - name: follow
    20    description: "FollowMethods groups together methods for follows "
    21  - name: remote
    22    description: "RemoteMethods encapsulates business logic of remote operation TODO (b5): switch to using an Instance instead of separate fields "
    23  - name: search
    24    description: "SearchMethods groups together methods for search "
    25  - name: automation
    26    description: "AutomationMethods groups together methods for automations "
    27  paths:
    28    '/access/token':
    29      post:
    30        description: CreateAuthToken constructs a JWT string token suitable for making OAuth requests as the grantee user. Creating an access token requires a stored private key for the grantee. Callers can provide either granteeUsername OR granteeProfileID 
    31        operationId: 'access.CreateAuthToken'
    32        tags:
    33        - access
    34        requestBody:
    35          required: true
    36          content:
    37            application/json:
    38              schema:
    39                '$ref': '#/components/schemas/CreateAuthTokenParams'
    40        
    41        
    42        responses:
    43          '200':
    44            content:
    45              application/json:
    46                schema:
    47                  allOf:
    48                    - $ref: '#/components/schemas/APIResponse'
    49                    - properties:
    50                        data:
    51                          allOf:
    52                            - $ref: '#/components/schemas/RawResponse'
    53  
    54            description: OK
    55          '400':
    56            content:
    57              application/json:
    58                schema:
    59                  allOf:
    60                    - $ref: '#/components/schemas/APIResponse'
    61                    - properties:
    62                        meta:
    63                          allOf:
    64                            - $ref: '#/components/schemas/APIMetaError'
    65            description: Bad request
    66          '500':
    67            content:
    68              application/json:
    69                schema:
    70                  type: string
    71                  nullable: true
    72            description: Server error
    73          default:
    74            content:
    75              application/json:
    76                schema:
    77                  allOf:
    78                    - $ref: '#/components/schemas/APIResponse'
    79                    - properties:
    80                        meta:
    81                          allOf:
    82                            - $ref: '#/components/schemas/APIMetaError'
    83            description: Error
    84    '/collection/get':
    85      post:
    86        description: Get gets the head of a dataset as a VersionInfo from the collection 
    87        operationId: 'collection.Get'
    88        tags:
    89        - collection
    90        requestBody:
    91          required: true
    92          content:
    93            application/json:
    94              schema:
    95                '$ref': '#/components/schemas/CollectionGetParams'
    96        
    97        
    98        responses:
    99          '200':
   100            content:
   101              application/json:
   102                schema:
   103                  allOf:
   104                    - $ref: '#/components/schemas/APIResponse'
   105                    - properties:
   106                        data:
   107                          allOf:
   108                            - $ref: '#/components/schemas/VersionInfo'
   109  
   110            description: OK
   111          '400':
   112            content:
   113              application/json:
   114                schema:
   115                  allOf:
   116                    - $ref: '#/components/schemas/APIResponse'
   117                    - properties:
   118                        meta:
   119                          allOf:
   120                            - $ref: '#/components/schemas/APIMetaError'
   121            description: Bad request
   122          '500':
   123            content:
   124              application/json:
   125                schema:
   126                  type: string
   127                  nullable: true
   128            description: Server error
   129          default:
   130            content:
   131              application/json:
   132                schema:
   133                  allOf:
   134                    - $ref: '#/components/schemas/APIResponse'
   135                    - properties:
   136                        meta:
   137                          allOf:
   138                            - $ref: '#/components/schemas/APIMetaError'
   139            description: Error
   140    '/list':
   141      post:
   142        description: List gets the reflist for either the local repo or a peer 
   143        operationId: 'collection.List'
   144        tags:
   145        - collection
   146        requestBody:
   147          required: true
   148          content:
   149            application/json:
   150              schema:
   151                '$ref': '#/components/schemas/ListParams'
   152        
   153        
   154        responses:
   155          '200':
   156            content:
   157              application/json:
   158                schema:
   159                  allOf:
   160                    - $ref: '#/components/schemas/APIResponse'
   161                    - properties:
   162                        data:
   163  
   164                          type: array
   165                          items:
   166                            allOf:
   167                              - $ref: '#/components/schemas/VersionInfo'
   168  
   169            description: OK
   170          '400':
   171            content:
   172              application/json:
   173                schema:
   174                  allOf:
   175                    - $ref: '#/components/schemas/APIResponse'
   176                    - properties:
   177                        meta:
   178                          allOf:
   179                            - $ref: '#/components/schemas/APIMetaError'
   180            description: Bad request
   181          '500':
   182            content:
   183              application/json:
   184                schema:
   185                  type: string
   186                  nullable: true
   187            description: Server error
   188          default:
   189            content:
   190              application/json:
   191                schema:
   192                  allOf:
   193                    - $ref: '#/components/schemas/APIResponse'
   194                    - properties:
   195                        meta:
   196                          allOf:
   197                            - $ref: '#/components/schemas/APIMetaError'
   198            description: Error
   199    '/ds/activity':
   200      post:
   201        description: Activity returns the activity and changes for a given dataset 
   202        operationId: 'dataset.Activity'
   203        tags:
   204        - dataset
   205        requestBody:
   206          required: true
   207          content:
   208            application/json:
   209              schema:
   210                '$ref': '#/components/schemas/ActivityParams'
   211        
   212        
   213        responses:
   214          '200':
   215            content:
   216              application/json:
   217                schema:
   218                  allOf:
   219                    - $ref: '#/components/schemas/APIResponse'
   220                    - properties:
   221                        data:
   222  
   223                          type: array
   224                          items:
   225                            allOf:
   226                              - $ref: '#/components/schemas/VersionInfo'
   227  
   228            description: OK
   229          '400':
   230            content:
   231              application/json:
   232                schema:
   233                  allOf:
   234                    - $ref: '#/components/schemas/APIResponse'
   235                    - properties:
   236                        meta:
   237                          allOf:
   238                            - $ref: '#/components/schemas/APIMetaError'
   239            description: Bad request
   240          '500':
   241            content:
   242              application/json:
   243                schema:
   244                  type: string
   245                  nullable: true
   246            description: Server error
   247          default:
   248            content:
   249              application/json:
   250                schema:
   251                  allOf:
   252                    - $ref: '#/components/schemas/APIResponse'
   253                    - properties:
   254                        meta:
   255                          allOf:
   256                            - $ref: '#/components/schemas/APIMetaError'
   257            description: Error
   258    '/ds/daginfo':
   259      post:
   260        description: DAGInfo generates a dag.Info for a dataset path. If a label is given, DAGInfo will generate a sub-dag.Info at that label. 
   261        operationId: 'dataset.DAGInfo'
   262        tags:
   263        - dataset
   264        requestBody:
   265          required: true
   266          content:
   267            application/json:
   268              schema:
   269                '$ref': '#/components/schemas/DAGInfoParams'
   270        
   271        
   272        responses:
   273          '200':
   274            content:
   275              application/json:
   276                schema:
   277                  allOf:
   278                    - $ref: '#/components/schemas/APIResponse'
   279                    - properties:
   280                        data:
   281                          allOf:
   282                            - $ref: '#/components/schemas/DAGInfo'
   283  
   284            description: OK
   285          '400':
   286            content:
   287              application/json:
   288                schema:
   289                  allOf:
   290                    - $ref: '#/components/schemas/APIResponse'
   291                    - properties:
   292                        meta:
   293                          allOf:
   294                            - $ref: '#/components/schemas/APIMetaError'
   295            description: Bad request
   296          '500':
   297            content:
   298              application/json:
   299                schema:
   300                  type: string
   301                  nullable: true
   302            description: Server error
   303          default:
   304            content:
   305              application/json:
   306                schema:
   307                  allOf:
   308                    - $ref: '#/components/schemas/APIResponse'
   309                    - properties:
   310                        meta:
   311                          allOf:
   312                            - $ref: '#/components/schemas/APIMetaError'
   313            description: Error
   314    '/ds/get':
   315      post:
   316        description: Get retrieves datasets and components for a given reference. p.Ref is parsed to create a reference, which is used to load the dataset. It will be loaded from the local repo or from the filesystem if it has a linked working directory. Using p.Selector will control what components are returned in res.Value. The default, a blank selector, will also fill the entire dataset at res.Value. If the selector contains '.script' then res.Bytes is loaded with the script contents as bytes. If the selector is 'stats', then res.Value is loaded with the generated stats. 
   317        operationId: 'dataset.Get'
   318        tags:
   319        - dataset
   320        requestBody:
   321          required: true
   322          content:
   323            application/json:
   324              schema:
   325                '$ref': '#/components/schemas/GetParams'
   326        
   327        
   328        responses:
   329          '200':
   330            content:
   331              application/json:
   332                schema:
   333                  allOf:
   334                    - $ref: '#/components/schemas/APIResponse'
   335                    - properties:
   336                        data:
   337                          allOf:
   338                            - $ref: '#/components/schemas/GetResult'
   339  
   340            description: OK
   341          '400':
   342            content:
   343              application/json:
   344                schema:
   345                  allOf:
   346                    - $ref: '#/components/schemas/APIResponse'
   347                    - properties:
   348                        meta:
   349                          allOf:
   350                            - $ref: '#/components/schemas/APIMetaError'
   351            description: Bad request
   352          '500':
   353            content:
   354              application/json:
   355                schema:
   356                  type: string
   357                  nullable: true
   358            description: Server error
   359          default:
   360            content:
   361              application/json:
   362                schema:
   363                  allOf:
   364                    - $ref: '#/components/schemas/APIResponse'
   365                    - properties:
   366                        meta:
   367                          allOf:
   368                            - $ref: '#/components/schemas/APIMetaError'
   369            description: Error
   370    '/ds/manifest':
   371      post:
   372        description: Manifest generates a manifest for a dataset path 
   373        operationId: 'dataset.Manifest'
   374        tags:
   375        - dataset
   376        requestBody:
   377          required: true
   378          content:
   379            application/json:
   380              schema:
   381                '$ref': '#/components/schemas/ManifestParams'
   382        
   383        
   384        responses:
   385          '200':
   386            content:
   387              application/json:
   388                schema:
   389                  allOf:
   390                    - $ref: '#/components/schemas/APIResponse'
   391                    - properties:
   392                        data:
   393                          allOf:
   394                            - $ref: '#/components/schemas/DAGManifest'
   395  
   396            description: OK
   397          '400':
   398            content:
   399              application/json:
   400                schema:
   401                  allOf:
   402                    - $ref: '#/components/schemas/APIResponse'
   403                    - properties:
   404                        meta:
   405                          allOf:
   406                            - $ref: '#/components/schemas/APIMetaError'
   407            description: Bad request
   408          '500':
   409            content:
   410              application/json:
   411                schema:
   412                  type: string
   413                  nullable: true
   414            description: Server error
   415          default:
   416            content:
   417              application/json:
   418                schema:
   419                  allOf:
   420                    - $ref: '#/components/schemas/APIResponse'
   421                    - properties:
   422                        meta:
   423                          allOf:
   424                            - $ref: '#/components/schemas/APIMetaError'
   425            description: Error
   426    '/ds/manifest/missing':
   427      post:
   428        description: ManifestMissing generates a manifest of blocks that are not present on this repo for a given manifest 
   429        operationId: 'dataset.ManifestMissing'
   430        tags:
   431        - dataset
   432        requestBody:
   433          required: true
   434          content:
   435            application/json:
   436              schema:
   437                '$ref': '#/components/schemas/ManifestMissingParams'
   438        
   439        
   440        responses:
   441          '200':
   442            content:
   443              application/json:
   444                schema:
   445                  allOf:
   446                    - $ref: '#/components/schemas/APIResponse'
   447                    - properties:
   448                        data:
   449                          allOf:
   450                            - $ref: '#/components/schemas/DAGManifest'
   451  
   452            description: OK
   453          '400':
   454            content:
   455              application/json:
   456                schema:
   457                  allOf:
   458                    - $ref: '#/components/schemas/APIResponse'
   459                    - properties:
   460                        meta:
   461                          allOf:
   462                            - $ref: '#/components/schemas/APIMetaError'
   463            description: Bad request
   464          '500':
   465            content:
   466              application/json:
   467                schema:
   468                  type: string
   469                  nullable: true
   470            description: Server error
   471          default:
   472            content:
   473              application/json:
   474                schema:
   475                  allOf:
   476                    - $ref: '#/components/schemas/APIResponse'
   477                    - properties:
   478                        meta:
   479                          allOf:
   480                            - $ref: '#/components/schemas/APIMetaError'
   481            description: Error
   482    '/ds/pull':
   483      post:
   484        description: Pull downloads and stores an existing dataset to a peer's repository via a network connection 
   485        operationId: 'dataset.Pull'
   486        tags:
   487        - dataset
   488        requestBody:
   489          required: true
   490          content:
   491            application/json:
   492              schema:
   493                '$ref': '#/components/schemas/PullParams'
   494        
   495        
   496        responses:
   497          '200':
   498            content:
   499              application/json:
   500                schema:
   501                  allOf:
   502                    - $ref: '#/components/schemas/APIResponse'
   503                    - properties:
   504                        data:
   505                          allOf:
   506                            - $ref: '#/components/schemas/Dataset'
   507  
   508            description: OK
   509          '400':
   510            content:
   511              application/json:
   512                schema:
   513                  allOf:
   514                    - $ref: '#/components/schemas/APIResponse'
   515                    - properties:
   516                        meta:
   517                          allOf:
   518                            - $ref: '#/components/schemas/APIMetaError'
   519            description: Bad request
   520          '500':
   521            content:
   522              application/json:
   523                schema:
   524                  type: string
   525                  nullable: true
   526            description: Server error
   527          default:
   528            content:
   529              application/json:
   530                schema:
   531                  allOf:
   532                    - $ref: '#/components/schemas/APIResponse'
   533                    - properties:
   534                        meta:
   535                          allOf:
   536                            - $ref: '#/components/schemas/APIMetaError'
   537            description: Error
   538    '/ds/push':
   539      post:
   540        description: Push posts a dataset version to a remote 
   541        operationId: 'dataset.Push'
   542        tags:
   543        - dataset
   544        requestBody:
   545          required: true
   546          content:
   547            application/json:
   548              schema:
   549                '$ref': '#/components/schemas/PushParams'
   550        
   551        
   552        responses:
   553          '200':
   554            content:
   555              application/json:
   556                schema:
   557                  allOf:
   558                    - $ref: '#/components/schemas/APIResponse'
   559                    - properties:
   560                        data:
   561                          allOf:
   562                            - $ref: '#/components/schemas/Ref'
   563  
   564            description: OK
   565          '400':
   566            content:
   567              application/json:
   568                schema:
   569                  allOf:
   570                    - $ref: '#/components/schemas/APIResponse'
   571                    - properties:
   572                        meta:
   573                          allOf:
   574                            - $ref: '#/components/schemas/APIMetaError'
   575            description: Bad request
   576          '500':
   577            content:
   578              application/json:
   579                schema:
   580                  type: string
   581                  nullable: true
   582            description: Server error
   583          default:
   584            content:
   585              application/json:
   586                schema:
   587                  allOf:
   588                    - $ref: '#/components/schemas/APIResponse'
   589                    - properties:
   590                        meta:
   591                          allOf:
   592                            - $ref: '#/components/schemas/APIMetaError'
   593            description: Error
   594    '/ds/remove':
   595      post:
   596        description: Remove a dataset entirely or remove a certain number of revisions 
   597        operationId: 'dataset.Remove'
   598        tags:
   599        - dataset
   600        requestBody:
   601          required: true
   602          content:
   603            application/json:
   604              schema:
   605                '$ref': '#/components/schemas/RemoveParams'
   606        
   607        
   608        responses:
   609          '200':
   610            content:
   611              application/json:
   612                schema:
   613                  allOf:
   614                    - $ref: '#/components/schemas/APIResponse'
   615                    - properties:
   616                        data:
   617                          allOf:
   618                            - $ref: '#/components/schemas/RemoveResponse'
   619  
   620            description: OK
   621          '400':
   622            content:
   623              application/json:
   624                schema:
   625                  allOf:
   626                    - $ref: '#/components/schemas/APIResponse'
   627                    - properties:
   628                        meta:
   629                          allOf:
   630                            - $ref: '#/components/schemas/APIMetaError'
   631            description: Bad request
   632          '500':
   633            content:
   634              application/json:
   635                schema:
   636                  type: string
   637                  nullable: true
   638            description: Server error
   639          default:
   640            content:
   641              application/json:
   642                schema:
   643                  allOf:
   644                    - $ref: '#/components/schemas/APIResponse'
   645                    - properties:
   646                        meta:
   647                          allOf:
   648                            - $ref: '#/components/schemas/APIMetaError'
   649            description: Error
   650    '/ds/rename':
   651      post:
   652        description: Rename changes a user's given name for a dataset 
   653        operationId: 'dataset.Rename'
   654        tags:
   655        - dataset
   656        requestBody:
   657          required: true
   658          content:
   659            application/json:
   660              schema:
   661                '$ref': '#/components/schemas/RenameParams'
   662        
   663        
   664        responses:
   665          '200':
   666            content:
   667              application/json:
   668                schema:
   669                  allOf:
   670                    - $ref: '#/components/schemas/APIResponse'
   671                    - properties:
   672                        data:
   673                          allOf:
   674                            - $ref: '#/components/schemas/VersionInfo'
   675  
   676            description: OK
   677          '400':
   678            content:
   679              application/json:
   680                schema:
   681                  allOf:
   682                    - $ref: '#/components/schemas/APIResponse'
   683                    - properties:
   684                        meta:
   685                          allOf:
   686                            - $ref: '#/components/schemas/APIMetaError'
   687            description: Bad request
   688          '500':
   689            content:
   690              application/json:
   691                schema:
   692                  type: string
   693                  nullable: true
   694            description: Server error
   695          default:
   696            content:
   697              application/json:
   698                schema:
   699                  allOf:
   700                    - $ref: '#/components/schemas/APIResponse'
   701                    - properties:
   702                        meta:
   703                          allOf:
   704                            - $ref: '#/components/schemas/APIMetaError'
   705            description: Error
   706    '/ds/render':
   707      post:
   708        description: Render renders a viz or readme component as html 
   709        operationId: 'dataset.Render'
   710        tags:
   711        - dataset
   712        requestBody:
   713          required: true
   714          content:
   715            application/json:
   716              schema:
   717                '$ref': '#/components/schemas/RenderParams'
   718        
   719        
   720        responses:
   721          '200':
   722            content:
   723              application/json:
   724                schema:
   725                  allOf:
   726                    - $ref: '#/components/schemas/APIResponse'
   727                    - properties:
   728                        data:
   729                          allOf:
   730                            - $ref: '#/components/schemas/RawResponse'
   731  
   732            description: OK
   733          '400':
   734            content:
   735              application/json:
   736                schema:
   737                  allOf:
   738                    - $ref: '#/components/schemas/APIResponse'
   739                    - properties:
   740                        meta:
   741                          allOf:
   742                            - $ref: '#/components/schemas/APIMetaError'
   743            description: Bad request
   744          '500':
   745            content:
   746              application/json:
   747                schema:
   748                  type: string
   749                  nullable: true
   750            description: Server error
   751          default:
   752            content:
   753              application/json:
   754                schema:
   755                  allOf:
   756                    - $ref: '#/components/schemas/APIResponse'
   757                    - properties:
   758                        meta:
   759                          allOf:
   760                            - $ref: '#/components/schemas/APIMetaError'
   761            description: Error
   762    '/ds/save':
   763      post:
   764        description: Save adds a history entry, updating a dataset 
   765        operationId: 'dataset.Save'
   766        tags:
   767        - dataset
   768        requestBody:
   769          required: true
   770          content:
   771            application/json:
   772              schema:
   773                '$ref': '#/components/schemas/SaveParams'
   774        
   775        
   776        responses:
   777          '200':
   778            content:
   779              application/json:
   780                schema:
   781                  allOf:
   782                    - $ref: '#/components/schemas/APIResponse'
   783                    - properties:
   784                        data:
   785                          allOf:
   786                            - $ref: '#/components/schemas/Dataset'
   787  
   788            description: OK
   789          '400':
   790            content:
   791              application/json:
   792                schema:
   793                  allOf:
   794                    - $ref: '#/components/schemas/APIResponse'
   795                    - properties:
   796                        meta:
   797                          allOf:
   798                            - $ref: '#/components/schemas/APIMetaError'
   799            description: Bad request
   800          '500':
   801            content:
   802              application/json:
   803                schema:
   804                  type: string
   805                  nullable: true
   806            description: Server error
   807          default:
   808            content:
   809              application/json:
   810                schema:
   811                  allOf:
   812                    - $ref: '#/components/schemas/APIResponse'
   813                    - properties:
   814                        meta:
   815                          allOf:
   816                            - $ref: '#/components/schemas/APIMetaError'
   817            description: Error
   818    '/ds/validate':
   819      post:
   820        description: Validate gives a dataset of errors and issues for a given dataset 
   821        operationId: 'dataset.Validate'
   822        tags:
   823        - dataset
   824        requestBody:
   825          required: true
   826          content:
   827            application/json:
   828              schema:
   829                '$ref': '#/components/schemas/ValidateParams'
   830        
   831        
   832        responses:
   833          '200':
   834            content:
   835              application/json:
   836                schema:
   837                  allOf:
   838                    - $ref: '#/components/schemas/APIResponse'
   839                    - properties:
   840                        data:
   841                          allOf:
   842                            - $ref: '#/components/schemas/ValidateResponse'
   843  
   844            description: OK
   845          '400':
   846            content:
   847              application/json:
   848                schema:
   849                  allOf:
   850                    - $ref: '#/components/schemas/APIResponse'
   851                    - properties:
   852                        meta:
   853                          allOf:
   854                            - $ref: '#/components/schemas/APIMetaError'
   855            description: Bad request
   856          '500':
   857            content:
   858              application/json:
   859                schema:
   860                  type: string
   861                  nullable: true
   862            description: Server error
   863          default:
   864            content:
   865              application/json:
   866                schema:
   867                  allOf:
   868                    - $ref: '#/components/schemas/APIResponse'
   869                    - properties:
   870                        meta:
   871                          allOf:
   872                            - $ref: '#/components/schemas/APIMetaError'
   873            description: Error
   874    '/changes':
   875      post:
   876        description: Changes resolves the requested datasets and tries to generate a change report 
   877        operationId: 'diff.Changes'
   878        tags:
   879        - diff
   880        requestBody:
   881          required: true
   882          content:
   883            application/json:
   884              schema:
   885                '$ref': '#/components/schemas/ChangeReportParams'
   886        
   887        
   888        responses:
   889          '200':
   890            content:
   891              application/json:
   892                schema:
   893                  allOf:
   894                    - $ref: '#/components/schemas/APIResponse'
   895                    - properties:
   896                        data:
   897                          allOf:
   898                            - $ref: '#/components/schemas/ChangeReport'
   899  
   900            description: OK
   901          '400':
   902            content:
   903              application/json:
   904                schema:
   905                  allOf:
   906                    - $ref: '#/components/schemas/APIResponse'
   907                    - properties:
   908                        meta:
   909                          allOf:
   910                            - $ref: '#/components/schemas/APIMetaError'
   911            description: Bad request
   912          '500':
   913            content:
   914              application/json:
   915                schema:
   916                  type: string
   917                  nullable: true
   918            description: Server error
   919          default:
   920            content:
   921              application/json:
   922                schema:
   923                  allOf:
   924                    - $ref: '#/components/schemas/APIResponse'
   925                    - properties:
   926                        meta:
   927                          allOf:
   928                            - $ref: '#/components/schemas/APIMetaError'
   929            description: Error
   930    '/diff':
   931      post:
   932        description: Diff computes the diff of two sources 
   933        operationId: 'diff.Diff'
   934        tags:
   935        - diff
   936        requestBody:
   937          required: true
   938          content:
   939            application/json:
   940              schema:
   941                '$ref': '#/components/schemas/DiffParams'
   942        
   943        
   944        responses:
   945          '200':
   946            content:
   947              application/json:
   948                schema:
   949                  allOf:
   950                    - $ref: '#/components/schemas/APIResponse'
   951                    - properties:
   952                        data:
   953                          allOf:
   954                            - $ref: '#/components/schemas/DiffResponse'
   955  
   956            description: OK
   957          '400':
   958            content:
   959              application/json:
   960                schema:
   961                  allOf:
   962                    - $ref: '#/components/schemas/APIResponse'
   963                    - properties:
   964                        meta:
   965                          allOf:
   966                            - $ref: '#/components/schemas/APIMetaError'
   967            description: Bad request
   968          '500':
   969            content:
   970              application/json:
   971                schema:
   972                  type: string
   973                  nullable: true
   974            description: Server error
   975          default:
   976            content:
   977              application/json:
   978                schema:
   979                  allOf:
   980                    - $ref: '#/components/schemas/APIResponse'
   981                    - properties:
   982                        meta:
   983                          allOf:
   984                            - $ref: '#/components/schemas/APIMetaError'
   985            description: Error
   986    '/peer/connect':
   987      post:
   988        description: Connect attempts to create a connection with a peer for a given peer.ID 
   989        operationId: 'peer.Connect'
   990        tags:
   991        - peer
   992        requestBody:
   993          required: true
   994          content:
   995            application/json:
   996              schema:
   997                '$ref': '#/components/schemas/ConnectParamsPod'
   998        
   999        
  1000        responses:
  1001          '200':
  1002            content:
  1003              application/json:
  1004                schema:
  1005                  allOf:
  1006                    - $ref: '#/components/schemas/APIResponse'
  1007                    - properties:
  1008                        data:
  1009                          allOf:
  1010                            - $ref: '#/components/schemas/Profile'
  1011  
  1012            description: OK
  1013          '400':
  1014            content:
  1015              application/json:
  1016                schema:
  1017                  allOf:
  1018                    - $ref: '#/components/schemas/APIResponse'
  1019                    - properties:
  1020                        meta:
  1021                          allOf:
  1022                            - $ref: '#/components/schemas/APIMetaError'
  1023            description: Bad request
  1024          '500':
  1025            content:
  1026              application/json:
  1027                schema:
  1028                  type: string
  1029                  nullable: true
  1030            description: Server error
  1031          default:
  1032            content:
  1033              application/json:
  1034                schema:
  1035                  allOf:
  1036                    - $ref: '#/components/schemas/APIResponse'
  1037                    - properties:
  1038                        meta:
  1039                          allOf:
  1040                            - $ref: '#/components/schemas/APIMetaError'
  1041            description: Error
  1042    '/connections/qri':
  1043      post:
  1044        description: ConnectedQriProfiles lists profiles we're currently connected to 
  1045        operationId: 'peer.ConnectedQriProfiles'
  1046        tags:
  1047        - peer
  1048        requestBody:
  1049          required: true
  1050          content:
  1051            application/json:
  1052              schema:
  1053                '$ref': '#/components/schemas/ConnectionsParams'
  1054        
  1055        
  1056        responses:
  1057          '200':
  1058            content:
  1059              application/json:
  1060                schema:
  1061                  allOf:
  1062                    - $ref: '#/components/schemas/APIResponse'
  1063                    - properties:
  1064                        data:
  1065  
  1066                          type: array
  1067                          items:
  1068                            allOf:
  1069                              - $ref: '#/components/schemas/Profile'
  1070  
  1071            description: OK
  1072          '400':
  1073            content:
  1074              application/json:
  1075                schema:
  1076                  allOf:
  1077                    - $ref: '#/components/schemas/APIResponse'
  1078                    - properties:
  1079                        meta:
  1080                          allOf:
  1081                            - $ref: '#/components/schemas/APIMetaError'
  1082            description: Bad request
  1083          '500':
  1084            content:
  1085              application/json:
  1086                schema:
  1087                  type: string
  1088                  nullable: true
  1089            description: Server error
  1090          default:
  1091            content:
  1092              application/json:
  1093                schema:
  1094                  allOf:
  1095                    - $ref: '#/components/schemas/APIResponse'
  1096                    - properties:
  1097                        meta:
  1098                          allOf:
  1099                            - $ref: '#/components/schemas/APIMetaError'
  1100            description: Error
  1101    '/connections':
  1102      post:
  1103        description: Connections lists PeerID's we're currently connected to. If running IPFS this will also return connected IPFS nodes 
  1104        operationId: 'peer.Connections'
  1105        tags:
  1106        - peer
  1107        requestBody:
  1108          required: true
  1109          content:
  1110            application/json:
  1111              schema:
  1112                '$ref': '#/components/schemas/ConnectionsParams'
  1113        
  1114        
  1115        responses:
  1116          '200':
  1117            content:
  1118              application/json:
  1119                schema:
  1120                  allOf:
  1121                    - $ref: '#/components/schemas/APIResponse'
  1122                    - properties:
  1123                        data:
  1124                          allOf:
  1125                            - $ref: '#/components/schemas/RawResponse'
  1126  
  1127            description: OK
  1128          '400':
  1129            content:
  1130              application/json:
  1131                schema:
  1132                  allOf:
  1133                    - $ref: '#/components/schemas/APIResponse'
  1134                    - properties:
  1135                        meta:
  1136                          allOf:
  1137                            - $ref: '#/components/schemas/APIMetaError'
  1138            description: Bad request
  1139          '500':
  1140            content:
  1141              application/json:
  1142                schema:
  1143                  type: string
  1144                  nullable: true
  1145            description: Server error
  1146          default:
  1147            content:
  1148              application/json:
  1149                schema:
  1150                  allOf:
  1151                    - $ref: '#/components/schemas/APIResponse'
  1152                    - properties:
  1153                        meta:
  1154                          allOf:
  1155                            - $ref: '#/components/schemas/APIMetaError'
  1156            description: Error
  1157    '/peer/disconnect':
  1158      post:
  1159        description: Disconnect explicitly closes a peer connection 
  1160        operationId: 'peer.Disconnect'
  1161        tags:
  1162        - peer
  1163        requestBody:
  1164          required: true
  1165          content:
  1166            application/json:
  1167              schema:
  1168                '$ref': '#/components/schemas/ConnectParamsPod'
  1169        
  1170        
  1171        responses:
  1172          '200':
  1173            content:
  1174              application/json:
  1175                schema:
  1176                  allOf:
  1177                    - $ref: '#/components/schemas/APIResponse'
  1178                    - properties:
  1179                        data:
  1180                          allOf:
  1181                            - $ref: '#/components/schemas/Nil'
  1182  
  1183            description: OK
  1184          '400':
  1185            content:
  1186              application/json:
  1187                schema:
  1188                  allOf:
  1189                    - $ref: '#/components/schemas/APIResponse'
  1190                    - properties:
  1191                        meta:
  1192                          allOf:
  1193                            - $ref: '#/components/schemas/APIMetaError'
  1194            description: Bad request
  1195          '500':
  1196            content:
  1197              application/json:
  1198                schema:
  1199                  type: string
  1200                  nullable: true
  1201            description: Server error
  1202          default:
  1203            content:
  1204              application/json:
  1205                schema:
  1206                  allOf:
  1207                    - $ref: '#/components/schemas/APIResponse'
  1208                    - properties:
  1209                        meta:
  1210                          allOf:
  1211                            - $ref: '#/components/schemas/APIMetaError'
  1212            description: Error
  1213    '/peer':
  1214      post:
  1215        description: Info shows peer profile details 
  1216        operationId: 'peer.Info'
  1217        tags:
  1218        - peer
  1219        requestBody:
  1220          required: true
  1221          content:
  1222            application/json:
  1223              schema:
  1224                '$ref': '#/components/schemas/PeerInfoParams'
  1225        
  1226        
  1227        responses:
  1228          '200':
  1229            content:
  1230              application/json:
  1231                schema:
  1232                  allOf:
  1233                    - $ref: '#/components/schemas/APIResponse'
  1234                    - properties:
  1235                        data:
  1236                          allOf:
  1237                            - $ref: '#/components/schemas/Profile'
  1238  
  1239            description: OK
  1240          '400':
  1241            content:
  1242              application/json:
  1243                schema:
  1244                  allOf:
  1245                    - $ref: '#/components/schemas/APIResponse'
  1246                    - properties:
  1247                        meta:
  1248                          allOf:
  1249                            - $ref: '#/components/schemas/APIMetaError'
  1250            description: Bad request
  1251          '500':
  1252            content:
  1253              application/json:
  1254                schema:
  1255                  type: string
  1256                  nullable: true
  1257            description: Server error
  1258          default:
  1259            content:
  1260              application/json:
  1261                schema:
  1262                  allOf:
  1263                    - $ref: '#/components/schemas/APIResponse'
  1264                    - properties:
  1265                        meta:
  1266                          allOf:
  1267                            - $ref: '#/components/schemas/APIMetaError'
  1268            description: Error
  1269    '/peer/list':
  1270      post:
  1271        description: List lists Peers on the qri network 
  1272        operationId: 'peer.List'
  1273        tags:
  1274        - peer
  1275        requestBody:
  1276          required: true
  1277          content:
  1278            application/json:
  1279              schema:
  1280                '$ref': '#/components/schemas/PeerListParams'
  1281        
  1282        
  1283        responses:
  1284          '200':
  1285            content:
  1286              application/json:
  1287                schema:
  1288                  allOf:
  1289                    - $ref: '#/components/schemas/APIResponse'
  1290                    - properties:
  1291                        data:
  1292  
  1293                          type: array
  1294                          items:
  1295                            allOf:
  1296                              - $ref: '#/components/schemas/Profile'
  1297  
  1298            description: OK
  1299          '400':
  1300            content:
  1301              application/json:
  1302                schema:
  1303                  allOf:
  1304                    - $ref: '#/components/schemas/APIResponse'
  1305                    - properties:
  1306                        meta:
  1307                          allOf:
  1308                            - $ref: '#/components/schemas/APIMetaError'
  1309            description: Bad request
  1310          '500':
  1311            content:
  1312              application/json:
  1313                schema:
  1314                  type: string
  1315                  nullable: true
  1316            description: Server error
  1317          default:
  1318            content:
  1319              application/json:
  1320                schema:
  1321                  allOf:
  1322                    - $ref: '#/components/schemas/APIResponse'
  1323                    - properties:
  1324                        meta:
  1325                          allOf:
  1326                            - $ref: '#/components/schemas/APIMetaError'
  1327            description: Error
  1328    '/profile':
  1329      post:
  1330        description: GetProfile get's this node's peer profile 
  1331        operationId: 'profile.GetProfile'
  1332        tags:
  1333        - profile
  1334        requestBody:
  1335          required: true
  1336          content:
  1337            application/json:
  1338              schema:
  1339                '$ref': '#/components/schemas/ProfileParams'
  1340        
  1341        
  1342        responses:
  1343          '200':
  1344            content:
  1345              application/json:
  1346                schema:
  1347                  allOf:
  1348                    - $ref: '#/components/schemas/APIResponse'
  1349                    - properties:
  1350                        data:
  1351                          allOf:
  1352                            - $ref: '#/components/schemas/Profile'
  1353  
  1354            description: OK
  1355          '400':
  1356            content:
  1357              application/json:
  1358                schema:
  1359                  allOf:
  1360                    - $ref: '#/components/schemas/APIResponse'
  1361                    - properties:
  1362                        meta:
  1363                          allOf:
  1364                            - $ref: '#/components/schemas/APIMetaError'
  1365            description: Bad request
  1366          '500':
  1367            content:
  1368              application/json:
  1369                schema:
  1370                  type: string
  1371                  nullable: true
  1372            description: Server error
  1373          default:
  1374            content:
  1375              application/json:
  1376                schema:
  1377                  allOf:
  1378                    - $ref: '#/components/schemas/APIResponse'
  1379                    - properties:
  1380                        meta:
  1381                          allOf:
  1382                            - $ref: '#/components/schemas/APIMetaError'
  1383            description: Error
  1384    '/profile/poster':
  1385      post:
  1386        description: SetPosterPhoto changes this active peer's poster image 
  1387        operationId: 'profile.SetPosterPhoto'
  1388        tags:
  1389        - profile
  1390        requestBody:
  1391          required: true
  1392          content:
  1393            application/json:
  1394              schema:
  1395                '$ref': '#/components/schemas/FileParams'
  1396        
  1397        
  1398        responses:
  1399          '200':
  1400            content:
  1401              application/json:
  1402                schema:
  1403                  allOf:
  1404                    - $ref: '#/components/schemas/APIResponse'
  1405                    - properties:
  1406                        data:
  1407                          allOf:
  1408                            - $ref: '#/components/schemas/Profile'
  1409  
  1410            description: OK
  1411          '400':
  1412            content:
  1413              application/json:
  1414                schema:
  1415                  allOf:
  1416                    - $ref: '#/components/schemas/APIResponse'
  1417                    - properties:
  1418                        meta:
  1419                          allOf:
  1420                            - $ref: '#/components/schemas/APIMetaError'
  1421            description: Bad request
  1422          '500':
  1423            content:
  1424              application/json:
  1425                schema:
  1426                  type: string
  1427                  nullable: true
  1428            description: Server error
  1429          default:
  1430            content:
  1431              application/json:
  1432                schema:
  1433                  allOf:
  1434                    - $ref: '#/components/schemas/APIResponse'
  1435                    - properties:
  1436                        meta:
  1437                          allOf:
  1438                            - $ref: '#/components/schemas/APIMetaError'
  1439            description: Error
  1440    '/profile/set':
  1441      post:
  1442        description: SetProfile stores changes to the active peer's editable profile 
  1443        operationId: 'profile.SetProfile'
  1444        tags:
  1445        - profile
  1446        requestBody:
  1447          required: true
  1448          content:
  1449            application/json:
  1450              schema:
  1451                '$ref': '#/components/schemas/SetProfileParams'
  1452        
  1453        
  1454        responses:
  1455          '200':
  1456            content:
  1457              application/json:
  1458                schema:
  1459                  allOf:
  1460                    - $ref: '#/components/schemas/APIResponse'
  1461                    - properties:
  1462                        data:
  1463                          allOf:
  1464                            - $ref: '#/components/schemas/Profile'
  1465  
  1466            description: OK
  1467          '400':
  1468            content:
  1469              application/json:
  1470                schema:
  1471                  allOf:
  1472                    - $ref: '#/components/schemas/APIResponse'
  1473                    - properties:
  1474                        meta:
  1475                          allOf:
  1476                            - $ref: '#/components/schemas/APIMetaError'
  1477            description: Bad request
  1478          '500':
  1479            content:
  1480              application/json:
  1481                schema:
  1482                  type: string
  1483                  nullable: true
  1484            description: Server error
  1485          default:
  1486            content:
  1487              application/json:
  1488                schema:
  1489                  allOf:
  1490                    - $ref: '#/components/schemas/APIResponse'
  1491                    - properties:
  1492                        meta:
  1493                          allOf:
  1494                            - $ref: '#/components/schemas/APIMetaError'
  1495            description: Error
  1496    '/profile/photo':
  1497      post:
  1498        description: SetProfilePhoto changes the active peer's profile image 
  1499        operationId: 'profile.SetProfilePhoto'
  1500        tags:
  1501        - profile
  1502        requestBody:
  1503          required: true
  1504          content:
  1505            application/json:
  1506              schema:
  1507                '$ref': '#/components/schemas/FileParams'
  1508        
  1509        
  1510        responses:
  1511          '200':
  1512            content:
  1513              application/json:
  1514                schema:
  1515                  allOf:
  1516                    - $ref: '#/components/schemas/APIResponse'
  1517                    - properties:
  1518                        data:
  1519                          allOf:
  1520                            - $ref: '#/components/schemas/Profile'
  1521  
  1522            description: OK
  1523          '400':
  1524            content:
  1525              application/json:
  1526                schema:
  1527                  allOf:
  1528                    - $ref: '#/components/schemas/APIResponse'
  1529                    - properties:
  1530                        meta:
  1531                          allOf:
  1532                            - $ref: '#/components/schemas/APIMetaError'
  1533            description: Bad request
  1534          '500':
  1535            content:
  1536              application/json:
  1537                schema:
  1538                  type: string
  1539                  nullable: true
  1540            description: Server error
  1541          default:
  1542            content:
  1543              application/json:
  1544                schema:
  1545                  allOf:
  1546                    - $ref: '#/components/schemas/APIResponse'
  1547                    - properties:
  1548                        meta:
  1549                          allOf:
  1550                            - $ref: '#/components/schemas/APIMetaError'
  1551            description: Error
  1552    '/registry/follow':
  1553      post:
  1554        description: Follow updates the follow status of the current user for a given dataset 
  1555        operationId: 'follow.Follow'
  1556        tags:
  1557        - follow
  1558        responses:
  1559          '200':
  1560            content:
  1561              application/json:
  1562                schema:
  1563                  allOf:
  1564                    - $ref: '#/components/schemas/APIResponse'
  1565                    - properties:
  1566                        data:
  1567                          allOf:
  1568                            - $ref: '#/components/schemas/Nil'
  1569  
  1570            description: OK
  1571          '400':
  1572            content:
  1573              application/json:
  1574                schema:
  1575                  allOf:
  1576                    - $ref: '#/components/schemas/APIResponse'
  1577                    - properties:
  1578                        meta:
  1579                          allOf:
  1580                            - $ref: '#/components/schemas/APIMetaError'
  1581            description: Bad request
  1582          '500':
  1583            content:
  1584              application/json:
  1585                schema:
  1586                  type: string
  1587                  nullable: true
  1588            description: Server error
  1589          default:
  1590            content:
  1591              application/json:
  1592                schema:
  1593                  allOf:
  1594                    - $ref: '#/components/schemas/APIResponse'
  1595                    - properties:
  1596                        meta:
  1597                          allOf:
  1598                            - $ref: '#/components/schemas/APIMetaError'
  1599            description: Error
  1600    '/registry/follow/list':
  1601      post:
  1602        description: Get returns a list of datasets a user follows 
  1603        operationId: 'follow.Get'
  1604        tags:
  1605        - follow
  1606        responses:
  1607          '200':
  1608            content:
  1609              application/json:
  1610                schema:
  1611                  allOf:
  1612                    - $ref: '#/components/schemas/APIResponse'
  1613                    - properties:
  1614                        data:
  1615  
  1616                          type: array
  1617                          items:
  1618                            allOf:
  1619                              - $ref: '#/components/schemas/Dataset'
  1620  
  1621            description: OK
  1622          '400':
  1623            content:
  1624              application/json:
  1625                schema:
  1626                  allOf:
  1627                    - $ref: '#/components/schemas/APIResponse'
  1628                    - properties:
  1629                        meta:
  1630                          allOf:
  1631                            - $ref: '#/components/schemas/APIMetaError'
  1632            description: Bad request
  1633          '500':
  1634            content:
  1635              application/json:
  1636                schema:
  1637                  type: string
  1638                  nullable: true
  1639            description: Server error
  1640          default:
  1641            content:
  1642              application/json:
  1643                schema:
  1644                  allOf:
  1645                    - $ref: '#/components/schemas/APIResponse'
  1646                    - properties:
  1647                        meta:
  1648                          allOf:
  1649                            - $ref: '#/components/schemas/APIMetaError'
  1650            description: Error
  1651    '/remote/feeds':
  1652      post:
  1653        description: Feeds returns a listing of datasets from a number of feeds like featured and popular. Each feed is keyed by string in the response 
  1654        operationId: 'remote.Feeds'
  1655        tags:
  1656        - remote
  1657        requestBody:
  1658          required: true
  1659          content:
  1660            application/json:
  1661              schema:
  1662                '$ref': '#/components/schemas/EmptyParams'
  1663        
  1664        
  1665        responses:
  1666          '200':
  1667            content:
  1668              application/json:
  1669                schema:
  1670                  allOf:
  1671                    - $ref: '#/components/schemas/APIResponse'
  1672                    - properties:
  1673                        data:
  1674                          allOf:
  1675                            - $ref: '#/components/schemas/MappedArraysOfVersionInfo'
  1676  
  1677            description: OK
  1678          '400':
  1679            content:
  1680              application/json:
  1681                schema:
  1682                  allOf:
  1683                    - $ref: '#/components/schemas/APIResponse'
  1684                    - properties:
  1685                        meta:
  1686                          allOf:
  1687                            - $ref: '#/components/schemas/APIMetaError'
  1688            description: Bad request
  1689          '500':
  1690            content:
  1691              application/json:
  1692                schema:
  1693                  type: string
  1694                  nullable: true
  1695            description: Server error
  1696          default:
  1697            content:
  1698              application/json:
  1699                schema:
  1700                  allOf:
  1701                    - $ref: '#/components/schemas/APIResponse'
  1702                    - properties:
  1703                        meta:
  1704                          allOf:
  1705                            - $ref: '#/components/schemas/APIMetaError'
  1706            description: Error
  1707    '/remote/preview':
  1708      post:
  1709        description: Preview requests a dataset preview from a remote 
  1710        operationId: 'remote.Preview'
  1711        tags:
  1712        - remote
  1713        requestBody:
  1714          required: true
  1715          content:
  1716            application/json:
  1717              schema:
  1718                '$ref': '#/components/schemas/PreviewParams'
  1719        
  1720        
  1721        responses:
  1722          '200':
  1723            content:
  1724              application/json:
  1725                schema:
  1726                  allOf:
  1727                    - $ref: '#/components/schemas/APIResponse'
  1728                    - properties:
  1729                        data:
  1730                          allOf:
  1731                            - $ref: '#/components/schemas/Dataset'
  1732  
  1733            description: OK
  1734          '400':
  1735            content:
  1736              application/json:
  1737                schema:
  1738                  allOf:
  1739                    - $ref: '#/components/schemas/APIResponse'
  1740                    - properties:
  1741                        meta:
  1742                          allOf:
  1743                            - $ref: '#/components/schemas/APIMetaError'
  1744            description: Bad request
  1745          '500':
  1746            content:
  1747              application/json:
  1748                schema:
  1749                  type: string
  1750                  nullable: true
  1751            description: Server error
  1752          default:
  1753            content:
  1754              application/json:
  1755                schema:
  1756                  allOf:
  1757                    - $ref: '#/components/schemas/APIResponse'
  1758                    - properties:
  1759                        meta:
  1760                          allOf:
  1761                            - $ref: '#/components/schemas/APIMetaError'
  1762            description: Error
  1763    '/remote/remove':
  1764      post:
  1765        description: Remove asks a remote to remove a dataset 
  1766        operationId: 'remote.Remove'
  1767        tags:
  1768        - remote
  1769        requestBody:
  1770          required: true
  1771          content:
  1772            application/json:
  1773              schema:
  1774                '$ref': '#/components/schemas/PushParams'
  1775        
  1776        
  1777        responses:
  1778          '200':
  1779            content:
  1780              application/json:
  1781                schema:
  1782                  allOf:
  1783                    - $ref: '#/components/schemas/APIResponse'
  1784                    - properties:
  1785                        data:
  1786                          allOf:
  1787                            - $ref: '#/components/schemas/Ref'
  1788  
  1789            description: OK
  1790          '400':
  1791            content:
  1792              application/json:
  1793                schema:
  1794                  allOf:
  1795                    - $ref: '#/components/schemas/APIResponse'
  1796                    - properties:
  1797                        meta:
  1798                          allOf:
  1799                            - $ref: '#/components/schemas/APIMetaError'
  1800            description: Bad request
  1801          '500':
  1802            content:
  1803              application/json:
  1804                schema:
  1805                  type: string
  1806                  nullable: true
  1807            description: Server error
  1808          default:
  1809            content:
  1810              application/json:
  1811                schema:
  1812                  allOf:
  1813                    - $ref: '#/components/schemas/APIResponse'
  1814                    - properties:
  1815                        meta:
  1816                          allOf:
  1817                            - $ref: '#/components/schemas/APIMetaError'
  1818            description: Error
  1819    '/registry/search':
  1820      post:
  1821        description: Search queries for items on qri related to given parameters 
  1822        operationId: 'search.Search'
  1823        tags:
  1824        - search
  1825        requestBody:
  1826          required: true
  1827          content:
  1828            application/json:
  1829              schema:
  1830                '$ref': '#/components/schemas/SearchParams'
  1831        
  1832        
  1833        responses:
  1834          '200':
  1835            content:
  1836              application/json:
  1837                schema:
  1838                  allOf:
  1839                    - $ref: '#/components/schemas/APIResponse'
  1840                    - properties:
  1841                        data:
  1842  
  1843                          type: array
  1844                          items:
  1845                            allOf:
  1846                              - $ref: '#/components/schemas/NotDefined'
  1847  
  1848            description: OK
  1849          '400':
  1850            content:
  1851              application/json:
  1852                schema:
  1853                  allOf:
  1854                    - $ref: '#/components/schemas/APIResponse'
  1855                    - properties:
  1856                        meta:
  1857                          allOf:
  1858                            - $ref: '#/components/schemas/APIMetaError'
  1859            description: Bad request
  1860          '500':
  1861            content:
  1862              application/json:
  1863                schema:
  1864                  type: string
  1865                  nullable: true
  1866            description: Server error
  1867          default:
  1868            content:
  1869              application/json:
  1870                schema:
  1871                  allOf:
  1872                    - $ref: '#/components/schemas/APIResponse'
  1873                    - properties:
  1874                        meta:
  1875                          allOf:
  1876                            - $ref: '#/components/schemas/APIMetaError'
  1877            description: Error
  1878    '/auto/apply':
  1879      post:
  1880        description: Apply runs a transform script 
  1881        operationId: 'automation.Apply'
  1882        tags:
  1883        - automation
  1884        requestBody:
  1885          required: true
  1886          content:
  1887            application/json:
  1888              schema:
  1889                '$ref': '#/components/schemas/ApplyParams'
  1890        
  1891        
  1892        responses:
  1893          '200':
  1894            content:
  1895              application/json:
  1896                schema:
  1897                  allOf:
  1898                    - $ref: '#/components/schemas/APIResponse'
  1899                    - properties:
  1900                        data:
  1901                          allOf:
  1902                            - $ref: '#/components/schemas/ApplyResult'
  1903  
  1904            description: OK
  1905          '400':
  1906            content:
  1907              application/json:
  1908                schema:
  1909                  allOf:
  1910                    - $ref: '#/components/schemas/APIResponse'
  1911                    - properties:
  1912                        meta:
  1913                          allOf:
  1914                            - $ref: '#/components/schemas/APIMetaError'
  1915            description: Bad request
  1916          '500':
  1917            content:
  1918              application/json:
  1919                schema:
  1920                  type: string
  1921                  nullable: true
  1922            description: Server error
  1923          default:
  1924            content:
  1925              application/json:
  1926                schema:
  1927                  allOf:
  1928                    - $ref: '#/components/schemas/APIResponse'
  1929                    - properties:
  1930                        meta:
  1931                          allOf:
  1932                            - $ref: '#/components/schemas/APIMetaError'
  1933            description: Error
  1934    '/auto/deploy':
  1935      post:
  1936        description: Deploy adds or updates a workflow 
  1937        operationId: 'automation.Deploy'
  1938        tags:
  1939        - automation
  1940        requestBody:
  1941          required: true
  1942          content:
  1943            application/json:
  1944              schema:
  1945                '$ref': '#/components/schemas/DeployParams'
  1946        
  1947        
  1948        responses:
  1949          '200':
  1950            content:
  1951              application/json:
  1952                schema:
  1953                  allOf:
  1954                    - $ref: '#/components/schemas/APIResponse'
  1955                    - properties:
  1956                        data:
  1957                          allOf:
  1958                            - $ref: '#/components/schemas/Nil'
  1959  
  1960            description: OK
  1961          '400':
  1962            content:
  1963              application/json:
  1964                schema:
  1965                  allOf:
  1966                    - $ref: '#/components/schemas/APIResponse'
  1967                    - properties:
  1968                        meta:
  1969                          allOf:
  1970                            - $ref: '#/components/schemas/APIMetaError'
  1971            description: Bad request
  1972          '500':
  1973            content:
  1974              application/json:
  1975                schema:
  1976                  type: string
  1977                  nullable: true
  1978            description: Server error
  1979          default:
  1980            content:
  1981              application/json:
  1982                schema:
  1983                  allOf:
  1984                    - $ref: '#/components/schemas/APIResponse'
  1985                    - properties:
  1986                        meta:
  1987                          allOf:
  1988                            - $ref: '#/components/schemas/APIMetaError'
  1989            description: Error
  1990    '/auto/remove':
  1991      post:
  1992        description: Remove removes a workflow 
  1993        operationId: 'automation.Remove'
  1994        tags:
  1995        - automation
  1996        requestBody:
  1997          required: true
  1998          content:
  1999            application/json:
  2000              schema:
  2001                '$ref': '#/components/schemas/WorkflowParams'
  2002        
  2003        
  2004        responses:
  2005          '200':
  2006            content:
  2007              application/json:
  2008                schema:
  2009                  allOf:
  2010                    - $ref: '#/components/schemas/APIResponse'
  2011                    - properties:
  2012                        data:
  2013                          allOf:
  2014                            - $ref: '#/components/schemas/Nil'
  2015  
  2016            description: OK
  2017          '400':
  2018            content:
  2019              application/json:
  2020                schema:
  2021                  allOf:
  2022                    - $ref: '#/components/schemas/APIResponse'
  2023                    - properties:
  2024                        meta:
  2025                          allOf:
  2026                            - $ref: '#/components/schemas/APIMetaError'
  2027            description: Bad request
  2028          '500':
  2029            content:
  2030              application/json:
  2031                schema:
  2032                  type: string
  2033                  nullable: true
  2034            description: Server error
  2035          default:
  2036            content:
  2037              application/json:
  2038                schema:
  2039                  allOf:
  2040                    - $ref: '#/components/schemas/APIResponse'
  2041                    - properties:
  2042                        meta:
  2043                          allOf:
  2044                            - $ref: '#/components/schemas/APIMetaError'
  2045            description: Error
  2046    '/auto/run':
  2047      post:
  2048        description: Run manually runs a workflow 
  2049        operationId: 'automation.Run'
  2050        tags:
  2051        - automation
  2052        requestBody:
  2053          required: true
  2054          content:
  2055            application/json:
  2056              schema:
  2057                '$ref': '#/components/schemas/RunParams'
  2058        
  2059        
  2060        responses:
  2061          '200':
  2062            content:
  2063              application/json:
  2064                schema:
  2065                  allOf:
  2066                    - $ref: '#/components/schemas/APIResponse'
  2067                    - properties:
  2068                        data:
  2069                          allOf:
  2070                            - $ref: '#/components/schemas/RawResponse'
  2071  
  2072            description: OK
  2073          '400':
  2074            content:
  2075              application/json:
  2076                schema:
  2077                  allOf:
  2078                    - $ref: '#/components/schemas/APIResponse'
  2079                    - properties:
  2080                        meta:
  2081                          allOf:
  2082                            - $ref: '#/components/schemas/APIMetaError'
  2083            description: Bad request
  2084          '500':
  2085            content:
  2086              application/json:
  2087                schema:
  2088                  type: string
  2089                  nullable: true
  2090            description: Server error
  2091          default:
  2092            content:
  2093              application/json:
  2094                schema:
  2095                  allOf:
  2096                    - $ref: '#/components/schemas/APIResponse'
  2097                    - properties:
  2098                        meta:
  2099                          allOf:
  2100                            - $ref: '#/components/schemas/APIMetaError'
  2101            description: Error
  2102    '/auto/workflow':
  2103      post:
  2104        description: Workflow fetches a workflow 
  2105        operationId: 'automation.Workflow'
  2106        tags:
  2107        - automation
  2108        requestBody:
  2109          required: true
  2110          content:
  2111            application/json:
  2112              schema:
  2113                '$ref': '#/components/schemas/WorkflowParams'
  2114        
  2115        
  2116        responses:
  2117          '200':
  2118            content:
  2119              application/json:
  2120                schema:
  2121                  allOf:
  2122                    - $ref: '#/components/schemas/APIResponse'
  2123                    - properties:
  2124                        data:
  2125                          allOf:
  2126                            - $ref: '#/components/schemas/NotDefined'
  2127  
  2128            description: OK
  2129          '400':
  2130            content:
  2131              application/json:
  2132                schema:
  2133                  allOf:
  2134                    - $ref: '#/components/schemas/APIResponse'
  2135                    - properties:
  2136                        meta:
  2137                          allOf:
  2138                            - $ref: '#/components/schemas/APIMetaError'
  2139            description: Bad request
  2140          '500':
  2141            content:
  2142              application/json:
  2143                schema:
  2144                  type: string
  2145                  nullable: true
  2146            description: Server error
  2147          default:
  2148            content:
  2149              application/json:
  2150                schema:
  2151                  allOf:
  2152                    - $ref: '#/components/schemas/APIResponse'
  2153                    - properties:
  2154                        meta:
  2155                          allOf:
  2156                            - $ref: '#/components/schemas/APIMetaError'
  2157            description: Error
  2158    '/ds/unpack':
  2159      post:
  2160        operationId: 'api.unpack'
  2161        tags:
  2162        - api
  2163        requestBody:
  2164          required: true
  2165          content:
  2166            application/zip:
  2167              schema:
  2168                type: string
  2169                format: binary
  2170        
  2171        
  2172        responses:
  2173          '200':
  2174            content:
  2175              application/json:
  2176                schema:
  2177                  allOf:
  2178                    - $ref: '#/components/schemas/APIResponse'
  2179                    - properties:
  2180                        data:
  2181                          allOf:
  2182                            - $ref: '#/components/schemas/NotDefined'
  2183  
  2184            description: OK
  2185          '400':
  2186            content:
  2187              application/json:
  2188                schema:
  2189                  allOf:
  2190                    - $ref: '#/components/schemas/APIResponse'
  2191                    - properties:
  2192                        meta:
  2193                          allOf:
  2194                            - $ref: '#/components/schemas/APIMetaError'
  2195            description: Bad request
  2196          '500':
  2197            content:
  2198              application/json:
  2199                schema:
  2200                  type: string
  2201                  nullable: true
  2202            description: Server error
  2203          default:
  2204            content:
  2205              application/json:
  2206                schema:
  2207                  allOf:
  2208                    - $ref: '#/components/schemas/APIResponse'
  2209                    - properties:
  2210                        meta:
  2211                          allOf:
  2212                            - $ref: '#/components/schemas/APIMetaError'
  2213            description: Error
  2214    '/':
  2215      get:
  2216        operationId: 'api.home'
  2217        tags:
  2218        - api
  2219        
  2220        responses:
  2221          '200':
  2222            content:
  2223              application/json:
  2224                schema:
  2225                  allOf:
  2226                    - $ref: '#/components/schemas/APIResponse'
  2227                    - properties:
  2228                        data:
  2229                          allOf:
  2230                            - $ref: '#/components/schemas/StatusOK'
  2231  
  2232            description: OK
  2233          '400':
  2234            content:
  2235              application/json:
  2236                schema:
  2237                  allOf:
  2238                    - $ref: '#/components/schemas/APIResponse'
  2239                    - properties:
  2240                        meta:
  2241                          allOf:
  2242                            - $ref: '#/components/schemas/APIMetaError'
  2243            description: Bad request
  2244          '500':
  2245            content:
  2246              application/json:
  2247                schema:
  2248                  type: string
  2249                  nullable: true
  2250            description: Server error
  2251          default:
  2252            content:
  2253              application/json:
  2254                schema:
  2255                  allOf:
  2256                    - $ref: '#/components/schemas/APIResponse'
  2257                    - properties:
  2258                        meta:
  2259                          allOf:
  2260                            - $ref: '#/components/schemas/APIMetaError'
  2261            description: Error
  2262    '/health':
  2263      get:
  2264        operationId: 'api.health'
  2265        tags:
  2266        - api
  2267        
  2268        responses:
  2269          '200':
  2270            content:
  2271              application/json:
  2272                schema:
  2273                  allOf:
  2274                    - $ref: '#/components/schemas/APIResponse'
  2275                    - properties:
  2276                        data:
  2277                          allOf:
  2278                            - $ref: '#/components/schemas/StatusOK'
  2279  
  2280            description: OK
  2281          '400':
  2282            content:
  2283              application/json:
  2284                schema:
  2285                  allOf:
  2286                    - $ref: '#/components/schemas/APIResponse'
  2287                    - properties:
  2288                        meta:
  2289                          allOf:
  2290                            - $ref: '#/components/schemas/APIMetaError'
  2291            description: Bad request
  2292          '500':
  2293            content:
  2294              application/json:
  2295                schema:
  2296                  type: string
  2297                  nullable: true
  2298            description: Server error
  2299          default:
  2300            content:
  2301              application/json:
  2302                schema:
  2303                  allOf:
  2304                    - $ref: '#/components/schemas/APIResponse'
  2305                    - properties:
  2306                        meta:
  2307                          allOf:
  2308                            - $ref: '#/components/schemas/APIMetaError'
  2309            description: Error
  2310    '/webui':
  2311      get:
  2312        operationId: 'api.webui'
  2313        tags:
  2314        - api
  2315        
  2316        responses:
  2317          '200':
  2318            content:
  2319              application/json:
  2320                schema:
  2321                  allOf:
  2322                    - $ref: '#/components/schemas/APIResponse'
  2323                    - properties:
  2324                        data:
  2325                          allOf:
  2326                            - $ref: '#/components/schemas/RawResponse'
  2327  
  2328            description: OK
  2329          '400':
  2330            content:
  2331              application/json:
  2332                schema:
  2333                  allOf:
  2334                    - $ref: '#/components/schemas/APIResponse'
  2335                    - properties:
  2336                        meta:
  2337                          allOf:
  2338                            - $ref: '#/components/schemas/APIMetaError'
  2339            description: Bad request
  2340          '500':
  2341            content:
  2342              application/json:
  2343                schema:
  2344                  type: string
  2345                  nullable: true
  2346            description: Server error
  2347          default:
  2348            content:
  2349              application/json:
  2350                schema:
  2351                  allOf:
  2352                    - $ref: '#/components/schemas/APIResponse'
  2353                    - properties:
  2354                        meta:
  2355                          allOf:
  2356                            - $ref: '#/components/schemas/APIMetaError'
  2357            description: Error
  2358    '/qfs/ipfs/{path:.*}':
  2359      get:
  2360        operationId: 'api.ipfs'
  2361        tags:
  2362        - api
  2363        parameters: 
  2364        - name: 'path:.*'
  2365          in: path
  2366          required: true
  2367          schema:
  2368            type: string
  2369        
  2370        responses:
  2371          '200':
  2372            content:
  2373              application/json:
  2374                schema:
  2375                  allOf:
  2376                    - $ref: '#/components/schemas/APIResponse'
  2377                    - properties:
  2378                        data:
  2379                          allOf:
  2380                            - $ref: '#/components/schemas/RawResponse'
  2381  
  2382            description: OK
  2383          '400':
  2384            content:
  2385              application/json:
  2386                schema:
  2387                  allOf:
  2388                    - $ref: '#/components/schemas/APIResponse'
  2389                    - properties:
  2390                        meta:
  2391                          allOf:
  2392                            - $ref: '#/components/schemas/APIMetaError'
  2393            description: Bad request
  2394          '500':
  2395            content:
  2396              application/json:
  2397                schema:
  2398                  type: string
  2399                  nullable: true
  2400            description: Server error
  2401          default:
  2402            content:
  2403              application/json:
  2404                schema:
  2405                  allOf:
  2406                    - $ref: '#/components/schemas/APIResponse'
  2407                    - properties:
  2408                        meta:
  2409                          allOf:
  2410                            - $ref: '#/components/schemas/APIMetaError'
  2411            description: Error
  2412    '/ds/get/{dsref}':
  2413      get:
  2414        operationId: 'api.get_ref'
  2415        tags:
  2416        - api
  2417        parameters: 
  2418        - name: 'dsref'
  2419          in: path
  2420          required: true
  2421          schema:
  2422            type: string
  2423        
  2424        responses:
  2425          '200':
  2426            content:
  2427              application/json:
  2428                schema:
  2429                  allOf:
  2430                    - $ref: '#/components/schemas/APIResponse'
  2431                    - properties:
  2432                        data:
  2433                          allOf:
  2434                            - $ref: '#/components/schemas/GetResult'
  2435  
  2436            description: OK
  2437          '400':
  2438            content:
  2439              application/json:
  2440                schema:
  2441                  allOf:
  2442                    - $ref: '#/components/schemas/APIResponse'
  2443                    - properties:
  2444                        meta:
  2445                          allOf:
  2446                            - $ref: '#/components/schemas/APIMetaError'
  2447            description: Bad request
  2448          '500':
  2449            content:
  2450              application/json:
  2451                schema:
  2452                  type: string
  2453                  nullable: true
  2454            description: Server error
  2455          default:
  2456            content:
  2457              application/json:
  2458                schema:
  2459                  allOf:
  2460                    - $ref: '#/components/schemas/APIResponse'
  2461                    - properties:
  2462                        meta:
  2463                          allOf:
  2464                            - $ref: '#/components/schemas/APIMetaError'
  2465            description: Error
  2466    '/ds/get/{dsref}/{selector}':
  2467      get:
  2468        operationId: 'api.get_ref_selector'
  2469        tags:
  2470        - api
  2471        parameters: 
  2472        - name: 'dsref'
  2473          in: path
  2474          required: true
  2475          schema:
  2476            type: string
  2477        - name: 'selector'
  2478          in: path
  2479          required: true
  2480          schema:
  2481            type: string
  2482        
  2483        responses:
  2484          '200':
  2485            content:
  2486              application/json:
  2487                schema:
  2488                  allOf:
  2489                    - $ref: '#/components/schemas/APIResponse'
  2490                    - properties:
  2491                        data:
  2492                          allOf:
  2493                            - $ref: '#/components/schemas/RawResponse'
  2494  
  2495            description: OK
  2496          '400':
  2497            content:
  2498              application/json:
  2499                schema:
  2500                  allOf:
  2501                    - $ref: '#/components/schemas/APIResponse'
  2502                    - properties:
  2503                        meta:
  2504                          allOf:
  2505                            - $ref: '#/components/schemas/APIMetaError'
  2506            description: Bad request
  2507          '500':
  2508            content:
  2509              application/json:
  2510                schema:
  2511                  type: string
  2512                  nullable: true
  2513            description: Server error
  2514          default:
  2515            content:
  2516              application/json:
  2517                schema:
  2518                  allOf:
  2519                    - $ref: '#/components/schemas/APIResponse'
  2520                    - properties:
  2521                        meta:
  2522                          allOf:
  2523                            - $ref: '#/components/schemas/APIMetaError'
  2524            description: Error
  2525  components:
  2526    schemas:
  2527      RemoveResponse:
  2528        type: object
  2529        properties: 
  2530          ref:
  2531            type: string
  2532  
  2533          numDeleted:
  2534            type: number
  2535  
  2536          message:
  2537            type: string
  2538  
  2539          unlinked:
  2540            type: boolean
  2541  
  2542      ActivityParams:
  2543        type: object
  2544        properties: 
  2545          ref:
  2546            type: string
  2547            description: "Reference to data to fetch history for"
  2548            example: "b5/world_bank_population"
  2549          pull:
  2550            type: boolean
  2551            description: "if true, pull any datasets that aren't stored locally"
  2552            example: "false"
  2553      ApplyParams:
  2554        type: object
  2555        properties: 
  2556          ref:
  2557            type: string
  2558  
  2559          transform:
  2560            type: object 
  2561  
  2562          secrets:
  2563            type: object 
  2564  
  2565          wait:
  2566            type: boolean
  2567  
  2568          ScriptOutput:
  2569            type: object 
  2570            description: "TODO(arqu): substitute with websockets when working over the wire "
  2571          Hooks:
  2572            type: object 
  2573  
  2574      DiffParams:
  2575        type: object
  2576        properties: 
  2577          leftPath:
  2578            type: string
  2579            description: "File paths or reference to datasets "
  2580          rightPath:
  2581            type: string
  2582  
  2583          WorkingDir:
  2584            type: string
  2585            description: "If not null, the working directory that the diff is using "
  2586          UseLeftPrevVersion:
  2587            type: boolean
  2588            description: "Whether to get the previous version of the left parameter "
  2589          Selector:
  2590            type: string
  2591            description: "Which component or part of a dataset to compare "
  2592      ProfileParams:
  2593        type: object
  2594      SetProfileParams:
  2595        type: object
  2596        properties: 
  2597          pro:
  2598            type: object 
  2599  
  2600      ListParams:
  2601        type: object
  2602        properties: 
  2603          term:
  2604            type: string
  2605            description: "term to filter list by"
  2606            example: "population"
  2607          username:
  2608            type: string
  2609            description: "username to filter collection by"
  2610            example: "ramfox"
  2611          orderBy:
  2612            type: string
  2613            description: "field name to order list by"
  2614            example: "created"
  2615          limit:
  2616            type: number
  2617            description: "maximum number of datasets to use. use -1 to list all datasets"
  2618            example: "50"
  2619          offset:
  2620            type: number
  2621            description: "number of items to skip"
  2622            example: "0"
  2623          public:
  2624            type: boolean
  2625            description: "Public only applies to listing datasets, shows only datasets that are set to visible "
  2626      Ref:
  2627        type: object
  2628        properties: 
  2629          initID:
  2630            type: string
  2631            description: "InitID is the canonical identifer for a dataset history "
  2632          username:
  2633            type: string
  2634            description: "Username of dataset owner "
  2635          profileID:
  2636            type: string
  2637            description: "ProfileID of dataset owner deprecated - avoid using this field, we're working towards removing it generally profile IDs should come from request scopes, or be fetched from stores of identity info (profile.Store) "
  2638          name:
  2639            type: string
  2640            description: "Unique name reference for this dataset "
  2641          path:
  2642            type: string
  2643            description: "Content-addressed path for this dataset "
  2644      PeerInfoParams:
  2645        type: object
  2646        properties: 
  2647          peername:
  2648            type: string
  2649  
  2650          profileID:
  2651            type: string
  2652  
  2653          verbose:
  2654            type: boolean
  2655            description: "Verbose adds network details from the p2p Peerstore "
  2656      PeerListParams:
  2657        type: object
  2658        properties: 
  2659          limit:
  2660            type: number
  2661  
  2662          offset:
  2663            type: number
  2664  
  2665          cached:
  2666            type: boolean
  2667            description: "Cached == true will return offline peers from the repo as well as online peers, default is to list connected peers only "
  2668      RawLogbookParams:
  2669        type: object
  2670      Viz:
  2671        type: object
  2672        properties: 
  2673          format:
  2674            type: string
  2675            description: "Format designates the visualization configuration syntax. currently the only supported syntax is 'html' "
  2676          path:
  2677            type: string
  2678            description: "Path is the location of a viz, transient derived "
  2679          qri:
  2680            type: string
  2681            description: "Qri should always be 'vc:0' derived "
  2682          scriptPath:
  2683            type: string
  2684            description: "ScriptPath is the path to the script that created this "
  2685          text:
  2686            type: string
  2687            description: "Text contains the contents of the script, transient "
  2688          renderedPath:
  2689            type: string
  2690            description: "RenderedPath is the path to the file rendered using the viz script and the body "
  2691      ManifestMissingParams:
  2692        type: object
  2693        properties: 
  2694          manifest:
  2695            type: object 
  2696  
  2697      GetConfigParams:
  2698        type: object
  2699        properties: 
  2700          Field:
  2701            type: string
  2702  
  2703          WithPrivateKey:
  2704            type: boolean
  2705  
  2706          Format:
  2707            type: string
  2708  
  2709          Concise:
  2710            type: boolean
  2711  
  2712      RenameParams:
  2713        type: object
  2714        properties: 
  2715          current:
  2716            type: string
  2717  
  2718          next:
  2719            type: string
  2720  
  2721      Structure:
  2722        type: object
  2723        properties: 
  2724          checksum:
  2725            type: string
  2726            description: "Checksum is a bas58-encoded multihash checksum of the entire data file this structure points to. This is different from IPFS hashes, which are calculated after breaking the file into blocks derived "
  2727          compression:
  2728            type: string
  2729            description: "Compression specifies any compression on the source data, if empty assume no compression "
  2730          depth:
  2731            type: number
  2732            description: "Maximum nesting level of composite types in the dataset. eg: depth 1 == [], depth 2 == [[]] derived "
  2733          encoding:
  2734            type: string
  2735            description: "Encoding specifics character encoding, assume utf-8 if not specified "
  2736          errCount:
  2737            type: number
  2738            description: "ErrCount is the number of errors returned by validating data against this schema. required derived "
  2739          entries:
  2740            type: number
  2741            description: "Entries is number of top-level entries in the dataset. With tablular data this is the same as the number of 'rows' derived "
  2742          format:
  2743            type: string
  2744            description: "Format specifies the format of the raw data MIME type "
  2745          formatConfig:
  2746            type: object 
  2747            description: "FormatConfig removes as much ambiguity as possible about how to interpret the speficied format. FormatConfig FormatConfig `json:'formatConfig,omitempty'` "
  2748          length:
  2749            type: number
  2750            description: "Length is the length of the data object in bytes. must always match & be present derived "
  2751          path:
  2752            type: string
  2753            description: "location of this structure, transient derived "
  2754          qri:
  2755            type: string
  2756            description: "Qri should always be KindStructure derived "
  2757          schema:
  2758            type: object 
  2759            description: "Schema contains the schema definition for the underlying data, schemas are defined using the IETF json-schema specification. for more info on json-schema see: https://json-schema.org "
  2760          strict:
  2761            type: boolean
  2762            description: "Strict requires schema validation to pass without error. Datasets with strict: true can have additional functionality and performance speedups that comes with being able to assume that all data is valid "
  2763      FileParams:
  2764        type: object
  2765        properties: 
  2766          filename:
  2767            type: string
  2768            description: "url to download data from. either Url or Data is required Url      string Filename of data file. extension is used for filetype detection "
  2769          data:
  2770            type: object 
  2771            description: "Data is the file as slice of bytes "
  2772      ValidateParams:
  2773        type: object
  2774        properties: 
  2775          ref:
  2776            type: string
  2777  
  2778          bodyFilename:
  2779            type: string
  2780  
  2781          schemaFilename:
  2782            type: string
  2783  
  2784          structureFilename:
  2785            type: string
  2786  
  2787      Commit:
  2788        type: object
  2789        properties: 
  2790          author:
  2791            type: object 
  2792            description: "Author of this commit "
  2793          message:
  2794            type: string
  2795            description: "Message is an optional "
  2796          path:
  2797            type: string
  2798            description: "Path is the location of this commit, transient derived "
  2799          qri:
  2800            type: string
  2801            description: "Qri is this commit's qri kind derived "
  2802          signature:
  2803            type: string
  2804            description: "Signature is a base58 encoded privateKey signing of Title "
  2805          timestamp:
  2806            type: object 
  2807            description: "Time this dataset was created. Required. "
  2808          title:
  2809            type: string
  2810            description: "Title of the commit. Required. "
  2811          runID:
  2812            type: string
  2813            description: "RunID is only present if an automated script was executed durning the commit time Commits with non-empty `RunID`s imply the existance of a transform component "
  2814      GetParams:
  2815        type: object
  2816        properties: 
  2817          ref:
  2818            type: string
  2819            description: "dataset reference to fetch"
  2820            example: "b5/world_bank_population"
  2821          selector:
  2822            type: string
  2823            description: "a component or nested field names to extract from the dataset"
  2824            example: "body"
  2825          limit:
  2826            type: number
  2827            description: "number of results to limit to. only applies when selector is 'body' "
  2828          offset:
  2829            type: number
  2830            description: "number of results to skip. only applies when selector is 'body' "
  2831      Transform:
  2832        type: object
  2833        properties: 
  2834          config:
  2835            type: object 
  2836            description: "Config outlines any configuration that would affect the resulting hash "
  2837          path:
  2838            type: string
  2839            description: "location of the transform object, transient "
  2840          qri:
  2841            type: string
  2842            description: "Kind should always equal KindTransform "
  2843          resources:
  2844            type: object 
  2845            description: "Resources is a map of all datasets referenced in this transform, with alphabetical keys generated by datasets in order of appearance within the transform "
  2846          scriptPath:
  2847            type: string
  2848            description: "ScriptPath is the path to the script that produced this transformation. Deprecated - use Steps instead "
  2849          text:
  2850            type: string
  2851            description: "Text contains the contents of the script, transient "
  2852          secrets:
  2853            type: object 
  2854            description: "Secrets is a map of secret values used in the transformation, transient. TODO (b5): make this not-transient by censoring the values used, but not keys "
  2855          steps:
  2856            type: object 
  2857  
  2858          syntax:
  2859            type: string
  2860            description: "Syntax this transform was written in Deprecated - syntax is defined per-step "
  2861          syntaxVersion:
  2862            type: string
  2863            description: "SyntaxVersion is an identifier for the application and version number that produced the result Deprecated - use steps.Syntax with a version suffix instead "
  2864          syntaxes:
  2865            type: object 
  2866            description: "map of syntaxes used in this transform to their version identifier. "
  2867      CreateAuthTokenParams:
  2868        type: object
  2869        properties: 
  2870          granteeUsername:
  2871            type: string
  2872            description: "username to grant auth"
  2873            example: "keyboard_cat"
  2874          granteeProfileID:
  2875            type: string
  2876            description: "profile Identifier to grant token for"
  2877            example: "QmemJQrK7PTQvD3n8gmo9JhyaByyLmETiNR1Y8wS7hv4sP"
  2878          ttl:
  2879            type: object 
  2880            description: "lifespan of token in nanoseconds"
  2881            example: "2000000000000"
  2882      RenderParams:
  2883        type: object
  2884        properties: 
  2885          ref:
  2886            type: string
  2887            description: "Ref is a string reference to the dataset to render "
  2888          dataset:
  2889            type: object 
  2890            description: "Optionally pass an entire dataset in for rendering, if providing a dataset, the Ref field must be empty "
  2891          template:
  2892            type: object 
  2893            description: "Optional template override "
  2894          useFSI:
  2895            type: boolean
  2896            description: "TODO (b5): investigate if this field is still in use "
  2897          format:
  2898            type: string
  2899            description: "Output format. defaults to 'html' "
  2900          selector:
  2901            type: string
  2902            description: "Selector "
  2903      User:
  2904        type: object
  2905        properties: 
  2906          id:
  2907            type: string
  2908  
  2909          name:
  2910            type: string
  2911  
  2912          email:
  2913            type: string
  2914  
  2915      VersionInfo:
  2916        type: object
  2917        properties: 
  2918          initID:
  2919            type: string
  2920            description: "Key as a stable identifier  InitID is derived from the logbook for the dataset "
  2921          username:
  2922            type: string
  2923            description: "Fields from dsref.Ref  Username of dataset owner "
  2924          profileID:
  2925            type: string
  2926            description: "ProfileID of dataset owner "
  2927          name:
  2928            type: string
  2929            description: "Unique name reference for this dataset "
  2930          path:
  2931            type: string
  2932            description: "Content-addressed path for this dataset "
  2933          published:
  2934            type: boolean
  2935            description: "State about the dataset that can change  If true, this dataset has published versions "
  2936          foreign:
  2937            type: boolean
  2938            description: "If true, this reference doesn't exist locally. Only makes sense if path is set, as this flag refers to specific versions, not to entire dataset histories. "
  2939          metaTitle:
  2940            type: string
  2941            description: "Meta fields  Title from the meta structure "
  2942          themeList:
  2943            type: string
  2944            description: "List of themes from the meta structure, comma-separated list "
  2945          bodySize:
  2946            type: number
  2947            description: "Structure fields  Size of the body in bytes "
  2948          bodyRows:
  2949            type: number
  2950            description: "Num of rows in the body "
  2951          bodyFormat:
  2952            type: string
  2953            description: "Format of the body, such as 'csv' or 'json' "
  2954          numErrors:
  2955            type: number
  2956            description: "Number of errors from the structure "
  2957          commitTime:
  2958            type: object 
  2959            description: "Commit fields  Timestamp field from the commit "
  2960          commitTitle:
  2961            type: string
  2962            description: "Title field from the commit "
  2963          commitMessage:
  2964            type: string
  2965            description: "Message field from the commit "
  2966          workflowID:
  2967            type: string
  2968            description: "Workflow fields "
  2969          workflowtriggerDescription:
  2970            type: string
  2971  
  2972          runID:
  2973            type: string
  2974            description: "Run Fields  RunID is derived from from either the Commit.RunID, field or the runID of a failed run. In the latter case the Path value will be empty "
  2975          runStatus:
  2976            type: string
  2977            description: "RunStatus is a string version of the run.Status enumeration. This value will always be one of:    ''|'waiting'|'running'|'succeeded'|'failed'|'unchanged'|'skipped' RunStatus is not stored on a dataset version, and instead must come from either run state or a cache of run state it's of type string to follow the 'plain old data' pattern "
  2978          runDuration:
  2979            type: object 
  2980            description: "RunDuration is how long the run took/has currently taken in nanoseconds default value of 0 means no duration data is available. RunDuration is not stored on a dataset version, and instead must come from either run state or a cache of run state "
  2981          runCount:
  2982            type: number
  2983            description: "Aggregate Fields TODO (ramfox): These fields are only temporarily living on `VersionInfo`. They are needed by the frontend to display 'details' about the head of of the dataset. When we get more user feedback and settle what info users want about their datasets, these fields may move to a new struct store, or subsystem. These fields are not derived from any `dataset.Dataset` fields. These fields should only be used in the `collection` package.  RunCount is the number of times this dataset's transform has been run "
  2984          commitCount:
  2985            type: number
  2986            description: "CommitCount is the number of commits in this dataset's history "
  2987          downloadCount:
  2988            type: number
  2989            description: "DownloadCount is the number of times this dataset has been directly downloaded from this Qri node "
  2990          followerCount:
  2991            type: number
  2992            description: "FollowerCount is the number of followers this dataset has on this Qri node "
  2993          openIssueCount:
  2994            type: number
  2995            description: "OpenIssueCount is the number of open issues this dataset has on this Qri node "
  2996      RemoveParams:
  2997        type: object
  2998        properties: 
  2999          ref:
  3000            type: string
  3001  
  3002          revision:
  3003            type: object 
  3004  
  3005          force:
  3006            type: boolean
  3007  
  3008      SearchParams:
  3009        type: object
  3010        properties: 
  3011          q:
  3012            type: string
  3013  
  3014          limit:
  3015            type: number
  3016  
  3017          offset:
  3018            type: number
  3019  
  3020      EmptyParams:
  3021        type: object
  3022      PushParams:
  3023        type: object
  3024        properties: 
  3025          ref:
  3026            type: string
  3027  
  3028          remote:
  3029            type: string
  3030  
  3031          all:
  3032            type: boolean
  3033            description: "All indicates all versions of a dataset and the dataset namespace should be either published or removed "
  3034      DiffResponse:
  3035        type: object
  3036        properties: 
  3037          stat:
  3038            type: object 
  3039  
  3040          schemaStat:
  3041            type: object 
  3042  
  3043          schema:
  3044            type: object 
  3045  
  3046          diff:
  3047            type: object 
  3048  
  3049      CSVOptions:
  3050        type: object
  3051        properties: 
  3052          headerRow:
  3053            type: boolean
  3054            description: "HeaderRow specifies weather this csv file has a header row or not "
  3055          lazyQuotes:
  3056            type: boolean
  3057            description: "If LazyQuotes is true, a quote may appear in an unquoted field and a non-doubled quote may appear in a quoted field. "
  3058          separator:
  3059            type: object 
  3060            description: "Separator is the field delimiter. It is set to comma (',') by NewReader. Comma must be a valid rune and must not be \r, \n, or the Unicode replacement character (0xFFFD). "
  3061          variadicFields:
  3062            type: boolean
  3063            description: "VariadicFields sets permits records to have a variable number of fields avoid using this "
  3064      ApplyResult:
  3065        type: object
  3066        properties: 
  3067          Data:
  3068            type: object 
  3069  
  3070          runID:
  3071            type: string
  3072  
  3073      ConnectionsParams:
  3074        type: object
  3075        properties: 
  3076          limit:
  3077            type: number
  3078  
  3079          offset:
  3080            type: number
  3081  
  3082      TeardownParams:
  3083        type: object
  3084        properties: 
  3085          Config:
  3086            type: object 
  3087  
  3088          RepoPath:
  3089            type: string
  3090  
  3091          ConfigFilepath:
  3092            type: string
  3093  
  3094      VersionInfoAggregator:
  3095        type: object
  3096      DeployParams:
  3097        type: object
  3098        properties: 
  3099          Run:
  3100            type: boolean
  3101  
  3102          Workflow:
  3103            type: object 
  3104  
  3105          Dataset:
  3106            type: object 
  3107  
  3108      RefListParams:
  3109        type: object
  3110        properties: 
  3111          Ref:
  3112            type: string
  3113            description: "String value of a reference "
  3114          Offset:
  3115            type: number
  3116            description: "Pagination Parameters "
  3117      CollectionGetParams:
  3118        type: object
  3119        properties: 
  3120          ref:
  3121            type: string
  3122  
  3123          initID:
  3124            type: string
  3125  
  3126      Stats:
  3127        type: object
  3128        properties: 
  3129          path:
  3130            type: string
  3131  
  3132          qri:
  3133            type: string
  3134  
  3135          stats:
  3136            type: object 
  3137  
  3138      Meta:
  3139        type: object
  3140        properties: 
  3141          accessURL:
  3142            type: string
  3143            description: "Url to access the dataset "
  3144          accrualPeriodicity:
  3145            type: string
  3146            description: "The frequency with which dataset changes. Must be an ISO 8601 repeating duration "
  3147          citations:
  3148            type: object 
  3149            description: "Citations is a slice of assets used to build this dataset "
  3150          contributors:
  3151            type: object 
  3152            description: "Contribute "
  3153          description:
  3154            type: string
  3155            description: "Description follows the DCAT sense of the word, it should be around a paragraph of human-readable text "
  3156          downloadURL:
  3157            type: string
  3158            description: "Url that should / must lead directly to the data itself "
  3159          homeURL:
  3160            type: string
  3161            description: "HomeURL is a path to a 'home' resource "
  3162          identifier:
  3163            type: string
  3164            description: "Identifier is for *other* data catalog specifications. Identifier should not be used or relied on to be unique, because this package does not enforce any of these rules. "
  3165          keywords:
  3166            type: object 
  3167            description: "String of Keywords "
  3168          language:
  3169            type: object 
  3170            description: "Languages this dataset is written in "
  3171          license:
  3172            type: object 
  3173            description: "License will automatically parse to & from a string value if provided as a raw string "
  3174          path:
  3175            type: string
  3176            description: "path is the location of meta, transient derived "
  3177          qri:
  3178            type: string
  3179            description: "Kind is required, must be qri:md:[version] derived "
  3180          readmeURL:
  3181            type: string
  3182            description: "path to dataset readme file, not part of the DCAT spec, but a common convention in software dev "
  3183          title:
  3184            type: string
  3185            description: "Title of this dataset "
  3186          theme:
  3187            type: object 
  3188            description: "'Category' for "
  3189          version:
  3190            type: string
  3191            description: "Version is the version identifier for this dataset "
  3192      Dataset:
  3193        type: object
  3194        properties: 
  3195          body:
  3196            type: object 
  3197            description: "Body represents dataset data with native go types. Datasets have at most one body. Body, BodyBytes, and BodyPath work together, often with only one field used at a time "
  3198          bodyBytes:
  3199            type: object 
  3200            description: "BodyBytes is for representing dataset data as a slice of bytes "
  3201          bodyPath:
  3202            type: string
  3203            description: "BodyPath is the path to the hash of raw data as it resolves on the network "
  3204          commit:
  3205            type: object 
  3206            description: "Commit contains author & change message information that describes this version of a dataset "
  3207          id:
  3208            type: string
  3209            description: "ID is an identifier string for this dataset. "
  3210          meta:
  3211            type: object 
  3212            description: "Meta contains all human-readable meta about this dataset intended to aid in discovery and organization of this document "
  3213          name:
  3214            type: string
  3215            description: "name reference for this dataset, transient "
  3216          path:
  3217            type: string
  3218            description: "Location of this dataset, transient "
  3219          peername:
  3220            type: string
  3221            description: "Peername of dataset owner, transient "
  3222          previousPath:
  3223            type: string
  3224            description: "PreviousPath connects datasets to form a historical merkle-DAG of snapshots of this document, creating a version history "
  3225          profileID:
  3226            type: string
  3227            description: "ProfileID of dataset owner, transient "
  3228          readme:
  3229            type: object 
  3230            description: "Readme is a path to the readme file for this dataset "
  3231          numVersions:
  3232            type: number
  3233            description: "Number of versions this dataset has, transient "
  3234          qri:
  3235            type: string
  3236            description: "Qri is a key for both identifying this document type, and versioning the dataset document definition itself. derived "
  3237          structure:
  3238            type: object 
  3239            description: "Structure of this dataset "
  3240          stats:
  3241            type: object 
  3242            description: "Stats is a component containing statistical metadata about the dataset body "
  3243          transform:
  3244            type: object 
  3245            description: "Transform is a path to the transformation that generated this resource "
  3246          viz:
  3247            type: object 
  3248            description: "Viz stores configuration data related to representing a dataset as a visualization "
  3249      JSONOptions:
  3250        type: object
  3251        properties: 
  3252          Options:
  3253            type: object 
  3254  
  3255      TransformResource:
  3256        type: object
  3257        properties: 
  3258          path:
  3259            type: string
  3260  
  3261      SetupParams:
  3262        type: object
  3263        properties: 
  3264          Config:
  3265            type: object 
  3266            description: "a configuration is required. defaults to config.DefaultConfig() "
  3267          RepoPath:
  3268            type: string
  3269            description: "where to initialize qri repository "
  3270          Register:
  3271            type: boolean
  3272            description: "submit new username to the configured registry "
  3273          Overwrite:
  3274            type: boolean
  3275            description: "overwrite any existing repo, erasing all data and deleting private keys this is almost always a bad idea "
  3276          SetupIPFS:
  3277            type: boolean
  3278            description: "attempt to setup an IFPS repo "
  3279          SetupIPFSConfigData:
  3280            type: object 
  3281  
  3282          Generator:
  3283            type: object 
  3284            description: "setup requires a crypto source "
  3285      ConnectParamsPod:
  3286        type: object
  3287        properties: 
  3288          peername:
  3289            type: string
  3290  
  3291          profileID:
  3292            type: string
  3293  
  3294          networkID:
  3295            type: string
  3296  
  3297          multiaddr:
  3298            type: string
  3299  
  3300      WorkflowParams:
  3301        type: object
  3302        properties: 
  3303          workflowID:
  3304            type: string
  3305  
  3306          initID:
  3307            type: string
  3308  
  3309          ref:
  3310            type: string
  3311  
  3312      ManifestParams:
  3313        type: object
  3314        properties: 
  3315          ref:
  3316            type: string
  3317  
  3318      RunParams:
  3319        type: object
  3320        properties: 
  3321          ref:
  3322            type: string
  3323  
  3324          initID:
  3325            type: string
  3326  
  3327          workflowID:
  3328            type: string
  3329  
  3330      Readme:
  3331        type: object
  3332        properties: 
  3333          format:
  3334            type: string
  3335            description: "Format designates the visualization configuration syntax. Only supported formats are 'html' and 'md' "
  3336          path:
  3337            type: string
  3338            description: "Path is the location of a readme, transient derived "
  3339          qri:
  3340            type: string
  3341            description: "Qri should always be 'rm:0' derived "
  3342          scriptPath:
  3343            type: string
  3344            description: "ScriptPath is the path to the script that created this "
  3345          text:
  3346            type: string
  3347            description: "Text contains the contents of the script, transient "
  3348          renderedPath:
  3349            type: string
  3350            description: "RenderedPath is the path to the file rendered using the readme script and the body "
  3351      MemResolver:
  3352        type: object
  3353        properties: 
  3354          Username:
  3355            type: string
  3356  
  3357          RefMap:
  3358            type: object 
  3359  
  3360          IDMap:
  3361            type: object 
  3362  
  3363      DAGInfoParams:
  3364        type: object
  3365        properties: 
  3366          ref:
  3367            type: string
  3368  
  3369          label:
  3370            type: string
  3371  
  3372      RegistryProfileParams:
  3373        type: object
  3374        properties: 
  3375          Profile:
  3376            type: object 
  3377  
  3378      Rev:
  3379        type: object
  3380        properties: 
  3381          Field:
  3382            type: string
  3383            description: "field scopt, currently can only be a component name, or the entire dataset "
  3384          Gen:
  3385            type: number
  3386            description: "the nth-generational ancestor of a history "
  3387      XLSXOptions:
  3388        type: object
  3389        properties: 
  3390          sheetName:
  3391            type: string
  3392  
  3393      PullParams:
  3394        type: object
  3395        properties: 
  3396          ref:
  3397            type: string
  3398  
  3399          logsOnly:
  3400            type: boolean
  3401            description: "only fetch logbook data "
  3402      ChangeReportParams:
  3403        type: object
  3404        properties: 
  3405          leftRef:
  3406            type: string
  3407  
  3408          rightRef:
  3409            type: string
  3410  
  3411      GetResult:
  3412        type: object
  3413        properties: 
  3414          value:
  3415            type: object 
  3416  
  3417          bytes:
  3418            type: object 
  3419  
  3420      ValidateResponse:
  3421        type: object
  3422        properties: 
  3423          structure:
  3424            type: object 
  3425            description: "Structure used to perform validation "
  3426          errors:
  3427            type: object 
  3428            description: "Validation Errors "
  3429      License:
  3430        type: object
  3431        properties: 
  3432          type:
  3433            type: string
  3434  
  3435          url:
  3436            type: string
  3437  
  3438      Theme:
  3439        type: object
  3440        properties: 
  3441          description:
  3442            type: string
  3443  
  3444          display_name:
  3445            type: string
  3446  
  3447          image_display_url:
  3448            type: string
  3449  
  3450          id:
  3451            type: string
  3452  
  3453          name:
  3454            type: string
  3455  
  3456          title:
  3457            type: string
  3458  
  3459      SaveParams:
  3460        type: object
  3461        properties: 
  3462          Dataset:
  3463            type: object 
  3464            description: "dataset supplies params directly, all other param fields override values supplied by dataset "
  3465          ref:
  3466            type: string
  3467            description: "dataset reference string, the name to save to"
  3468            example: "b5/world_bank_population"
  3469          title:
  3470            type: string
  3471            description: "commit title, defaults to a generated string based on diff"
  3472            example: "update dataset meta"
  3473          Message:
  3474            type: string
  3475            description: "commit message, defaults to blank"
  3476            example: "reaname title & fill in supported langages"
  3477          bodyPath:
  3478            type: string
  3479            description: "path to body data "
  3480          filePaths:
  3481            type: object 
  3482            description: "absolute path or URL to the list of dataset files or components to load "
  3483          secrets:
  3484            type: object 
  3485            description: "secrets for transform execution. Should be a set of key: value pairs "
  3486          ScriptOutput:
  3487            type: object 
  3488            description: "optional writer to have transform script record standard output to note: this won't work over RPC, only on local calls "
  3489          apply:
  3490            type: boolean
  3491            description: "Apply runs a transform script to create the next version to save "
  3492          replace:
  3493            type: boolean
  3494            description: "Replace writes the entire given dataset as a new snapshot instead of applying save params as augmentations to the existing history "
  3495          private:
  3496            type: boolean
  3497            description: "option to make dataset private. private data is not currently implimented, see https://github.com/qri-io/qri/issues/291 for updates "
  3498          convertFormatToPrev:
  3499            type: boolean
  3500            description: "if true, convert body to the format of the previous version, if applicable "
  3501          drop:
  3502            type: string
  3503            description: "comma separated list of component names to delete before saving "
  3504          force:
  3505            type: boolean
  3506            description: "force a new commit, even if no changes are detected "
  3507          shouldRender:
  3508            type: boolean
  3509            description: "save a rendered version of the template along with the dataset "
  3510          newName:
  3511            type: boolean
  3512            description: "new dataset only, don't create a commit on an existing dataset, name will be unused "
  3513      ParseError:
  3514        type: object
  3515        properties: 
  3516          Message:
  3517            type: string
  3518  
  3519      Citation:
  3520        type: object
  3521        properties: 
  3522          name:
  3523            type: string
  3524  
  3525          url:
  3526            type: string
  3527  
  3528          email:
  3529            type: string
  3530  
  3531      TransformStep:
  3532        type: object
  3533        properties: 
  3534          name:
  3535            type: string
  3536  
  3537          path:
  3538            type: string
  3539  
  3540          syntax:
  3541            type: string
  3542  
  3543          category:
  3544            type: string
  3545  
  3546          script:
  3547            type: object 
  3548  
  3549      PreviewParams:
  3550        type: object
  3551        properties: 
  3552          ref:
  3553            type: string
  3554  
  3555  ### Response Schemas
  3556  ## Base
  3557      APIResponse:
  3558        type: object
  3559        properties:
  3560          data:
  3561            type: object
  3562            nullable: true
  3563          meta:
  3564            type: object
  3565            nullable: true
  3566      StatusOK:
  3567        type: object
  3568      String:
  3569        type: string
  3570      Nil:
  3571        type: object
  3572        nullable: true
  3573      NotDefined:
  3574        type: object
  3575        nullable: true
  3576      Pagination:
  3577        type: object
  3578        properties:
  3579          page:
  3580            type: integer
  3581          pageSize:
  3582            type: integer
  3583          resultCount:
  3584            type: integer
  3585          nextUrl:
  3586            type: string
  3587          prevUrl:
  3588            type: string
  3589      RawResponse:
  3590        # supports all string formats: string, binary, byte
  3591        type: string
  3592  ## Qri
  3593      StatusItem:
  3594        type: object
  3595      Profile:
  3596        type: object
  3597      DAGManifest:
  3598        type: object
  3599      DAGInfo:
  3600        type: object
  3601      ChangeReport:
  3602        type: object
  3603      MappedArraysOfVersionInfo:
  3604        type: object
  3605        additionalProperties: true
  3606  ## Error
  3607      APIMetaError:
  3608        type: object
  3609        properties:
  3610          code:
  3611            type: integer
  3612          error:
  3613            type: string